COMMERCE QUERY

Query API 3.0

Invoice

Query (v1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

Address

idinteger(int64)

The unique identifier of the address.

typeIdinteger or null(int32)

The type identifier.

namestring or null[ 0 .. 100 ] characters

The name of the address.

attentionstring or null[ 0 .. 100 ] characters

The attention.

careOfstring or null[ 0 .. 100 ] characters

The care of.

line1string or null[ 0 .. 255 ] characters

The first line of the address.

line2string or null[ 0 .. 255 ] characters

The second line of the address.

zipCodestring or null[ 0 .. 50 ] characters

The zip code.

citystring or null[ 0 .. 50 ] characters

The city.

regionstring or null[ 0 .. 50 ] characters

The region.

countryIdinteger or null(int32)

The country identifier.

emailAddressstring or null[ 0 .. 255 ] characters

The email address.

phoneNumberstring or null[ 0 .. 50 ] characters

The phone number.

createdstring(date-time)

The date and time the record was created.

createdByinteger(int32)

The identifier of the user who created the record.

rowidstring(byte)non-emptyrequired

The rowid, used for concurrency checks.

clientIdinteger or null(int32)

The client identifier.

shippingPhoneNumberstring or null[ 0 .. 50 ] characters

The shipping phone number.

glnstring or null[ 0 .. 50 ] characters

The GLN.

deliveryNoteArray of objects or null(DeliveryNote)

invoiceArray of objects or null(Invoice)

{
  "id": 0,
  "typeId": 0,
  "name": "string",
  "attention": "string",
  "careOf": "string",
  "line1": "string",
  "line2": "string",
  "zipCode": "string",
  "city": "string",
  "region": "string",
  "countryId": 0,
  "emailAddress": "string",
  "phoneNumber": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "rowid": "string",
  "clientId": 0,
  "shippingPhoneNumber": "string",
  "gln": "string",
  "deliveryNote": [
    { … }
  ],
  "invoice": [
    { … }
  ]
}

Invoice

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:

{
  "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": {
    "id": 0,
    "typeId": 0,
    "name": "string",
    "attention": "string",
    "careOf": "string",
    "line1": "string",
    "line2": "string",
    "zipCode": "string",
    "city": "string",
    "region": "string",
    "countryId": 0,
    "emailAddress": "string",
    "phoneNumber": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "rowid": "string",
    "clientId": 0,
    "shippingPhoneNumber": "string",
    "gln": "string",
    "deliveryNote": [ … ],
    "invoice": [ … ]
  },
  "items": [
    { … }
  ],
  "referenceOrder": {
    "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": { … }
  }
}

InvoiceItem

idinteger(int64)

The unique identifier of the invoice item.

invoiceIdinteger(int64)

The invoice identifier.

lineNumbernumber or null(decimal)

The line number.

statusIdinteger or null(int32)

The status identifier, commonly Invoiced (5).

partNostring[ 0 .. 50 ] charactersrequired

The part number.

externalPartNostring or null[ 0 .. 50 ] characters

The external part number, not commonly used.

productNamestring or null[ 0 .. 255 ] characters

The product name.

stockUnitOfMeasurementCountnumber(decimal)

The stock unit of measurement count.

priceUnitOfMeasurementCountnumber(decimal)

The price unit of measurement count.

warehouseIdinteger or null(int32)

The warehouse identifier, not used anymore.

locationIdinteger or null(int32)

The location identifier, not used anymore.

quantityinteger(int32)

The quantity as an integer, use Quantity2 for decimal values.

currencyIdinteger(int32)

The currency identifier.

vatRatenumber(decimal)

The VAT rate, in percent.

costUnitnumber or null(decimal)

The cost unit.

priceSalenumber or null(decimal)

The price sale, excluding VAT.

discountPercentagenumber(decimal)

The discount percentage.

discountAmountnumber(decimal)

The discount amount, excluding VAT.

lineAmountnumber(decimal)

The line amount, excluding VAT.

deliveryModestring or null[ 0 .. 50 ] characters

The delivery mode.

isPartDeliveryboolean

Indicates whether the invoice item is part delivery, not commonly used.

deliveryDatestring or null(date-time)

The delivery date.

salesRepContactIdinteger or null(int32)

The sales rep contact identifier, not commonly used.

ledgerAccountstring or null[ 0 .. 50 ] characters

The ledger account, 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.

transIdinteger(int64)

The trans identifier, not used anymore.

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.

orderItemIdinteger or null(int64)

The order item identifier, links the invoice item to an order item.

purchaseOrderItemIdinteger or null(int64)

The purchase order item identifier, links the invoice item to a purchase order item, not used anymore.

lineNumberStringstring or null[ 0 .. 50 ] characters

The line number as string.

priceUnitnumber or null(decimal)

The price unit, excluding VAT, its the price sale / Unit of measurement count, commonly same as PriceSale.

quantity2number or null(decimal)

The quantity in decimal value.

clientIdinteger or null(int32)

The client identifier.

invoice(Invoice (object or null))

One of:

orderItem(OrderItem (object or null))

One of:

{
  "id": 0,
  "invoiceId": 0,
  "lineNumber": 0,
  "statusId": 0,
  "partNo": "string",
  "externalPartNo": "string",
  "productName": "string",
  "stockUnitOfMeasurementCount": 0,
  "priceUnitOfMeasurementCount": 0,
  "warehouseId": 0,
  "locationId": 0,
  "quantity": 0,
  "currencyId": 0,
  "vatRate": 0,
  "costUnit": 0,
  "priceSale": 0,
  "discountPercentage": 0,
  "discountAmount": 0,
  "lineAmount": 0,
  "deliveryMode": "string",
  "isPartDelivery": true,
  "deliveryDate": "2019-08-24T14:15:22Z",
  "salesRepContactId": 0,
  "ledgerAccount": "string",
  "department": "string",
  "centre": "string",
  "transId": 0,
  "created": "2019-08-24T14:15:22Z",
  "createdBy": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": 0,
  "orderItemId": 0,
  "purchaseOrderItemId": 0,
  "lineNumberString": "string",
  "priceUnit": 0,
  "quantity2": 0,
  "clientId": 0,
  "invoice": {
    "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": { … }
  },
  "orderItem": {
    "id": 0,
    "orderId": 0,
    "lineNumber": 0,
    "parentLineNumber": 0,
    "statusId": 0,
    "partNo": "string",
    "externalPartNo": "string",
    "productName": "string",
    "stockUnitOfMeasurementCount": 0,
    "priceUnitOfMeasurementCount": 0,
    "warehouseId": 0,
    "locationId": 0,
    "qtyOrdered": 0,
    "currencyId": 0,
    "vatRate": 0,
    "costUnit": 0,
    "priceSale": 0,
    "discountPercentage": 0,
    "discountAmount": 0,
    "lineAmount": 0,
    "deliveryMode": "string",
    "isPartDelivery": true,
    "expectedDeliveryDate": "2019-08-24T14:15:22Z",
    "confirmedDeliveryDate": "2019-08-24T14:15:22Z",
    "salesRepContactId": 0,
    "ledgerAccount": "string",
    "department": "string",
    "centre": "string",
    "transId": 0,
    "externalStatusText": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": 0,
    "lineNumberString": "string",
    "priceRecommended": 0,
    "priceCatalog": 0,
    "priceStandard": 0,
    "clientId": 0,
    "deliveryNoteItem": [ … ],
    "invoiceItem": [ … ],
    "order": { … },
    "infos": [ … ]
  }
}

Application

Operations

Core

Operations

Customers

Operations

Order

Operations

Products

Operations

Shopping

Operations

Metadata

Operations