COMMERCE SERVICES

Order Service

InvoiceListItem

Norce Commerce Order v1.1 service (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 is mostly a snapshot view of the orders as they looked when they got created in Norce, unless process integrations exists where DeliveryNotes and Invoices are passed to Norce.

Download OpenAPI description

openapi-v1.json

openapi-v1.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

DeliveryNotes

Contains endpoints for handling package and parcel information from a POS perspective.

Operations

InfoTypes

Contains endpoints for viewing metadata for extended fields on the order and orderitems.

Operations

Invoices

Contains endpoints for viewing invoice information on orders or baskets.

Operations

Orders

Contains endpoints for viewing orders and it`s metadata.

Operations

Schemas

InvoiceItem

Information about each item on an Invoice.

RowNumbernumber or null(decimal)

The row number of the item.

ItemNostring or null[ 0 .. 50 ] characters

The PartNo of the item. MaxLength: 50

ItemDescriptionstring or null[ 0 .. 255 ] characters

The mame of the item. MaxLength: 255

Quantitynumber or null(decimal)

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

UnitPricenumber or null(decimal)

The unit price of the item, excluding VAT.

UnitDiscountnumber or null(decimal)

The unit discount of the item, excluding VAT.

RowAmountnumber or null(decimal)

The total amount of the item, excluding VAT.

RowAmountVatnumber or null(decimal)

The total VAT of the item.

DeliveryDatestring or null(date-time)

The delivery date of the item.

VatRatenumber or null(decimal)

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

UnitPriceIncVatnumber or null(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

Information about an Invoice used in lists. This is a more light weight representation of the Invoice than the Invoice entity.

Idinteger or null(int64)

The internal id of the Invoice.

InvoiceNostring or null

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

InvoiceDatestring or null(date-time)

The invoice date of the Invoice.

InvoiceDueDatestring or null(date-time)

The invoice due date of the Invoice.

InvoiceTextstring or null

InvoiceText is taken from InvoiceMark in Norce.

OrderNostring or null

The ERP order number of the Order related to the Invoice.

OrderDatestring or null(date-time)

The order date of the Order related to the Invoice.

Sourcestring or null

The source of the Invoice. 'WEB' is used for all invoices created through Norce.

DeliveryDatestring or null(date-time)

The delivery date of the Order.

DeliveryMethodstring or null

The delivery method of the Order.

PaymentMethodstring or null

The payment method of the Order.

BillToobject or null

Information about the Customers in the Order namespace. It has information about Customer, any Company and addresses.

InvoiceAmountExVatnumber or null(decimal)

The total amount invoiced excluding VAT.

VatAmountnumber or null(decimal)

The total VAT amount invoiced.

InvoiceNoPspstring or null

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

IsDebitboolean or null

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

GroupByKeystring or null

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.

InvoiceAmountIncVatnumber or null(decimal)

The total amount invoiced including VAT.

{
  "Id": 0,
  "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

Invoices in a paged list format. The Items property contains all current invoices, depending on paging, and the ItemCount the total number of invoices.

ItemCountinteger or null(int32)

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

ItemsArray of objects or null(InvoiceListItem)

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

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