COMMERCE SERVICES
/
Order Service
/
Invoices
/
List invoices

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
Languages
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

Get an invoice

Request

Returns an Invoice by internal id. Returns null if the Invoice does not exist.

Query
idinteger(int64)

The internal id of the invoice.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/GetInvoice \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
Idinteger or null(int64)

The internal id of the Invoice.

InvoiceNostring or null[ 0 .. 50 ] characters

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

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[ 0 .. 255 ] characters

InvoiceText is taken from InvoiceMark in Norce. MaxLength: 255

OrderIdinteger or null(int64)

The internal id of the Order related to the Invoice.

OrderNostring or null[ 0 .. 50 ] characters

The external order number of the Order related to the Invoice. The order number usually comes from an ERP. MaxLength: 50

OrderDatestring or null(date-time)

The order date of the Order related to the Invoice.

Sourcestring or null[ 0 .. 255 ] characters

The Source of the Invoice. 'WEB' is used for all invoices created through Norce. MaxLength: 255

DeliveryDatestring or null(date-time)

The delivery date of the DeliveryNote related to the Invoice.

DeliveryMethodstring or null[ 0 .. 50 ] characters

The delivery method of the Order. MaxLength: 50

PaymentMethodstring or null[ 0 .. 50 ] characters

The payment method of the Order. MaxLength: 50

BillToobject or null

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

OrderFreightnumber or null(decimal)

The total amount for freight on the Invoice.

InvoiceChargenumber or null(decimal)

The total amount for invoice charge on the Invoice.

InvoiceAmountExVatnumber or null(decimal)

The total amount invoiced ex VAT.

VatAmountnumber or null(decimal)

The total VAT amount invoiced.

ItemsArray of objects or null(InvoiceItem)

The invoiced items.

InfoArray of objects or null(Info)

A list of infos used to keep application specific data on the invoice. Not used for credit invoices.

InvoiceNoPspstring or null[ 0 .. 50 ] characters

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

CreditedInvoiceNostring or null[ 0 .. 50 ] characters

The credited invoice number. This is only used for credit invoices and this is the number of the original invoice being credited. MaxLength: 50

IsDebitboolean or null

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

GroupByKeystring or null[ 0 .. 50 ] characters

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

Commentstring or null[ 0 .. 250 ] characters

Free text comment on the Invoice. MaxLength: 250

InvoiceAmountIncVatnumber or null(decimal)

The total amount invoiced inc VAT.

Response
application/json
{
  "Id": 0,
  "InvoiceNo": "string",
  "InvoiceDate": "2019-08-24T14:15:22Z",
  "InvoiceDueDate": "2019-08-24T14:15:22Z",
  "InvoiceText": "string",
  "OrderId": 0,
  "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"
  },
  "OrderFreight": 0,
  "InvoiceCharge": 0,
  "InvoiceAmountExVat": 0,
  "VatAmount": 0,
  "Items": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "InvoiceNoPsp": "string",
  "CreditedInvoiceNo": "string",
  "IsDebit": true,
  "GroupByKey": "string",
  "Comment": "string",
  "InvoiceAmountIncVat": 0
}

Get invoice by invoice number

Request

Returns an Invoice by external invoice number. Returns null if the Invoice does not exist.

Query
invoiceNostring

The external invoice number of the invoice.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/GetInvoiceByNo \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
Idinteger or null(int64)

The internal id of the Invoice.

InvoiceNostring or null[ 0 .. 50 ] characters

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

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[ 0 .. 255 ] characters

InvoiceText is taken from InvoiceMark in Norce. MaxLength: 255

OrderIdinteger or null(int64)

The internal id of the Order related to the Invoice.

OrderNostring or null[ 0 .. 50 ] characters

The external order number of the Order related to the Invoice. The order number usually comes from an ERP. MaxLength: 50

OrderDatestring or null(date-time)

The order date of the Order related to the Invoice.

Sourcestring or null[ 0 .. 255 ] characters

The Source of the Invoice. 'WEB' is used for all invoices created through Norce. MaxLength: 255

DeliveryDatestring or null(date-time)

The delivery date of the DeliveryNote related to the Invoice.

DeliveryMethodstring or null[ 0 .. 50 ] characters

The delivery method of the Order. MaxLength: 50

PaymentMethodstring or null[ 0 .. 50 ] characters

The payment method of the Order. MaxLength: 50

BillToobject or null

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

OrderFreightnumber or null(decimal)

The total amount for freight on the Invoice.

InvoiceChargenumber or null(decimal)

The total amount for invoice charge on the Invoice.

InvoiceAmountExVatnumber or null(decimal)

The total amount invoiced ex VAT.

VatAmountnumber or null(decimal)

The total VAT amount invoiced.

ItemsArray of objects or null(InvoiceItem)

The invoiced items.

InfoArray of objects or null(Info)

A list of infos used to keep application specific data on the invoice. Not used for credit invoices.

InvoiceNoPspstring or null[ 0 .. 50 ] characters

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

CreditedInvoiceNostring or null[ 0 .. 50 ] characters

The credited invoice number. This is only used for credit invoices and this is the number of the original invoice being credited. MaxLength: 50

IsDebitboolean or null

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

GroupByKeystring or null[ 0 .. 50 ] characters

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

Commentstring or null[ 0 .. 250 ] characters

Free text comment on the Invoice. MaxLength: 250

InvoiceAmountIncVatnumber or null(decimal)

The total amount invoiced inc VAT.

Response
application/json
{
  "Id": 0,
  "InvoiceNo": "string",
  "InvoiceDate": "2019-08-24T14:15:22Z",
  "InvoiceDueDate": "2019-08-24T14:15:22Z",
  "InvoiceText": "string",
  "OrderId": 0,
  "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"
  },
  "OrderFreight": 0,
  "InvoiceCharge": 0,
  "InvoiceAmountExVat": 0,
  "VatAmount": 0,
  "Items": [
    { … }
  ],
  "Info": [
    { … }
  ],
  "InvoiceNoPsp": "string",
  "CreditedInvoiceNo": "string",
  "IsDebit": true,
  "GroupByKey": "string",
  "Comment": "string",
  "InvoiceAmountIncVat": 0
}

List invoices

Request

Returns a paged invoice list for a specified orderId, customer or company.

Query
orderIdstring

The internal order id for which invoices are fetched. Either this or a customerId, companyId must be specified.

companyIdstring

The internal company id for which invoices are fetched. Either this or a customerId, orderId must be specified.

customerIdstring

The internal customer id for which invoices are fetched. Either this or a companyId, orderId must be specified.

fromDatestring

(Optional) A from date used to filter the invoices. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

toDatestring

(Optional) A to date used to filter the invoices. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

pageNostring

(Optional) Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

(Optional) Number of items to display per page. Mandatory if using pageNo.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/ListInvoices \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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.

Response
application/json
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

List invoices by basket

Request

Returns a paged invoice list for specified basket internal id

Query
basketIdinteger(int32)

The basket internal id for which invoices are fetched.

cultureCodestring

(Optional) Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/order/1.1/ListInvoicesByBasket \
  -H 'ApplicationId: YOUR_API_KEY_HERE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
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.

Response
application/json
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

Orders

Contains endpoints for viewing orders and it`s metadata.

Operations

Schemas