COMMERCE QUERY
/
Query API 3.0
/
Order

Query (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://norcecommerce.api-se.norce.tech/commerce/query/3.0/

Schemas

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Gets all orders.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Orders/Orders \
  -H 'ApplicationId: 0'

Responses

A queryable collection of orders.

Bodyapplication/jsonArray [
buyerCustomer(ClientCustomer (object or null))
One of:
idinteger(int64)

The unique identifier of the order.

clientIdinteger(int32)

The client identifier.

applicationIdinteger(int32)

The application identifier.

quotationIdinteger or null(int32)

The quotation identifier.

orderNostring[ 0 .. 50 ] charactersrequired

The order number, commonly same as quotation id unless overriden from the ERP confirmation response.

orderDatestring(date-time)

The date the order was placed.

buyerCompanyCodestring or null[ 0 .. 50 ] characters

The buyer company code.

buyerCompanyIdinteger or null(int32)

The buyer company identifier.

buyerCustomerCodestring or null[ 0 .. 50 ] characters

The buyer customer code.

buyerCustomerIdinteger or null(int32)

The buyer customer identifier.

payerCompanyCodestring or null[ 0 .. 50 ] characters

The payer company code.

payerCompanyIdinteger or null(int32)

The payer company identifier.

payerCustomerCodestring or null[ 0 .. 50 ] characters

The payer customer code.

payerCustomerIdinteger or null(int32)

The payer customer identifier.

resellerCompanyCodestring or null[ 0 .. 50 ] characters

The reseller company code, not used anymore.

resellerCompanyIdinteger or null(int32)

The reseller company identifier, not used anymore.

resellerCustomerCodestring or null[ 0 .. 50 ] characters

The reseller customer code, not used anymore.

resellerCustomerIdinteger or null(int32)

The reseller customer identifier, not used anymore.

groupCodestring or null[ 0 .. 50 ] characters

The group code, not used anymore.

statusIdinteger(int32)

The status identifier, common values are Created (0), Allocation (1), Confirmed (2), Delivered (4), Invoiced (5), Cancelled (6), Partly delivered (8).

salesRepContactIdinteger or null(int32)

The sales representative contact identifier, not used anymore.

sourcestring or null[ 0 .. 255 ] characters

The source of the order, 'WEB' is reserved for orders coming through Norce shopping and checkout processes.

deliveryTermsstring or null[ 0 .. 10 ] characters

The delivery terms, not used anymore.

deliveryModestring or null[ 0 .. 50 ] characters

The delivery mode, code from the DeliveryMethod setting.

deliveryDatestring or null(date-time)

The delivery date.

isPartDeliveryboolean

Indicates whether the order is partly delivered, can be true if goods ordered is partly delivered by a DeliveryNote.

paymentTermsstring or null[ 0 .. 100 ] characters

The payment terms, code from the PaymentMethod setting.

currencyIdinteger(int32)

The currency identifier.

vatRatenumber(decimal)

The VAT rate, not used anymore.

cashDiscountnumber(decimal)

The cash discount amount, not used anymore.

lineDiscountnumber(decimal)

The line discount amount, not used anymore.

freightCostnumber(decimal)

The freight cost excluding VAT, the same as the lineamount on the freight order item.

orderFeenumber(decimal)

The order fee, not used anymore.

deliveryAttentionstring or null[ 0 .. 100 ] characters

The delivery attention line, often name of the delivery recipient.

deliveryCareOfstring or null[ 0 .. 100 ] characters

The delivery care of line.

deliveryAddressLine1string or null[ 0 .. 255 ] characters

The first line of the delivery address.

deliveryAddressLine2string or null[ 0 .. 255 ] characters

The second line of the delivery address.

deliveryZipCodestring or null[ 0 .. 50 ] characters

The delivery zip code.

deliveryCitystring or null[ 0 .. 50 ] characters

The delivery city.

deliveryRegionstring or null[ 0 .. 100 ] characters

The delivery region.

deliveryCountryIdinteger or null(int32)

The delivery country identifier.

ledgerAccountstring or null[ 0 .. 50 ] characters

The ledger account, not used anymore.

departmentstring or null[ 0 .. 10 ] characters

The department, not used anymore.

centrestring or null[ 0 .. 10 ] characters

The centre, not used anymore.

externalPurchaseNostring or null[ 0 .. 50 ] characters

The external purchase number, not used anymore, usually has the quotation id.

salesCodestring or null[ 0 .. 50 ] characters

The sales code, not used anymore.

deliveryMarkstring or null[ 0 .. 255 ] characters

The delivery mark, copied from the CustomerOrderReference in the Quotation.

invoiceMarkstring or null[ 0 .. 255 ] characters

The invoice mark, copied from the CustomerInvoiceReference in the Quotation.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

payerCustomerInfoIdinteger or null(int64)

The payer customer info identifier, lookup key for CustomerInfo, where customer data is stored for guest customers, not having a ClientCustomer record.

estimatedDeliveryTimestring or null(date-time)

The estimated delivery time, not used anymore.

deliveryTimestring or null(date-time)

The actual delivery time, not used anymore.

buyerCustomerInfoIdinteger or null(int64)

The buyer customer info identifier, lookup key for CustomerInfo, where customer data is stored for guest customers, not having a ClientCustomer record.

shipToCustomerInfoIdinteger or null(int64)

The ship-to customer info identifier, lookup key for CustomerInfo, where customer data is stored for guest customers, not having a ClientCustomer record.

externalRefstring or null[ 0 .. 50 ] characters

The external reference, not used anymore.

paymentMethodIdinteger or null(int32)

The payment method identifier.

deliveryMethodIdinteger or null(int32)

The delivery method identifier.

orderTypeIdinteger or null(int32)

The order type identifier, Customer Order (1), Purchase Order (2), Recurring Order (3), Recurring Order Template (4), External Order (5).

isForgottenboolean

Indicates whether the order is forgotten, not used anymore.

forgottenByinteger or null(int32)

The identifier of the user who marked the order as forgotten, not used anymore.

forgottenDatestring or null(date-time)

The date and time the order was marked as forgotten, not used anymore.

dropPointCustomerInfoIdinteger or null(int64)

The drop point customer info identifier, lookup key for CustomerInfo.

dropPointCodestring or null[ 0 .. 50 ] characters

The drop point code.

yearinteger or null(int32)

The year.

weekinteger or null(int32)

The week number.

tmsReferencestring or null[ 0 .. 255 ] characters

The TMS reference, a reference identifier from the Transport system, not commonly used.

buyer(CustomerInfo (object or null))
One of:
deliveryNoteArray of objects or null(DeliveryNote)
dropPoint(CustomerInfo (object or null))
One of:
invoiceArray of objects or null(Invoice)
infosArray of objects or null(OrderInfo)
itemsArray of objects or null(OrderItem)
payer(CustomerInfo (object or null))
One of:
quotation(Quotation (object or null))
One of:
shipTo(CustomerInfo (object or null))
One of:
]
Response
application/json
[
  {
    "buyerCustomer": { … },
    "id": 0,
    "clientId": 0,
    "applicationId": 0,
    "quotationId": 0,
    "orderNo": "string",
    "orderDate": "2019-08-24T14:15:22Z",
    "buyerCompanyCode": "string",
    "buyerCompanyId": 0,
    "buyerCustomerCode": "string",
    "buyerCustomerId": 0,
    "payerCompanyCode": "string",
    "payerCompanyId": 0,
    "payerCustomerCode": "string",
    "payerCustomerId": 0,
    "resellerCompanyCode": "string",
    "resellerCompanyId": 0,
    "resellerCustomerCode": "string",
    "resellerCustomerId": 0,
    "groupCode": "string",
    "statusId": 0,
    "salesRepContactId": 0,
    "source": "string",
    "deliveryTerms": "string",
    "deliveryMode": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "isPartDelivery": true,
    "paymentTerms": "string",
    "currencyId": 0,
    "vatRate": 0,
    "cashDiscount": 0,
    "lineDiscount": 0,
    "freightCost": 0,
    "orderFee": 0,
    "deliveryAttention": "string",
    "deliveryCareOf": "string",
    "deliveryAddressLine1": "string",
    "deliveryAddressLine2": "string",
    "deliveryZipCode": "string",
    "deliveryCity": "string",
    "deliveryRegion": "string",
    "deliveryCountryId": 0,
    "ledgerAccount": "string",
    "department": "string",
    "centre": "string",
    "externalPurchaseNo": "string",
    "salesCode": "string",
    "deliveryMark": "string",
    "invoiceMark": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "payerCustomerInfoId": 0,
    "estimatedDeliveryTime": "2019-08-24T14:15:22Z",
    "deliveryTime": "2019-08-24T14:15:22Z",
    "buyerCustomerInfoId": 0,
    "shipToCustomerInfoId": 0,
    "externalRef": "string",
    "paymentMethodId": 0,
    "deliveryMethodId": 0,
    "orderTypeId": 0,
    "isForgotten": true,
    "forgottenBy": 0,
    "forgottenDate": "2019-08-24T14:15:22Z",
    "dropPointCustomerInfoId": 0,
    "dropPointCode": "string",
    "year": 0,
    "week": 0,
    "tmsReference": "string",
    "buyer": { … },
    "deliveryNote": [ … ],
    "dropPoint": { … },
    "invoice": [ … ],
    "infos": [ … ],
    "items": [ … ],
    "payer": { … },
    "quotation": { … },
    "shipTo": { … }
  }
]

Gets all quotations.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Orders/Quotations \
  -H 'ApplicationId: 0'

Responses

A queryable collection of quotations.

Bodyapplication/jsonArray [
idinteger(int32)

The unique identifier of the quotation.

applicationIdinteger(int32)

The application identifier.

salesContactIdinteger or null(int32)

The sales contact identifier, not used anymore.

buyerAccountKeystring(guid)

The buyer account key.

buyerAccountIdinteger or null(int32)

The buyer account identifier.

payerAccountIdinteger or null(int32)

The payer account identifier.

payerAccountKeystring or null(guid)

The payer account key.

statusIdinteger(int32)

The status identifier. Basket (3), Deleted (4), Accepted (5), Ready for payment (7), Payment Accepted (8), Saved (9), Order (10), Recurring order (21), Opened for post purchase upsell (22).

isPrimaryboolean

Indicates whether the quotation is primary, not used anymore.

namestring or null[ 0 .. 50 ] characters

The name of the quotation, used for saved baskets.

validTostring or null(date-time)

The end date, not commonly used. Use info type instead.

isDeletableboolean

Indicates whether the quotation is deletable.

commentstring or null[ 0 .. 250 ] characters

A comment or note.

rejectionReasonIdinteger or null(int32)

The rejection reason identifier, not commonly used.

modifiedstring or null(date-time)

The date and time the record was last updated.

browsedstring or null(date-time)

The browsed date and time, not used anymore.

paymentMethodIdinteger or null(int32)

The payment method identifier.

deliveryMethodIdinteger or null(int32)

The delivery method identifier.

ipAddressstring or null[ 0 .. 50 ] characters

The ip address.

payerFirstNamestring or null[ 0 .. 100 ] characters

The payer first name.

payerMiddleNamestring or null[ 0 .. 100 ] characters

The payer middle name.

payerLastNamestring or null[ 0 .. 100 ] characters

The payer last name.

payerCellPhoneNumberstring or null[ 0 .. 50 ] characters

The payer cell phone number.

payerEmailstring or null[ 0 .. 255 ] characters

The payer email.

currencyIdinteger(int32)

The currency identifier.

resellerCustomerIdinteger or null(int32)

The reseller customer identifier, not commonly used.

isLockedboolean or null

Indicates whether the quotation is locked. When a quotation is in a locked state, it cannot be modified. This is typically used to prevent changes to a quotation that is under review or has been accepted.

discountCodestring or null

The discount code, from the applied promotions, several codes are separated by a comma.

isActiveboolean or null

Indicates whether the quotation is active.

parentQuotationIdinteger or null(int32)

The parent quotation identifier, not commonly used. Used for linking to an original quotation.

clientIdinteger or null(int32)

The client identifier.

buyerCompanyIdinteger or null(int32)

The buyer company identifier.

payerCompanyIdinteger or null(int32)

The payer company identifier.

hasPaymentTransactionboolean or null

Indicates whether the quotation has payment transaction.

buyerFirstNamestring or null[ 0 .. 100 ] characters

The buyer first name.

buyerMiddleNamestring or null[ 0 .. 100 ] characters

The buyer middle name.

buyerLastNamestring or null[ 0 .. 100 ] characters

The buyer last name.

buyerCellPhoneNumberstring or null[ 0 .. 50 ] characters

The buyer cell phone number.

buyerEmailstring or null[ 0 .. 255 ] characters

The buyer email.

customerOrderReferencestring or null[ 0 .. 50 ] characters

The customer order reference. Usually used as a note on the delivery slip, copied to DeliveryMark on the Order here in Query and is called OrderReference in the Basket model in commerce services.

createdstring or null(date-time)

The date and time the record was created.

createdByinteger or null(int32)

The identifier of the user who created the record.

referIdinteger or null(int32)

The refer identifier, not commonly used.

referUrlstring or null[ 0 .. 255 ] characters

The refer url, not commonly used.

payerSocialSecurityNumberstring or null[ 0 .. 50 ] characters

The payer social security number, not commonly used.

buyerCustomerIdinteger or null(int32)

The buyer customer identifier.

payerCustomerIdinteger or null(int32)

The payer customer identifier.

shipToCustomerIdinteger or null(int32)

The ship to customer identifier.

rowIdstring(byte)non-emptyrequired

The row identifier, concurrency token, for internal use.

deleteDatestring or null(date-time)

The delete date, marked for deletion at specified date.

pickupCodestring or null[ 0 .. 50 ] characters

The pickup code.

attestedByinteger or null(int32)

The attested by, not commonly used.

modifiedByinteger or null(int32)

The identifier of the user who last updated the record.

typeIdinteger or null(int32)

The type identifier, normal basket (1), Saved (2), Template (3).

doHoldboolean

Indicates whether do hold is enabled, signal for manual check in ERP, not commonly used.

deliveryMethodCodestring or null[ 0 .. 255 ] characters

The delivery method code.

freightPricenumber or null(decimal)

The freight price.

customerInvoiceReferencestring or null[ 0 .. 50 ] characters

The customer invoice reference. Usually used as a note on the invoice, copied to InvoiceMark on the Order here in Query and is called InvoiceReference in the Basket model in commerce services.

yearinteger or null(int32)

Created year.

weekinteger or null(int32)

Created week.

salesAreaIdinteger or null(int32)

The sales area identifier.

payerPhoneNumberstring or null[ 0 .. 50 ] characters

The payer phone number.

buyerPhoneNumberstring or null[ 0 .. 50 ] characters

The buyer phone number.

orderArray of objects or null(Order)
addressesArray of objects or null(QuotationCustomerAddress)
infosArray of objects or null(QuotationInfo)
itemsArray of objects or null(QuotationItem)
]
Response
application/json
[
  {
    "id": 0,
    "applicationId": 0,
    "salesContactId": 0,
    "buyerAccountKey": "string",
    "buyerAccountId": 0,
    "payerAccountId": 0,
    "payerAccountKey": "string",
    "statusId": 0,
    "isPrimary": true,
    "name": "string",
    "validTo": "2019-08-24T14:15:22Z",
    "isDeletable": true,
    "comment": "string",
    "rejectionReasonId": 0,
    "modified": "2019-08-24T14:15:22Z",
    "browsed": "2019-08-24T14:15:22Z",
    "paymentMethodId": 0,
    "deliveryMethodId": 0,
    "ipAddress": "string",
    "payerFirstName": "string",
    "payerMiddleName": "string",
    "payerLastName": "string",
    "payerCellPhoneNumber": "string",
    "payerEmail": "string",
    "currencyId": 0,
    "resellerCustomerId": 0,
    "isLocked": true,
    "discountCode": "string",
    "isActive": true,
    "parentQuotationId": 0,
    "clientId": 0,
    "buyerCompanyId": 0,
    "payerCompanyId": 0,
    "hasPaymentTransaction": true,
    "buyerFirstName": "string",
    "buyerMiddleName": "string",
    "buyerLastName": "string",
    "buyerCellPhoneNumber": "string",
    "buyerEmail": "string",
    "customerOrderReference": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "referId": 0,
    "referUrl": "string",
    "payerSocialSecurityNumber": "string",
    "buyerCustomerId": 0,
    "payerCustomerId": 0,
    "shipToCustomerId": 0,
    "rowId": "string",
    "deleteDate": "2019-08-24T14:15:22Z",
    "pickupCode": "string",
    "attestedBy": 0,
    "modifiedBy": 0,
    "typeId": 0,
    "doHold": true,
    "deliveryMethodCode": "string",
    "freightPrice": 0,
    "customerInvoiceReference": "string",
    "year": 0,
    "week": 0,
    "salesAreaId": 0,
    "payerPhoneNumber": "string",
    "buyerPhoneNumber": "string",
    "order": [ … ],
    "addresses": [ … ],
    "infos": [ … ],
    "items": [ … ]
  }
]

Gets all delivery notes.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Orders/DeliveryNotes \
  -H 'ApplicationId: 0'

Responses

A queryable collection of delivery notes.

Bodyapplication/jsonArray [
idinteger(int64)

The unique identifier of the delivery note.

clientIdinteger(int32)

The client identifier.

noteNostring[ 0 .. 50 ] charactersrequired

The note number from the ERP or WMS.

supplierIdinteger or null(int32)

The supplier identifier, not commonly used.

typeIdinteger(int32)

The type identifier, Order Delivery (1).

referenceOrderIdinteger(int64)

The reference order identifier, link to the Order.

buyerCompanyIdinteger or null(int32)

The buyer company identifier, not used anymore, check Order for customer information.

buyerCompanyCodestring or null[ 0 .. 50 ] characters

The buyer company code, not used anymore, check Order for customer information.

buyerCustomerIdinteger or null(int32)

The buyer customer identifier, not used anymore, check Order for customer information.

buyerCustomerCodestring or null[ 0 .. 50 ] characters

The buyer customer code, not used anymore, check Order for customer information.

payerCompanyIdinteger or null(int32)

The payer company identifier, not used anymore, check Order for customer information.

payerCompanyCodestring or null[ 0 .. 50 ] characters

The payer company code, not used anymore, check Order for customer information.

payerCustomerIdinteger or null(int32)

The payer customer identifier, not used anymore, check Order for customer information.

payerCustomerCodestring or null[ 0 .. 50 ] characters

The payer customer code, not used anymore, check Order for customer information.

resellerCompanyIdinteger or null(int32)

The reseller company identifier, not used anymore, check Order for customer information.

resellerCompanyCodestring or null[ 0 .. 50 ] characters

The reseller company code, not used anymore, check Order for customer information.

resellerCustomerIdinteger or null(int32)

The reseller customer identifier, not used anymore, check Order for customer information.

resellerCustomerCodestring or null[ 0 .. 50 ] characters

The reseller customer code, not used anymore, check Order for customer information.

groupCodestring or null[ 0 .. 50 ] characters

The group code, not used anymore.

deliveryNamestring or null[ 0 .. 100 ] characters

The delivery name, commonly the customer name.

deliveryAttentionstring or null[ 0 .. 100 ] characters

The delivery attention.

deliveryCareOfstring or null[ 0 .. 100 ] characters

The delivery care of.

deliveryAddressLine1string or null[ 0 .. 255 ] characters

The delivery address line1.

deliveryAddressLine2string or null[ 0 .. 255 ] characters

The delivery address line2.

deliveryZipCodestring or null[ 0 .. 50 ] characters

The delivery zip code.

deliveryCitystring or null[ 0 .. 50 ] characters

The delivery city.

deliveryRegionstring or null[ 0 .. 100 ] characters

The delivery region.

deliveryCountryIdinteger or null(int32)

The delivery country identifier.

deliveryDatestring or null(date-time)

The delivery date.

quantitynumber or null(decimal)

The quantity.

volumenumber or null(decimal)

The volume.

weightnumber or null(decimal)

The weight.

isPrintedboolean

Indicates whether the delivery note is printed, not used anymore.

deliveryTermsstring or null[ 0 .. 10 ] characters

The delivery terms.

deliveryModestring or null[ 0 .. 50 ] characters

The delivery mode.

sourcestring or null[ 0 .. 255 ] characters

The source.

deliveryMarkstring or null[ 0 .. 255 ] characters

The delivery mark.

noteTextstring or null[ 0 .. 255 ] characters

The note text.

departmentstring or null[ 0 .. 10 ] characters

The department.

centrestring or null[ 0 .. 10 ] characters

The centre.

shippingNostring or null[ 0 .. 50 ] characters

The shipping number.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

deliveryAddressIdinteger or null(int64)

The delivery address identifier.

divisionCodestring or null[ 0 .. 50 ] characters

The division code.

statusIdinteger(int32)

The status identifier, Delivered (4), Partly Delivered (8).

isForgottenboolean

Indicates whether the delivery note is forgotten.

forgottenByinteger or null(int32)

The forgotten by.

forgottenDatestring or null(date-time)

The forgotten date.

deliveryAddress(Address (object or null))
One of:
itemsArray of objects or null(DeliveryNoteItem)
packagesArray of objects or null(DeliveryNotePackage)
referenceOrder(Order (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "noteNo": "string",
    "supplierId": 0,
    "typeId": 0,
    "referenceOrderId": 0,
    "buyerCompanyId": 0,
    "buyerCompanyCode": "string",
    "buyerCustomerId": 0,
    "buyerCustomerCode": "string",
    "payerCompanyId": 0,
    "payerCompanyCode": "string",
    "payerCustomerId": 0,
    "payerCustomerCode": "string",
    "resellerCompanyId": 0,
    "resellerCompanyCode": "string",
    "resellerCustomerId": 0,
    "resellerCustomerCode": "string",
    "groupCode": "string",
    "deliveryName": "string",
    "deliveryAttention": "string",
    "deliveryCareOf": "string",
    "deliveryAddressLine1": "string",
    "deliveryAddressLine2": "string",
    "deliveryZipCode": "string",
    "deliveryCity": "string",
    "deliveryRegion": "string",
    "deliveryCountryId": 0,
    "deliveryDate": "2019-08-24T14:15:22Z",
    "quantity": 0,
    "volume": 0,
    "weight": 0,
    "isPrinted": true,
    "deliveryTerms": "string",
    "deliveryMode": "string",
    "source": "string",
    "deliveryMark": "string",
    "noteText": "string",
    "department": "string",
    "centre": "string",
    "shippingNo": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "deliveryAddressId": 0,
    "divisionCode": "string",
    "statusId": 0,
    "isForgotten": true,
    "forgottenBy": 0,
    "forgottenDate": "2019-08-24T14:15:22Z",
    "deliveryAddress": { … },
    "items": [ … ],
    "packages": [ … ],
    "referenceOrder": { … }
  }
]

Gets all invoices.

Request

Headers
ApplicationIdintegerrequired

Application ID

curl -i -X GET \
  https://norcecommerce.api-se.norce.tech/commerce/query/3.0/Orders/Invoices \
  -H 'ApplicationId: 0'

Responses

A queryable collection of invoices.

Bodyapplication/jsonArray [
idinteger(int64)

The unique identifier of the invoice.

clientIdinteger(int32)

The client identifier.

invoiceNostring[ 0 .. 50 ] charactersrequired

The invoice number, from the ERP system.

typeIdinteger(int32)

The type identifier, sales order invoice (1).

referenceOrderIdinteger(int64)

The reference order identifier, links to the Sales Order.

referenceNoPspstring or null[ 0 .. 50 ] characters

The reference number, PSP reference.

buyerCompanyIdinteger or null(int32)

The buyer company identifier.

buyerCustomerIdinteger or null(int32)

The buyer customer identifier.

payerCompanyIdinteger or null(int32)

The payer company identifier.

payerCustomerIdinteger or null(int32)

The payer customer identifier.

resellerCompanyIdinteger or null(int32)

The reseller company identifier, not commonly used.

resellerCustomerIdinteger or null(int32)

The reseller customer identifier, not commonly used.

groupCodestring or null[ 0 .. 50 ] characters

The group code, not commonly used.

deliveryDatestring or null(date-time)

The delivery date.

invoiceDatestring(date-time)

The invoice date.

invoiceDueDatestring or null(date-time)

The invoice due date.

salesRepContactIdinteger or null(int32)

The sales rep contact identifier, not used anymore.

sourcestring or null[ 0 .. 255 ] characters

The source of the order the invoice is referencing, 'WEB' is reserved for orders coming through Norce shopping and checkout processes.

quantitynumber(decimal)

The quantity, total quantity of items in the invoice.

volumenumber or null(decimal)

The volume.

weightnumber or null(decimal)

The weight.

currencyIdinteger(int32)

The currency identifier.

currencyRatenumber(decimal)

The currency rate, used for converting the invoice amount to the base currency.

cashDiscountnumber or null(decimal)

The cash discount.

cashDiscountDatestring or null(date-time)

The cash discount date.

sumLineDiscountnumber or null(decimal)

The sum line discount.

freightCostnumber or null(decimal)

The freight cost.

invoiceFeenumber or null(decimal)

The invoice fee.

costValuenumber or null(decimal)

The cost value.

salesBalancenumber or null(decimal)

The sales balance.

invoiceAmountnumber or null(decimal)

The invoice amount, total amount of the invoice, including VAT.

invoiceRoundOffnumber or null(decimal)

The invoice round off.

vatDutiable1number or null(decimal)

The first VAT dutiable amount.

vatDutiable2number or null(decimal)

The second VAT dutiable amount.

vatDutiable3number or null(decimal)

The third VAT dutiable amount.

vat1number or null(decimal)

The first VAT dutiable rate.

vat2number or null(decimal)

The second VAT dutiable rate.

vat3number or null(decimal)

The third VAT dutiable rate.

vatRoundOffnumber or null(decimal)

The vat round off.

vatnumber or null(decimal)

The VAT amount.

invoiceNamestring or null[ 0 .. 255 ] characters

The invoice name, commonly customer name.

invoiceAttentionstring or null[ 0 .. 100 ] characters

The invoice attention.

invoiceCareOfstring or null[ 0 .. 100 ] characters

The invoice care of.

invoiceAddressLine1string or null[ 0 .. 255 ] characters

The invoice address line1.

invoiceAddressLine2string or null[ 0 .. 255 ] characters

The invoice address line2.

invoiceZipCodestring or null[ 0 .. 50 ] characters

The invoice zip code.

invoiceCitystring or null[ 0 .. 50 ] characters

The invoice city.

invoiceRegionstring or null[ 0 .. 100 ] characters

The invoice region.

invoiceCountryIdinteger or null(int32)

The invoice country identifier.

ledgerVoucherstring or null[ 0 .. 50 ] characters

The ledger voucher, not used anymore.

departmentstring or null[ 0 .. 10 ] characters

The department, not commonly used.

centrestring or null[ 0 .. 10 ] characters

The centre, not commonly used.

noteTextstring or null[ 0 .. 255 ] characters

The note text.

lastInvoiceForOrderboolean or null

Indicates whether this is the last invoice for the order, and if the payment capture logic can close the transaction at the PSP.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

updatedstring or null(date-time)

The date and time the record was last updated.

updatedByinteger or null(int32)

The identifier of the user who last updated the record.

invoiceAddressIdinteger or null(int64)

The invoice address identifier.

paymentMethodIdinteger or null(int32)

The payment method identifier.

deliveryMethodIdinteger or null(int32)

The delivery method identifier.

isDebitboolean or null

Indicates whether the invoice is debit, false when the invoice is credit and should trigger a payment credit integration.

creditedInvoiceIdinteger or null(int64)

The credited invoice identifier.

commentstring or null[ 0 .. 250 ] characters

A comment or note.

isForgottenboolean

Indicates whether the invoice is forgotten, not commonly used.

forgottenByinteger or null(int32)

The forgotten by, not commonly used.

forgottenDatestring or null(date-time)

The forgotten date, not commonly used.

aggregatedInvoiceCodestring or null[ 0 .. 100 ] characters

The aggregated invoice code, grouping multiple invoices together.

paymentMethodCodestring or null[ 0 .. 50 ] characters

The payment method code.

paymentMethodNamestring or null[ 0 .. 50 ] characters

The payment method name.

invoiceGlnstring or null[ 0 .. 50 ] characters

The invoice GLN.

creditedInvoiceInvoice (object)
One of:
object Invoice Recursive
inverseCreditedInvoiceArray of objects or null(Invoice)
address(Address (object or null))
One of:
itemsArray of objects or null(InvoiceItem)
referenceOrder(Order (object or null))
One of:
]
Response
application/json
[
  {
    "id": 0,
    "clientId": 0,
    "invoiceNo": "string",
    "typeId": 0,
    "referenceOrderId": 0,
    "referenceNoPsp": "string",
    "buyerCompanyId": 0,
    "buyerCustomerId": 0,
    "payerCompanyId": 0,
    "payerCustomerId": 0,
    "resellerCompanyId": 0,
    "resellerCustomerId": 0,
    "groupCode": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "invoiceDate": "2019-08-24T14:15:22Z",
    "invoiceDueDate": "2019-08-24T14:15:22Z",
    "salesRepContactId": 0,
    "source": "string",
    "quantity": 0,
    "volume": 0,
    "weight": 0,
    "currencyId": 0,
    "currencyRate": 0,
    "cashDiscount": 0,
    "cashDiscountDate": "2019-08-24T14:15:22Z",
    "sumLineDiscount": 0,
    "freightCost": 0,
    "invoiceFee": 0,
    "costValue": 0,
    "salesBalance": 0,
    "invoiceAmount": 0,
    "invoiceRoundOff": 0,
    "vatDutiable1": 0,
    "vatDutiable2": 0,
    "vatDutiable3": 0,
    "vat1": 0,
    "vat2": 0,
    "vat3": 0,
    "vatRoundOff": 0,
    "vat": 0,
    "invoiceName": "string",
    "invoiceAttention": "string",
    "invoiceCareOf": "string",
    "invoiceAddressLine1": "string",
    "invoiceAddressLine2": "string",
    "invoiceZipCode": "string",
    "invoiceCity": "string",
    "invoiceRegion": "string",
    "invoiceCountryId": 0,
    "ledgerVoucher": "string",
    "department": "string",
    "centre": "string",
    "noteText": "string",
    "lastInvoiceForOrder": true,
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "invoiceAddressId": 0,
    "paymentMethodId": 0,
    "deliveryMethodId": 0,
    "isDebit": true,
    "creditedInvoiceId": 0,
    "comment": "string",
    "isForgotten": true,
    "forgottenBy": 0,
    "forgottenDate": "2019-08-24T14:15:22Z",
    "aggregatedInvoiceCode": "string",
    "paymentMethodCode": "string",
    "paymentMethodName": "string",
    "invoiceGln": "string",
    "creditedInvoice": {},
    "inverseCreditedInvoice": [ … ],
    "address": { … },
    "items": [ … ],
    "referenceOrder": { … }
  }
]

Products

Operations

Shopping

Operations

Metadata

Operations