STORM API

Order Service

InvoiceListItem

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

Servers

https://demo.storm.io/api/1.1/

Schemas

InvoiceItem

RowNumbernumber or null(decimal)

The row number of the item.

ItemNostring

The PartNo of the item. MaxLength: 50.

ItemDescriptionstring

The mame of the item. MaxLength: 255.

Quantitynumber(decimal)

The quantity invoiced. This is the quantity invoiced on this InvoiceItem.

UnitPricenumber(decimal)

The unit price of the item, excluding VAT.

UnitDiscountnumber(decimal)

The unit discount of the item, excluding VAT.

RowAmountnumber(decimal)

The total amount of the item, excluding VAT.

RowAmountVatnumber(decimal)

The total VAT of the item.

DeliveryDatestring or null(date-time)

The delivery date of the item.

VatRatenumber(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

UnitPriceIncVatnumber(decimal)

The unit price of the item, including VAT.

{
  "RowNumber": 0,
  "ItemNo": "string",
  "ItemDescription": "string",
  "Quantity": 0,
  "UnitPrice": 0,
  "UnitDiscount": 0,
  "RowAmount": 0,
  "RowAmountVat": 0,
  "DeliveryDate": "2019-08-24T14:15:22Z",
  "VatRate": 0,
  "UnitPriceIncVat": 0
}

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": [
    { … }
  ]
}

DeliveryNotes

Operations

InfoTypes

Operations

Invoices

Operations

Orders

Operations