PurchaseOrder

archived
required
boolean

Whether the purchase order has been archived.

createdDate
required
string <date-time>

The date and time the purchase order was created.

object (DistributionStrategies)
expectedDate
string <date-time>

The expected fulfillment date of the purchase order.

externalInvoiceNumber
string or null

The invoice number for the invoice associated with this purchase order.

externalPurchaseOrderNumber
string or null

An optional purchase order number supplied by a Toast user.

id
required
string <uuid>

The unique identifier of the purchase order.

required
Array of objects (PurchaseOrderItem)
modifiedDate
required
string <date-time>

The date and time the purchase order was last modified.

paid
required
boolean

A flag indicating whether the purchase order has been paid.

required
object (PurchaseOrderTotals)
required
object (PurchasingEntityInfo)
receivingNotes
string

Notes that pertain to the receiving of the ordered items.

status
required
string

The status of the purchase order.

Enum: "DRAFT" "ORDERED" "PARTIALLY_RECEIVED" "RECEIVED" "VOIDED"
required
object (Supplier)
supplierNotes
required
string

Notes for the supplier that pertain to ordering.

toastGeneratedPurchaseOrderNumber
required
number <int32>

Toast generated purchase order number.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "archived": true,
  • "status": "DRAFT",
  • "paid": true,
  • "supplier": {
    },
  • "toastGeneratedPurchaseOrderNumber": 0,
  • "externalPurchaseOrderNumber": "string",
  • "externalInvoiceNumber": "string",
  • "items": [
    ],
  • "distributionStrategies": {
    },
  • "purchaseOrderTotals": {
    },
  • "expectedDate": "2019-08-24T14:15:22Z",
  • "purchasingEntityInfo": {
    },
  • "supplierNotes": "string",
  • "receivingNotes": "string"
}