Purchase Orders

Purchase Orders

A purchase order is a commercial document and the first official offer issued by a buyer to a seller indicating types, quantities, and agreed prices for products or services. Using the Rutter Purchase Orders endpoint, you can get a list of all the purchase orders for a specified business.

FieldTypeDescription
idstringA Rutter designated ID for this purchase order. It always will be in UUID format.
platform_idstringUnique Platform ID for the purchase order.
document_numberstringReference document number for the purchase order.
vendor_idstringUnique ID for the vendor associated with this purchase order.
vendor_namestringName of the vendor to which the purchase order was sent.
line_itemsPurchase Orders Line Item[]An array of purchase order line items.
posted_datestringDate of the purchase order as recorded in the accounting platform in ISO 8601 format.
statusstringCurrent status of a purchase order:
open
closed
total_quantitynumberThe quantity within the purchase order.
total_amountnumberAmount of the purchase order.

Purchase Orders Line Item

FieldTypeDescription
platform_idstringThe platform ID for this purchase order line item.
item_idstringPlatform ID of the product/service for this purchase order line item. Use this value to query a specific item by id from Items endpoint.
item_namestringName of the product/service for this purchase order line item.
quantitynumberThe quantity of the product/service for this purchase order line item.
quantity_receivednumberThe quantity received of the product/service for this purchase order line item.
quantity_billednumberThe quantity billed of the product/service for this purchase order line item.
unit_amountnumberPrice per quantity for this purchase order line item.
line_itemsPurchase Orders Line Item[]An array of purchase order line items within this line item.
amountnumberThe amount for this purchase order line item.
amount_receivednumberThe amount received for this purchase order line item.
amount_billednumberThe amount billed for this purchase order line item.
{
   "id":"b22b2222-2b2b-2bb2-bbb2-bb222bb2b22",
   "platform_id":"1234",
   "purchase_order_id":"1000",
   "document_number":"PO-00-0000",
   "vendor_id":"12345",
   "name":"Rutter Swag",
   "line_items":[
      {
         "id":"b11b1111-1b1b-1bb1-bbb1-bb111bb1b11",
         "platform_id":"4321",
         "name":"Rutter T-shirt",
         "quantity":"300",
         "quantity_received":null,
         "quantity_bill":null,
         "unit_amount":"25",
         "line_items":[],
         "amount":"7500",
         "amount_received":null,
         "amount_billed":null,
         "amount_received_minus_billed":null
      },
      {
         "id":"a11a1111-1a1a-1aa1-aaa1-aa111aa1a11",
         "platform_id":"4433",
         "name":"Rutter Hoodie",
         "quantity":"10",
         "quantity_received":null,
         "quantity_bill":null,
         "unit_amount":"49.4",
         "line_items":[],
         "amount":"494",
         "amount_received":null,
         "amount_billed":null,
         "amount_received_minus_billed":null
      }
   ],
   "posted_date":"2022-01-26T16:00:00.000Z",
   "status":"Open",
   "total_quantity":"310",
   "total_amount":"9774"
}