Skip to content
COMMERCE CONNECT
/
Order Service
/
/
Invoice

Documentation Norce Commerce Connect Order Service (4.0)

The Order Service has Entities and Operations concerned with orders created in Norce Commerce.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/connect/4.0/

Schemas

Schemas

Header

Header information about order.

ApplicationKeystring(Guid)

Application from where the order is created.

{
  "ApplicationKey": "string"
}

Invoice

Invoice information. Either InvoiceNo or ClientOrderRef must be provided.

ClientOrderRefinteger(int32)required

Reference basket/quotation id.

CurrencyCodestringrequired

Currency code, e.g. SEK. Max length: 3

ErpOrderNostringrequired

Reference ERP order number.

InvoiceDatestring(DateTime)required

Invoice creation date.

InvoiceNostring

Invoice identification number. Must be unique.

AddressLine1string

First line of receiver's address.

AddressLine2string

Second line of receiver's address.

ApplicationKeystring(Guid)

Application identifier.

Attentionstring

Receiver attention.

CareOfstring

Receiver care of.

Citystring

Receiver's city.

Commentstring

Client comment.

Countrystring

Receiver's country.

CountryCodestring

Country code (e.g. 'SE') explicit set for invoice to be forwarded to PSP.

CreditedInvoiceNostring

Invoice number of the invoice to credit (Only mandatory for credits).

CultureCodestring

Culture code (e.g. 'sv-SE') explicit set for invoice to be forwarded to PSP.

DeliveryDatestring(DateTime)

Date when order was shipped.

Glnstring

Global location number. Identifier for company/customer.

GroupCodestring

Code used for grouping of invoices (for partial invoicing).

InvoiceDueDatestring(DateTime)

Last date for invoice payments.

InvoiceRoundOffnumber

Total invoice round off.

IsLastInvoiceForOrderboolean

Determines if all invoices already received in case of partial payments. Null is considered as true.

ItemsArray of objects(InvoiceItem)(InvoiceItem)

List of invoiced order items. Mandatory for PSP capture.

Namestring

Receiver name

Paymentobject(Payment)(Payment)

Represents successful payment reservation. Either PaymentCode or PaymentRef must be provided.

PaymentMethodCodestring

Code for payment method used (for receipts).

PaymentMethodNamestring

Name of payment method used (for receipts).

Regionstring

Receiver's region.

SuppressPspCallboolean

Set to true to suppress a PSP call for this invoice. Invoice will be stored as information only.

TotalAmountnumber

Deprecated

Vatnumber

VAT amount

VatRoundOffnumber

Deprecated

ZipCodestring

Receiver's zip code.

{
  "ClientOrderRef": 0,
  "CurrencyCode": "string",
  "ErpOrderNo": "string",
  "InvoiceDate": "string",
  "InvoiceNo": "string",
  "AddressLine1": "string",
  "AddressLine2": "string",
  "ApplicationKey": "string",
  "Attention": "string",
  "CareOf": "string",
  "City": "string",
  "Comment": "string",
  "Country": "string",
  "CountryCode": "string",
  "CreditedInvoiceNo": "string",
  "CultureCode": "string",
  "DeliveryDate": "string",
  "Gln": "string",
  "GroupCode": "string",
  "InvoiceDueDate": "string",
  "InvoiceRoundOff": 0,
  "IsLastInvoiceForOrder": true,
  "Items": [
    { … }
  ],
  "Name": "string",
  "Payment": {
    "PaymentCode": 0,
    "PaymentMethodCode": "string",
    "PaymentRef": "string",
    "AdditionalInfo": [ … ],
    "Amount": 0,
    "CurrencyCode": "string",
    "PaymentName": "string"
  },
  "PaymentMethodCode": "string",
  "PaymentMethodName": "string",
  "Region": "string",
  "SuppressPspCall": true,
  "TotalAmount": 0,
  "Vat": 0,
  "VatRoundOff": 0,
  "ZipCode": "string"
}

InvoiceItem

Order item to be invoiced.

PartNostringrequired

Item part no.

Quantityinteger(int32)required

Quantity of invoiced items.

UnitPricenumberrequired

Unit price

Descriptionstring

Item description. Mandatory for PSP capture.

Discountnumber

Deprecated

LineAmountnumber

Deprecated

LineNonumber

Line number.

PriceListstring

Item price list.

ProductNamestring

Product name.

SalePricenumber

Deprecated

UnitVatnumber

Unit VAT amount. Mandatory for PSP capture.

VatRatenumber

VAT rate in percent. Mandatory for PSP capture.

{
  "PartNo": "string",
  "Quantity": 0,
  "UnitPrice": 0,
  "Description": "string",
  "Discount": 0,
  "LineAmount": 0,
  "LineNo": 0,
  "PriceList": "string",
  "ProductName": "string",
  "SalePrice": 0,
  "UnitVat": 0,
  "VatRate": 0
}

Order Notification

Operations

Order

Operations

Invoice

Operations

POS Shipment

Operations