Skip to content
COMMERCE CONNECT
/
Order Service
/
/
Credit an Order

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/

Order Notification

Operations

Order

Operations

Invoice

Operations

Import an invoice.

Request

Creates an invoice from another system. Will capture/activate payment if applicable.
Read more about the method here.

Body
required

Invoice

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.

curl -i -X POST \
  https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Order/CreateInvoice \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
      {
        "PartNo": "string",
        "Quantity": 0,
        "UnitPrice": 0,
        "Description": "string",
        "Discount": 0,
        "LineAmount": 0,
        "LineNo": 0,
        "PriceList": "string",
        "ProductName": "string",
        "SalePrice": 0,
        "UnitVat": 0,
        "VatRate": 0
      }
    ],
    "Name": "string",
    "Payment": {
      "PaymentCode": 0,
      "PaymentMethodCode": "string",
      "PaymentRef": "string",
      "AdditionalInfo": [
        {
          "Code": "string",
          "Code2": "string",
          "Id": 0,
          "Value": "string"
        }
      ],
      "Amount": 0,
      "CurrencyCode": "string",
      "PaymentName": "string"
    },
    "PaymentMethodCode": "string",
    "PaymentMethodName": "string",
    "Region": "string",
    "SuppressPspCall": true,
    "TotalAmount": 0,
    "Vat": 0,
    "VatRoundOff": 0,
    "ZipCode": "string"
  }'

Responses

Success

Body

Credit an Order

Request

Create a credit request that is sent to a payment service, if applicable. Must be related to an order, but can be a partly credit.
Read more about the method here.

Body
required

Invoice to be credited.

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.

curl -i -X POST \
  https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Order/CreditPayment \
  -H 'Content-Type: application/json' \
  -d '{
    "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": [
      {
        "PartNo": "string",
        "Quantity": 0,
        "UnitPrice": 0,
        "Description": "string",
        "Discount": 0,
        "LineAmount": 0,
        "LineNo": 0,
        "PriceList": "string",
        "ProductName": "string",
        "SalePrice": 0,
        "UnitVat": 0,
        "VatRate": 0
      }
    ],
    "Name": "string",
    "Payment": {
      "PaymentCode": 0,
      "PaymentMethodCode": "string",
      "PaymentRef": "string",
      "AdditionalInfo": [
        {
          "Code": "string",
          "Code2": "string",
          "Id": 0,
          "Value": "string"
        }
      ],
      "Amount": 0,
      "CurrencyCode": "string",
      "PaymentName": "string"
    },
    "PaymentMethodCode": "string",
    "PaymentMethodName": "string",
    "Region": "string",
    "SuppressPspCall": true,
    "TotalAmount": 0,
    "Vat": 0,
    "VatRoundOff": 0,
    "ZipCode": "string"
  }'

Responses

Success

Body

POS Shipment

Operations