Skip to content

Latest commit

 

History

History
56 lines (53 loc) · 38.5 KB

File metadata and controls

56 lines (53 loc) · 38.5 KB

PurchaseOrder

Fields

Field Type Required Description Example
id ?string A unique identifier for an object. 12345
downstreamId ?string The third-party API ID of original entity 12345
displayId ?string Display ID of the purchase order 12345
poNumber ?string A PO Number uniquely identifies a purchase order and is generally defined by the buyer. 90000117
reference ?string Optional purchase order reference. 123456
supplier ?Components\LinkedSupplier The supplier this entity is linked to.
subsidiaryId ?string The ID of the subsidiary 12345
companyId ?string The company ID the transaction belongs to 12345
locationId ?string The ID of the location 12345
departmentId ?string The ID of the department 12345
status ?Components\PurchaseOrderStatus N/A open
issuedDate \DateTime Date purchase order was issued - YYYY-MM-DD. 2020-09-30
deliveryDate \DateTime The date on which the purchase order is to be delivered - YYYY-MM-DD. 2020-09-30
expectedArrivalDate \DateTime The date on which the order is expected to arrive - YYYY-MM-DD. 2020-09-30
currency ?Components\Currency Indicates the associated currency for an amount of money. Values correspond to ISO 4217. USD
currencyRate ?float Currency Exchange Rate at the time entity was recorded/generated. 0.69
subTotal ?float Sub-total amount, normally before tax. 27500
totalTax ?float Total tax amount applied to this invoice. 2500
total ?float Total amount of invoice, including tax. 27500
taxInclusive ?bool Amounts are including tax true
lineItems array<Components\InvoiceLineItem> N/A
billingAddress ?Components\Address N/A
shippingAddress ?Components\Address N/A
ledgerAccount ?Components\LinkedLedgerAccount N/A
templateId ?string Optional purchase order template 123456
discountPercentage ?float Discount percentage applied to this transaction. 5.5
bankAccount ?Components\BankAccount N/A
accountingByRow ?bool Indicates if accounting by row is used (true) or not (false). Accounting by row means that a separate ledger transaction is created for each row. false
dueDate \DateTime The due date is the date on which a payment is scheduled to be received - YYYY-MM-DD. 2020-10-30
paymentMethod ?string Payment method used for the transaction, such as cash, credit card, bank transfer, or check cash
terms ?string Terms of payment. Net 30 days
termsId ?string The ID of the payment terms 12345
amortizationType ?Components\PurchaseOrderAmortizationType Type of amortization
taxCode ?string Applicable tax id/code override if tax is not supplied on a line item basis. 1234
taxMethod ?string Method of tax calculation Due to supplier
issuedMethod ?string Method of issuance of the purchase order Email
issuedEmail ?string Email address of the person who issued the purchase order john.doe@example.com
channel ?string The channel through which the transaction is processed. email
memo ?string Message for the supplier. This text appears on the Purchase Order. Thank you for the partnership and have a great day!
notes ?string Internal notes for the purchase order. This is a test purchase order
trackingCategories array<Components\LinkedTrackingCategory> A list of linked tracking categories.
customMappings array<string, mixed> When custom mappings are configured on the resource, the result is included here.
customFields array<Components\CustomField1|Components\CustomField2> N/A
rowVersion ?string A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. 1-12345
updatedBy ?string The user who last updated the object. 12345
createdBy ?string The user who created the object. 12345
updatedAt \DateTime The date and time when the object was last updated. 2020-09-30T07:43:32.000Z
createdAt \DateTime The date and time when the object was created. 2020-09-30T07:43:32.000Z
passThrough array<Components\PassThroughBody> The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources.