Skip to content
COMMERCE SERVICES
/
Order Service
/
/
InvoicePagedList

Documentation OrderService (1.1)

The Orders namespace has Entities and Operations used for orders and other related Entities such as DeliveryNotes and Invoices. This namespace has nothing to do with the Checkout process where orders are created, but is more related to order history shown on pages like MyPage and such. The Order history in Storm is mostly a snapshot view of the orders as they looked when they got created in Storm, unless process integrations exists where DeliveryNotes and Invoices are passed to Storm.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/order/1.1/

Schemas

Schemas

InvoiceListItem

Idstring

The internal id of the Invoice.

InvoiceNostring

The external invoice number of the Invoice. Usually from an ERP system. MaxLength: 50.

InvoiceDatestring(date-time)

The invoice date of the Invoice.

InvoiceDueDatestring or null(date-time)

The invoice due date of the Invoice.

InvoiceTextstring

InvoiceText is taken from InvoiceMark in Storm. MaxLength: 255.

OrderNostring

The ERP order number of the Order related to the Invoice. MaxLength: 50.

OrderDatestring(date-time)

The order date of the Order related to the Invoice.

Sourcestring

The source of the Invoice. 'WEB' is used for all invoices created though Storm. MaxLength: 255.

DeliveryDatestring or null(date-time)

The delivery date of the Order.

DeliveryMethodstring

The delivery method of the Order. MaxLength: 50.

PaymentMethodstring

The payment method of the Order. MaxLength: 50.

BillToobject(CustomerData)(CustomerData)
InvoiceAmountExVatnumber(decimal)

The total amount invoiced excluding VAT.

VatAmountnumber(decimal)

The total VAT amount invoiced.

InvoiceNoPspstring

The invoice number from the PSP. This is only used when the PSP issues invoices. MaxLength: 50.

IsDebitboolean

Indicates if this is a debit invoice (true) or a credit invoice (false).

GroupByKeystring

GroupByKey can be used to group invoices. All individual invoices on one summary invoice will have this set to the same value. Normal non-summary invoices will have this value set to null. MaxLength: 50.

InvoiceAmountIncVatnumber(decimal)

The total amount invoiced including VAT.

{
  "Id": "string",
  "InvoiceNo": "string",
  "InvoiceDate": "2019-08-24T14:15:22Z",
  "InvoiceDueDate": "2019-08-24T14:15:22Z",
  "InvoiceText": "string",
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Source": "string",
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "DeliveryMethod": "string",
  "PaymentMethod": "string",
  "BillTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "InvoiceAmountExVat": 0,
  "VatAmount": 0,
  "InvoiceNoPsp": "string",
  "IsDebit": true,
  "GroupByKey": "string",
  "InvoiceAmountIncVat": 0
}

InvoicePagedList

ItemCountinteger(int32)

The total number of invoices. Can be used to manage paging. Use PageSize to calculate number of pages.

ItemsArray of objects(InvoiceListItem)(InvoiceListItem)

Current list of invoices for the current page if paging is used. Otherwise all invoices will be in the list.

{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

Order

Idstring

The internal id of the Order in Storm.

QuotationIdinteger or null(int32)

The internal id of the quotation/basket used to create the Order.

OrderNostring

The external order number of the Order, usually from an ERP. MaxLength: 50.

OrderDatestring(date-time)

The order date of the Order.

Statusstring

The status text of the Order. See ListOrderStatuses for information about available statuses. MaxLength: 50.

Sourcestring

The source of the Order. 'WEB' is used for all orders created though Storm. MaxLength: 255.

Currencystring

The currency code of the Order. MaxLength: 3.

ItemsArray of objects(OrderItem)(OrderItem)

The items on the Order.

SellToobject(CustomerData)(CustomerData)
BillToobject(CustomerData)(CustomerData)
ShipToobject(CustomerData)(CustomerData)
OrderTotalIncVatnumber(decimal)

The total amount on the Order including VAT.

OrderTotalExVatnumber(decimal)

The total amount on the Order excluding VAT.

PaymentMethodstring

The payment method of the Order. MaxLength: 50.

DeliveryMethodstring

The delivery method of the Order. MaxLength: 50.

DeliveryNotesArray of objects(DeliveryNote)(DeliveryNote)

The delivery notes of the Order.

InfoArray of objects(Info)(Info)

A list of infos used to keep application specific data on the order.

TypeIdinteger(int32)

The type of the order. 1 for normal sales order and 3 for orders from subscriptions. 2 is reserved for purchase orders.

DeliveryMarkstring

The delivery mark of the Order. Gets it's value from the OrderReference field of the basket. MaxLength: 255.

DropPointobject(CustomerData)(CustomerData)
{
  "Id": "string",
  "QuotationId": 0,
  "OrderNo": "string",
  "OrderDate": "2019-08-24T14:15:22Z",
  "Status": "string",
  "Source": "string",
  "Currency": "string",
  "Items": [
    { … }
  ],
  "SellTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "BillTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "ShipTo": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  },
  "OrderTotalIncVat": 0,
  "OrderTotalExVat": 0,
  "PaymentMethod": "string",
  "DeliveryMethod": "string",
  "DeliveryNotes": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "TypeId": 0,
  "DeliveryMark": "string",
  "DropPoint": {
    "Company": { … },
    "Customer": { … },
    "Address": { … },
    "DropPointCode": "string"
  }
}

DeliveryNotes

Operations

InfoTypes

Operations

Invoices

Operations

Orders

Operations