CustomerOrderInvoices

Queryable, Introduced in version 2.33

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

Represents a customer order invoice.

GUID

61435D1A-FCFC-4DA4-B199-03BDA9E30A9B

Required permission

Show customer orders

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the customer order invoice.
Status Int32 The status of the customer order invoice.

  • Canceled: 0
  • Registered: 1
  • Preliminary: 2
  • Waiting: 3
  • InvoiceApproved: 8
  • InvoicePrinted: 9
DeliveryNoteNumber Int64 The delivery note number of the customer order invoice.
DeliveryIndex Int32 The delivery index of the customer order invoice.
OrderDeliveryNumber String The order delivery number of the customer order invoice.

  • Max length is 18
PickingListId Int64? The business key identifier of the picking list of the customer order invoice.

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

References Warehouses
Version Int32 The version of the customer order invoice.
 Introduced in version 2.34
ActiveDeliveryAddressCustomerId Int64? The business key identifier of the customer source of the active delivery address.

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

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

References Company
 Introduced in version 2.34
SourceOfAlternativeDeliveryAddresses Int32 Specifies the source of the customer order invoice delivery address.

  • CurrentCustomer: 0
  • Customer: 1
  • Supplier: 2
  • Company: 3
  • CurrentSupplier: 4
 Introduced in version 2.34
ConsigneeReferenceId Int64? The business key identifier of the consignee reference of the customer order invoice.

References BusinessContactReferences
 Introduced in version 2.34
ConsigneeReference BusinessContactReferences The consignee reference on the customer order invoice.

  • Expandable
 Introduced in version 2.34
ProformaStatus Int32 The proforma status of the customer order invoice.

  • None: 0
  • ApprovedForPrint: 1
  • Printed: 2
 Introduced in version 2.34
ProjectId Int64? The business key identifier of project of the customer order invoice.

References Projects
 Introduced in version 2.34
DeliveryAddressId Int64? The business key identifier of the delivery address of the customer order invoice.

References Addresses
 Introduced in version 2.34
DeliveryAddress Addresses The delivery address of the customer order invoice.

  • Expandable
 Introduced in version 2.34
InvoiceAddressId Int64? The business key identifier of the invoice address of the customer order invoice.

References Addresses
 Introduced in version 2.34
InvoiceAddress Addresses The invoice address of the customer order invoice.

  • Expandable
 Introduced in version 2.34
OurReferenceId Int64? The business key identifier of our reference for the customer order invoice.

Reference Persons
 Introduced in version 2.34
OurReferenceName String The name of our reference for the customer order invoice.

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

References BusinessContactReferences
 Introduced in version 2.34
BusinessContactReferenceName String The name of the customer's reference for the customer order invoice.

  • Max length is 80
 Introduced in version 2.34
GoodsLabel String The goods label of the customer order invoice.

  • Max length is 80
 Introduced in version 2.34
InvoiceStatusPending Boolean Specifies if the invoice status is pending on the customer order invoice.
 Introduced in version 2.34
IsPartOfComprehensiveInvoice Boolean Specifies if the customer order invoice is part of a comprehensive invoice.

  • Obsolete since version 2.41 (Replaced by ComprehensiveInvoiceGroupingMode)
 Introduced in version 2.34
ComprehensiveInvoiceGroupingMode Int32 Specifies if the customer order invoice 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 invoice involves an invoicing charge.
 Introduced in version 2.34
IsFreeDeliveryMonth Boolean Specifies if the customer order invoice have a free delivery month.
 Introduced in version 2.34
GoodsAddressNumber String The goods address number of the customer order invoice.

  • Max length is 80
 Introduced in version 2.34
VatNumber String The VAT number of the customer order invoice.

  • Max length is 80
 Introduced in version 2.34
Dock String The dock of the customer order invoice.

  • Max length is 35
 Introduced in version 2.34
DeliveryInstruction String The delivery instruction of the customer order invoice.

  • Max length is 80
 Introduced in version 2.34
InvoicePrintoutMethod Int32? Specifies the printout method for the customer order invoice.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
 Introduced in version 2.34
PrintProformaInvoiceVia Int32? The preferred Proforma printout method of the customer order invoice.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
 Introduced in version 2.34
EInvoiceExportMode Int32? The preffered electronic invoice export mode to use on this customer order invoice.

  • No: 0
  • Yes: 1
  • YesIncludingPrintoutOrEmail: 2
  • SaveToFile: 3
 Introduced in version 2.34
Priority Int32 The priority of the customer order invoice.
 Introduced in version 2.34
DirectlyRegistered Boolean Specifies if the customer order invoice is directly registered.
 Introduced in version 2.34
PartialInvoiceType Int32? The partial invoice type of the customer order invoice.

  • NotInitialized: 0
  • InAdvance: 1
  • Delivery: 2
  • InArrears: 3
  • Text: 4
 Introduced in version 2.34
FormReportConfigurationId Int64? The business key identifier of the customer order invoice's form report configuration.

References FormReportConfigurations
 Introduced in version 2.34
DeliveryNoteCreationDate DateTimeOffset? The delivery note creation date on the customer order invoice.
 Introduced in version 2.34
ExcludeFromEdi Boolean Specifies if the customer order invoice will be excluded from EDI.
 Introduced in version 2.34
SellerId Int64? The business key identifier of the seller on the customer order invoice.

References Persons
 Introduced in version 2.34
ShippingInformationId Int64? The business key identifier of the shipping information on the customer order invoice.

References CustomerOrderShippingInformation
 Introduced in version 2.34
ProformaNumber Int64? The proforma number of the customer order invoice.
 Introduced in version 2.34
ProformaDate DateTimeOffset? The proforma date of the customer order invoice.
 Introduced in version 2.34
DestinationForDeliveryTerm String The destination for delivery term for the customer order invoice.

  • Max length is 35
 Introduced in version 2.34
CandidateDebitInvoiceId Int64? The business key identifier to the accounts receivable linked to the debit invoice candidate for this customer order invoice.

References AccountsReceivable.
 Introduced in version 2.34
ConsigneeReferenceName String The consignee reference name of the customer order invoice.

  • Max length is 80
 Introduced in version 2.34
LedgerId Int64? The business key identifier to the ledger's accounts receivable of the customer order invoice.

References AccountsReceivable.
 Introduced in version 2.34
BusinessContactOrderId Int64 The business key identifier to the customre order of the customer order invoice.

References CustomerOrders.
 Introduced in version 2.34
InvoiceBusinessContactId Int64 The business key identifier to the customer on the customer order invoice.

References Customers.
 Introduced in version 2.34
AccountGroupId Int64 The business key identifier of the account group of the customer order invoice.

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

  • Expandable
 Introduced in version 2.34
VatGroupId Int64 The business key identifier of the VAT group that applies for the customer order invoice.

References VatGroups
 Introduced in version 2.34
PaymentTermId Int64? The business key identifier of the payment term of the customer order invoice.

References PaymentTerms
 Introduced in version 2.34
PaymentTerm PaymentTerms The payment term of the customer order invoice.

  • Expandable
 Introduced in version 2.34
PaymentTermDescription String The payment term description of the customer order invoice.

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

References DeliveryMethods
 Introduced in version 2.34
DeliveryTermId Int64? The business key identifier of the delivery term of the customer order invoices.

References DeliveryTerms
 Introduced in version 2.34
DeliveryTermDescription String The delivery term description of the customer order invoice.

  • Max length is 35
 Introduced in version 2.34
DeliveryMethodDescription String The delivery method description of the customer order invoice.

  • Max length is 35
 Introduced in version 2.34
ShipmentPayer Int32 Specifies who is responsible for the shipment payment for the customer order invoce.

  • BuyerPays: 1
  • SellerPays: 2
  • OtherPayer: 3
  • Incoterms: 4
 Introduced in version 2.34
DeliveryRows CustomerOrderDeliveryRows[] The customer order delivery rows.

CustomerOrderDeliveryRows

  • Expandable
 Introduced in version 2.36
InvoiceType Int32 Invoice type of customer order invoice

  • Standard: 1
  • Internal: 2
  • CashReceipt: 3
  • Interest: 4
  • OnAccount: 5
  • DebitNote: 6
  • ServiceTax: 7
  • CorrectionInvoice: 8
  • CollectiveCorrectionInvoice: 9
 Introduced in version 2.53
EditedOrderAmountExcludingVat Decimal? The edited order amount excluding VAT for the customer order invoice.
 Introduced in version 24.8
EditedOrderAmountExcludingVatCurrencyId Int64? The currency of the edited order amount excluding VAT for the customer order invoice.

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

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

Example

{
  "Id": 0,
  "Status": 0,
  "DeliveryNoteNumber": 0,
  "DeliveryIndex": 0,
  "OrderDeliveryNumber": null,
  "PickingListId": null,
  "WarehouseId": 0,
  "Version": 0,
  "ActiveDeliveryAddressCustomerId": null,
  "ActiveDeliveryAddressSupplierId": null,
  "ActiveDeliveryAddressCompanyId": null,
  "SourceOfAlternativeDeliveryAddresses": 0,
  "ConsigneeReferenceId": null,
  "ConsigneeReference": null,
  "ProformaStatus": 0,
  "ProjectId": null,
  "DeliveryAddressId": null,
  "DeliveryAddress": null,
  "InvoiceAddressId": null,
  "InvoiceAddress": null,
  "OurReferenceId": null,
  "OurReferenceName": null,
  "BusinessContactReferenceId": null,
  "BusinessContactReferenceName": null,
  "GoodsLabel": null,
  "InvoiceStatusPending": false,
  "IsPartOfComprehensiveInvoice": false,
  "ComprehensiveInvoiceGroupingMode": 0,
  "HasInvoicingCharge": false,
  "IsFreeDeliveryMonth": false,
  "GoodsAddressNumber": null,
  "VatNumber": null,
  "Dock": null,
  "DeliveryInstruction": null,
  "InvoicePrintoutMethod": null,
  "PrintProformaInvoiceVia": null,
  "EInvoiceExportMode": null,
  "Priority": 0,
  "DirectlyRegistered": false,
  "PartialInvoiceType": null,
  "FormReportConfigurationId": null,
  "DeliveryNoteCreationDate": null,
  "ExcludeFromEdi": false,
  "SellerId": null,
  "ShippingInformationId": null,
  "ProformaNumber": null,
  "ProformaDate": null,
  "DestinationForDeliveryTerm": null,
  "CandidateDebitInvoiceId": null,
  "ConsigneeReferenceName": null,
  "LedgerId": null,
  "BusinessContactOrderId": 0,
  "InvoiceBusinessContactId": 0,
  "AccountGroupId": 0,
  "AccountGroup": null,
  "VatGroupId": 0,
  "PaymentTermId": null,
  "PaymentTerm": null,
  "PaymentTermDescription": null,
  "GracePeriodInDays": null,
  "DeliveryMethodId": null,
  "DeliveryTermId": null,
  "DeliveryTermDescription": null,
  "DeliveryMethodDescription": null,
  "ShipmentPayer": 0,
  "DeliveryRows": null,
  "InvoiceType": 0,
  "EditedOrderAmountExcludingVat": null,
  "EditedOrderAmountExcludingVatCurrencyId": null,
  "EditedOrderAmountDiscount": null,
  "TypeOfOrderAmountEntered": null
}