PurchaseOrders

Queryable, Introduced in version 2.26

GET https://localhost:8001/sv/001.1/api/v1/Purchase/PurchaseOrders

Represents a purchase order.

GUID

3A8DD78D-902D-4E50-8DE6-C0AEE4CE582E

Required permission

Show purchase orders

Properties

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

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

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

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

References DeliveryMethods
DeliveryMethod DeliveryMethods The purchase order's delivery method.

  • Expandable
 Introduced in version 2.30
DeliveryTermId Int64? The business key identifier of the purchase order's delivery term.

References DeliveryTerms
DeliveryTerm DeliveryTerms The purchase order's delivery term.

  • Expandable
 Introduced in version 2.30
DeliveryTermDescription String The delivery term description of the purchase order.

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

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

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

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

Reference Persons
OurReference Persons Our reference for the purchase order.

  • Expandable
 Introduced in version 2.30
OurReferenceName String The name of our reference for the purchase order.

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

References BusinessContactReferences
BusinessContactReference BusinessContactReferences The supplier's reference for the purchase order.

  • Expandable
 Introduced in version 2.30
BusinessContactReferenceName String The name of the supplier's reference for the purchase order.

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

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

References
Currency Currencies The currency for the purchase order.

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

References
VatGroup VatGroups The VAT group that applies for the purchase order.

  • Expandable
 Introduced in version 2.30
WarehouseId Int64 The business key identifier of the warehouse that the purchase order belongs to.

References
Warehouse Warehouses The warehouse that the purchase order belongs to.

  • Expandable
 Introduced in version 2.30
Priority Int32 The priority of the purchase order.
ProjectId Int64? The business key identifier of the purchase order's project.

References Project
SendMethod Int32 Specifies the printout method for the purchase 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 purchase order's internal comment.

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

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

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

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

  • Transient: 1
  • Persistent: 10
  • History: 20
  • RemovableCandidate: 99
Version Int32 The version of the purchase order.
UseForwardRate Boolean Specifies if forward rate should apply for the purchase order.
ExchangeRate Decimal Specifies the exchange rate to use for the purchase 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)
AgentSupplierId Int64? The business key identifier of the agent that the purchase order
belongs to.

References Suppliers
SuppliersQuoteNumber String The readable supplier's quote number.

  • Max length is 30
IsStockOrder Boolean Specifies if the purchase order is a Stock order.
IsConfirmed Boolean Specifies if the order is Confirmed.
CustomerOrderId Int64? The business key identifier of the customer order.

References CustomerOrders
OrderNumber String The human readable identifier of the purchase order.

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

  • Expandable
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 purchase order delivery address.

  • CurrentCustomer: 0
  • Customer: 1
  • Supplier: 2
  • Company: 3
  • CurrentSupplier: 4
DeliveryAddressId Int64? The business key identifier of the purchase order's delivery address.

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

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

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

  • Expandable
GoodsAddressNumber String The goods address number of the purchase order.

  • Max length is 80
FromInquiryNumber String The human readable identifier of the inquiry that resulted in
the purchase order.

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

  • PendingAuthorization: 0
  • Registered: 1
  • PurchaseOrderPrinted: 2
  • PartiallyDelivered: 5
  • Declined: 8
  • History: 9
InquiryId Int64? The business key identifier of the purchase order's inquiry.

References Inquiry
 Introduced in version 2.30
PackingTermId Int64? The business key identifier of the purchase order's packing term.

References
Introduced in version 2.30
PackingTerm PackingTerms The packing term of the purchase order.

  • Expandable
 Introduced in version 2.30
PackingTermDescription String The packing term description of the purchase order.

  • Max length is 35
 Introduced in version 2.30
ShowPriceInFormReport Boolean Specifies if the purchase order shows price in form report.
 Introduced in version 2.30
ShowTotalInFormReport Boolean Specifies if the purchase order shows total in form report.
 Introduced in version 2.30
IsCredit Boolean Specifies if the purchase order is a credit order.
 Introduced in version 2.30
CausingCreditPurchaseOrderId Int64? The business key identifier of the purchase order which caused this credit purchase order to be created.

References PurchaseOrders
 Introduced in version 2.30
BusinessContactId Int64 The business key identifier of the purchase order's supplier.

References Suppliers
 Introduced in version 2.30
InvoiceBusinessContactId Int64 The business key identifier of the purchase order's supplier sending the invoice.

References Suppliers
 Introduced in version 2.30
OrderTypeId Int64 The business key identifier of the purchase order's type.

References PurchaseOrderTypes
 Introduced in version 2.30
OrderType PurchaseOrderTypes The order type of the purchase order.

  • Expandable
 Introduced in version 2.30
AccountGroupId Int64 The business key identifier of the purchase order's account group.

References SupplierAccountGroups
 Introduced in version 2.30
AccountGroup SupplierAccountGroups The account group of the purchase order.

  • Expandable
 Introduced in version 2.30
CategoryString String The category string of the purchase order.

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

 Introduced in version 22.9
DestinationForDeliveryTerm String The destination for the delivery term.

  • Max length is 35
 Introduced in version 23.9
CommunicationAddresses CommunicationAddresses[] The communication addresses of the purchase order.

  • Expandable
 Introduced in version 24.3

Example

{
  "Id": 0,
  "PaymentTermId": null,
  "PaymentTerm": null,
  "PaymentTermDescription": null,
  "GracePeriodInDays": null,
  "DeliveryMethodId": null,
  "DeliveryMethod": null,
  "DeliveryTermId": null,
  "DeliveryTerm": null,
  "DeliveryTermDescription": null,
  "DeliveryMethodDescription": null,
  "ShipmentPayer": 0,
  "BusinessContactOrderNumber": null,
  "OurReferenceId": null,
  "OurReference": null,
  "OurReferenceName": null,
  "BusinessContactReferenceId": null,
  "BusinessContactReference": null,
  "BusinessContactReferenceName": null,
  "GoodsLabel": null,
  "CurrencyId": 0,
  "Currency": null,
  "VatGroupId": 0,
  "VatGroup": null,
  "WarehouseId": 0,
  "Warehouse": null,
  "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,
  "AgentSupplierId": null,
  "SuppliersQuoteNumber": null,
  "IsStockOrder": false,
  "IsConfirmed": false,
  "CustomerOrderId": null,
  "OrderNumber": null,
  "OrderDate": "0001-01-01T00:00:00+00:00",
  "Rows": null,
  "ActiveDeliveryAddressCustomerId": null,
  "ActiveDeliveryAddressSupplierId": null,
  "ActiveDeliveryAddressCompanyId": null,
  "SourceOfAlternativeDeliveryAddresses": 0,
  "DeliveryAddressId": null,
  "DeliveryAddress": null,
  "MailingAddressId": null,
  "MailingAddress": null,
  "GoodsAddressNumber": null,
  "FromInquiryNumber": null,
  "Status": 0,
  "InquiryId": null,
  "PackingTermId": null,
  "PackingTerm": null,
  "PackingTermDescription": null,
  "ShowPriceInFormReport": false,
  "ShowTotalInFormReport": false,
  "IsCredit": false,
  "CausingCreditPurchaseOrderId": null,
  "BusinessContactId": 0,
  "InvoiceBusinessContactId": 0,
  "OrderTypeId": 0,
  "OrderType": null,
  "AccountGroupId": 0,
  "AccountGroup": null,
  "CategoryString": null,
  "CurrencyExchangeTypeId": 0,
  "DestinationForDeliveryTerm": null,
  "CommunicationAddresses": null
}