CustomerOrders

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Sales/CustomerOrders

Represents a customer order.

GUID

9A008BAB-1814-43EC-AFA5-4E42A5C3B36C

Required permission

Show customer orders

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the customer order.
PaymentTermId Int64? The business key identifier of the payment term of the customer order.

References PaymentTerms
PaymentTerm PaymentTerms The payment term of the customer order.

  • Expandable
PaymentTermDescription String The payment term description of the customer order.

  • Max length is 35
GracePeriodInDays Int32? The customer order's grace period in days.
DeliveryMethodId Int64? The business key identifier of the customer order's delivery method.

References DeliveryMethods
DeliveryTermId Int64? The business key identifier of the customer order's delivery term.

References DeliveryTerms
DeliveryTermDescription String The delivery term description of the customer order.

  • Max length is 35
DeliveryMethodDescription String The delivery method description of the customer order.

  • Max length is 35
ShipmentPayer Int32 Specifies who is responsible for the shipment payment for the customer order.

  • BuyerPays: 1
  • SellerPays: 2
  • OtherPayer: 3
  • Incoterms: 4
BusinessContactOrderNumber String The end-customer's order number for the customer order.

  • Max length is 30
OurReferenceId Int64? The business key identifier of our reference for the customer order.

Reference Persons
OurReferenceName String The name of our reference for the customer order.

  • Max length is 80
BusinessContactReferenceId Int64? The business key identifier of the customer's reference for the customer order.

References BusinessContactReferences
BusinessContactReferenceName String The name of the customer's reference for the customer order.

  • Max length is 80
GoodsLabel String The goods label of the customer order.

  • Max length is 80
CurrencyId Int64 The business key identifier of the currency of the customer order.

References Currencies
VatGroupId Int64 The business key identifier of the VAT group that applies for the customer order.

References VatGroups
WarehouseId Int64 The business key identifier of the warehouse that the customer order belongs to.

References Warehouses
Priority Int32 The priority of the customer order.
ProjectId Int64? The business key identifier of the customer order's project.

References Project
SendMethod Int32 Specifies the printout method for the customer order.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
InvoicePrintoutMethod Int32 Specifies the printout method that should be used for invoices.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
InternalCommentId Int64? The business key identifier of the customer order's internal comment.

References Comments
InternalComment Comments The internal comment of the customer order.

  • Expandable
ExternalCommentId Int64? The business key identifier of the customer order's external comment.

References Comments
ExternalComment Comments The external comment of the customer order.

  • Expandable
TransportTime Int32? The transport time of the customer order in workdays.
LifeCycleState Int32 The life cycle state of the customer order.

  • Transient: 1
  • Persistent: 10
  • History: 20
  • RemovableCandidate: 99
Version Int32 The version of the customer order.
UseForwardRate Boolean Specifies if forward rate should apply for the customer order.
ExchangeRate Decimal Specifies the exchange rate to use for the customer order.
OrderAmount Decimal This property is obsolete and no longer carries a value.

  • Obsolete since version 2.36 (Unavailable)
OrderAmountInCompanyCurrency Decimal This property is obsolete and no longer carries a value.

  • Obsolete since version 2.36 (Unavailable)
CustomerId Int64 The business key identifier of the customer that the customer order
belongs to.

References Customers
InvoiceCustomerId Int64 The business key identifier of the invoice customer that the customer order
belongs to.

References Customers
OrderNumber String The human readable identifier of the customer order.

  • Not nullable
  • Max length is 15
  • Unique
OrderDate DateTimeOffset The order date of the customer order.
Rows CustomerOrderRows[] The rows of the customer order.

  • Expandable
SellerId Int64? The business key identifier of the customer order's seller.

References Persons
ShowPriceInAcknowledgement Boolean Specifies if price should be shown in the acknowledgement of the customer order.
ShowTotalInAcknowledgement Boolean Specifies if the price total should be shown in the acknowledgement of the customer order.
ThirdPartyTrading Boolean Specifies if the customer order falls under third party trading.
DeliveryInstruction String The delivery instruction of the customer order.

  • Max length is 80
ActiveDeliveryAddressCustomerId Int64? The business key identifier of the customer source of the active delivery address.

References Customers
ActiveDeliveryAddressSupplierId Int64? The business key identifier of the supplier source of the active delivery address.

References Suppliers
ActiveDeliveryAddressCompanyId Int64? The business key identifier of the company source of the active delivery address.

References Company
SourceOfAlternativeDeliveryAddresses Int32 Specifies the source of the customer order delivery address.

  • CurrentCustomer: 0
  • Customer: 1
  • Supplier: 2
  • Company: 3
  • CurrentSupplier: 4
IsCredit Boolean Specifies if the customer order is on credit or not.
InvoiceType Int32 The invoice type of the customer order.

  • Standard: 1
  • Internal: 2
  • CashReceipt: 3
  • Interest: 4
  • OnAccount: 5
  • DebitNote: 6
  • ServiceTax: 7
  • CorrectionInvoice: 8
  • CollectiveCorrectionInvoice: 9
PaymentMethodId Int64? The business key identifier of the customer order's payment method.

References
PaymentMethod PaymentMethods The payment method on the customer order.

  • Expandable
 Introduced in version 2.30
PrintoutTimeStamp DateTimeOffset The date/time when the printout of the customer order was made.

  • Obsolete since version 2.35 (Printout date is not stored on the order)
ConsigneeReferenceId Int64? The business key identifier of the customer order's consignee reference.

References BusinessContactReferences
ConsigneeReference BusinessContactReferences The consignee reference on the customer order.

  • Expandable
 Introduced in version 2.30
PrintoutBy String The user name of the ApplicationUsers that printed the
customer order.

  • Max length is 20
  • Obsolete since version 2.35 (Printout user is not stored on the order)
Preliminary Boolean Specifies if the customer order is to be considered preliminary.
ConsigneeReferenceName String The consignee reference name of the customer order.

  • Max length is 80
DestinationForDeliveryTerm String The destination for the delivery term.

  • Max length is 80
CustomerAccountGroupId Int64? The business key identifier of the customer account group of the
customer order.
SupplierAccountGroupId Int64? The business key identifier of the supplier account group of the
customer order.

References a SupplierAccountGroup

  • Obsolete since version 24.3 (Refer to DeliveryAddress)
DeliveryAddressId Int64? The business key identifier of the customer order's delivery address.

References Addresses
DeliveryAddress Addresses The delivery address of the customer order.

  • Expandable
MailingAddressId Int64? The business key identifier of the customer order's mailing
address.

References Addresses
MailingAddress Addresses The mailing address of the customer order.

  • Expandable
InvoiceAddressId Int64? The business key identifier of the customer order's invoice
address.

References Addresses
InvoiceAddress Addresses The invoice address of the customer order.

  • Expandable
InvoiceStatusPending Boolean Specifies if the invoice created for the customer order should
start out as pending.
IsPartOfComprehensiveInvoice Boolean Specifies if the customer order is part of a comprehensive invoice.

  • Obsolete since version 2.41 (Replaced by ComprehensiveInvoiceGroupingMode)
ComprehensiveInvoiceGroupingMode Int32 Specifies if the customer order is part of a comprehensive invoice, and how they are grouped.

  • None: 0
  • Customer: 1
  • Order: 2
  • DeliveryNote: 3
 Introduced in version 2.41
HasInvoicingCharge Boolean Specifies if the customer order involves an invoicing charge.
GoodsAddressNumber String The goods address number of the customer order.

  • Max length is 80
VatNumber String The VAT number of the customer order.

  • Max length is 80
Dock String The dock of the customer order.

  • Max length is 35
FromQuoteNumber String The human readable identifier of the quote that resulted in
the customer order.

  • Max length is 15
Status Int32 The status of the customer order.

  • NotInitialized: 0
  • Registered: 1
  • OrderConfirmationPrinted: 2
  • CanNotConfirmDeliveryTime: 3
  • DeliveryNotePrinted: 4
  • PartiallyDelivered: 5
  • History: 9
CommunicationAddresses CommunicationAddresses[] The communication addresses registered on the customer order.
PrintProformaInvoiceVia Int32? The preferred Proforma printout method of the customer.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
OrderTypeId Int64? The business key identifier of the customer order's order type.

References CustomerOrderTypes
 Introduced in version 2.27
OrderType CustomerOrderTypes The order type used on the customer order.

  • Expandable
 Introduced in version 2.27
IsStockOrder Boolean Specifies if the customer order is stock order.
 Introduced in version 2.30
ExcludeFromEdi Boolean Specifies if the customer order will be excluded from EDI.
 Introduced in version 2.30
IncludeInDeliveryAnalysis Boolean? Specifies if the customer order will be included in delivery analysis.
 Introduced in version 2.30
PartialDeliveryType Int32 The partial delivery type on the customer order.

  • None: 0
  • PerOrder: 1
  • PerRow: 2
  • NoneDelete: 3 (Introduced in version 22.8)
  • PerDeliveryDate: 4 (Introduced in version 25.3)
 Introduced in version 2.30
DeliveryHorizon TimeSpan? The delivery horizon on the customer order.
 Introduced in version 2.30
DeliveryNoteNumberWhenDeliveryPlanning Boolean Specifies if using delivery note number when delivery planning on the customer order.
 Introduced in version 2.30
AftermarketProductRecordId Int64? The business key identifier of the customer order's aftermarket product record.

References ProductRecords
 Introduced in version 2.30
PurchaseOrderId Int64? The business key identifier of the customer order's purchase order.

References PurchaseOrders
 Introduced in version 2.30
PurchaseOrder PurchaseOrders The purchase order on the customer order.

  • Expandable
 Introduced in version 2.30
PaymentPlanTemplateId Int64? The business key identifier of the customer order's payment plan template.

References
Introduced in version 2.30
PaymentPlanTemplate PaymentPlanTemplates The payment plan template on the customer order.

  • Expandable
 Introduced in version 2.30
UnpaidAdvanceWarningType Int32 The unpaid advance warning type on the customer order.

  • NoAlert: 0
  • Warning: 1
  • PreventDelivery: 2
 Introduced in version 2.30
CreatedFrom Int32 Specifies what the customer order was created from.

  • Client: 0
  • M2M: 1
  • EDI: 2
  • DeliverySchedule: 3
  • DeliveryScheduleCallOff: 4
 Introduced in version 2.30
ShippingInformationId Int64? The business key identifier of the customer order's shipping information.

References CustomerOrderShippingInformation
 Introduced in version 2.30
ShippingInformationRows CustomerOrderShippingInformationRows[] The shipping information rows on the customer order.

  • Expandable
 Introduced in version 2.30
ExcludeFromPaymentPlanReconciliation Boolean Specifies if the customer order is excluded from payment plan reconciliation.
 Introduced in version 2.30
ResetPaymentPlanDifferenceAmount Decimal? The reset payment plan difference amount on the customer order.
 Introduced in version 2.30
ResetPaymentPlanDifferenceAmountCurrencyId Int64? The business key identifier of the customer order's reset payment plan difference amount currency.

References Currencies
 Introduced in version 2.30
ResetPaymentPlanDifferenceAmountCurrency Currencies The reset payment plan difference amount currency on the customer order.

  • Expandable
 Introduced in version 2.30
TransferStatus Int32 The transfer status of the customer order.

  • None: 0
  • Partial: 1
  • Fully: 2
 Introduced in version 2.30
CreatedInCompanyWithRole Int32? The role of the company who created the customer order.

  • ManufacturingCompany: 0
  • SalesCompany: 1
 Introduced in version 2.30
AccountGroupId Int64 The business key identifier of the account group of the customer order.

References CustomerAccountGroups
 Introduced in version 2.30
AccountGroup CustomerAccountGroups The account group on the customer order.

  • Expandable
 Introduced in version 2.30
CategoryString String The category string on the customer order.

  • Max length is 20
 Introduced in version 2.30
CurrencyExchangeTypeId Int64 The business key identifier of the customer order's currency exchange type.

 Introduced in version 22.9
EditedOrderAmountExcludingVat Decimal? The edited order amount excluding VAT for the customer order.
 Introduced in version 24.8
EditedOrderAmountExcludingVatCurrencyId Int64? The currency of the edited order amount excluding VAT for the customer order.

 Introduced in version 24.8
EditedOrderAmountDiscount Decimal? The edited order amount discount in percent for the customer order.
 Introduced in version 24.8
TypeOfOrderAmountEntered Int32? The type of edited order value entered on the customer order.

  • Percent: 1
  • Amount: 2
 Introduced in version 24.8

Example

{
  "Id": 0,
  "PaymentTermId": null,
  "PaymentTerm": null,
  "PaymentTermDescription": null,
  "GracePeriodInDays": null,
  "DeliveryMethodId": null,
  "DeliveryTermId": null,
  "DeliveryTermDescription": null,
  "DeliveryMethodDescription": null,
  "ShipmentPayer": 0,
  "BusinessContactOrderNumber": null,
  "OurReferenceId": null,
  "OurReferenceName": null,
  "BusinessContactReferenceId": null,
  "BusinessContactReferenceName": null,
  "GoodsLabel": null,
  "CurrencyId": 0,
  "VatGroupId": 0,
  "WarehouseId": 0,
  "Priority": 0,
  "ProjectId": null,
  "SendMethod": 0,
  "InvoicePrintoutMethod": 0,
  "InternalCommentId": null,
  "InternalComment": null,
  "ExternalCommentId": null,
  "ExternalComment": null,
  "TransportTime": null,
  "LifeCycleState": 0,
  "Version": 0,
  "UseForwardRate": false,
  "ExchangeRate": 0.0,
  "OrderAmount": 0.0,
  "OrderAmountInCompanyCurrency": 0.0,
  "CustomerId": 0,
  "InvoiceCustomerId": 0,
  "OrderNumber": null,
  "OrderDate": "0001-01-01T00:00:00+00:00",
  "Rows": null,
  "SellerId": null,
  "ShowPriceInAcknowledgement": false,
  "ShowTotalInAcknowledgement": false,
  "ThirdPartyTrading": false,
  "DeliveryInstruction": null,
  "ActiveDeliveryAddressCustomerId": null,
  "ActiveDeliveryAddressSupplierId": null,
  "ActiveDeliveryAddressCompanyId": null,
  "SourceOfAlternativeDeliveryAddresses": 0,
  "IsCredit": false,
  "InvoiceType": 0,
  "PaymentMethodId": null,
  "PaymentMethod": null,
  "PrintoutTimeStamp": "0001-01-01T00:00:00+00:00",
  "ConsigneeReferenceId": null,
  "ConsigneeReference": null,
  "PrintoutBy": null,
  "Preliminary": false,
  "ConsigneeReferenceName": null,
  "DestinationForDeliveryTerm": null,
  "CustomerAccountGroupId": null,
  "SupplierAccountGroupId": null,
  "DeliveryAddressId": null,
  "DeliveryAddress": null,
  "MailingAddressId": null,
  "MailingAddress": null,
  "InvoiceAddressId": null,
  "InvoiceAddress": null,
  "InvoiceStatusPending": false,
  "IsPartOfComprehensiveInvoice": false,
  "ComprehensiveInvoiceGroupingMode": 0,
  "HasInvoicingCharge": false,
  "GoodsAddressNumber": null,
  "VatNumber": null,
  "Dock": null,
  "FromQuoteNumber": null,
  "Status": 0,
  "CommunicationAddresses": null,
  "PrintProformaInvoiceVia": null,
  "OrderTypeId": null,
  "OrderType": null,
  "IsStockOrder": false,
  "ExcludeFromEdi": false,
  "IncludeInDeliveryAnalysis": null,
  "PartialDeliveryType": 0,
  "DeliveryHorizon": null,
  "DeliveryNoteNumberWhenDeliveryPlanning": false,
  "AftermarketProductRecordId": null,
  "PurchaseOrderId": null,
  "PurchaseOrder": null,
  "PaymentPlanTemplateId": null,
  "PaymentPlanTemplate": null,
  "UnpaidAdvanceWarningType": 0,
  "CreatedFrom": 0,
  "ShippingInformationId": null,
  "ShippingInformationRows": null,
  "ExcludeFromPaymentPlanReconciliation": false,
  "ResetPaymentPlanDifferenceAmount": null,
  "ResetPaymentPlanDifferenceAmountCurrencyId": null,
  "ResetPaymentPlanDifferenceAmountCurrency": null,
  "TransferStatus": 0,
  "CreatedInCompanyWithRole": null,
  "AccountGroupId": 0,
  "AccountGroup": null,
  "CategoryString": null,
  "CurrencyExchangeTypeId": 0,
  "EditedOrderAmountExcludingVat": null,
  "EditedOrderAmountExcludingVatCurrencyId": null,
  "EditedOrderAmountDiscount": null,
  "TypeOfOrderAmountEntered": null
}