The Purchase Order object
Properties
id
stringThe Rutter generated unique ID of the purchase order.
platform_id
stringThe platform specific ID of the purchase order.
document_number
stringnullableThe buyer facing document number of the purchase order.
vendor_id
stringnullableThe Rutter ID of the Vendor linked to the purchase order.
vendor_name
stringnullableThe name of the Vendor linked to the purchase order.
posted_date
stringThe ISO 8601 timestamp for when the purchase order was posted.
currency_code
enumnullableThe ISO 4217 currency code of the purchase order.
line_items
arrayAn array of line items containing line items of the purchase order.
line_items
attributesstatus
stringnullableThe status of the purchase order.
total_quantity
stringnullableThe total quantity of items in the purchase order.
total_amount
stringnullableThe total payment amount of the purchase order.
created_at
stringnullableThe ISO 8601 timestamp that the purchase order was created.
updated_at
stringnullableThe ISO 8601 timestamp that the purchase order was last updated.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"document_number": "VENDPO-1",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"vendor_name": "Rutter API",
"posted_date": "2023-01-02T02:34:56.000Z",
"line_items": [
{
"platform_id": "12345678",
"item_id": "00000000-0000-0000-0000-000000000000",
"item_name": "Rutter shirt",
"quantity": "1",
"quantity_received": "1",
"quantity_bill": "1",
"unit_amount": "12.34",
"amount": "12.34",
"amount_received": "12.34",
"amount_billed": "12.34",
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"class_id": "00000000-0000-0000-0000-000000000000"
}
],
"status": "active",
"total_quantity": "1",
"total_amount": "12.34",
"currency_code": "USD",
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
List Purchase Orders
GET /accounting/purchase_ordersRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryThe Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryThe Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.
Response Body
purchase_orders
arraypurchase_orders
attributesnext_cursor
stringnullableoptional{
"purchase_orders": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"document_number": "VENDPO-1",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"vendor_name": "Rutter API",
"posted_date": "2023-01-02T02:34:56.000Z",
"line_items": [
{
"platform_id": "12345678",
"item_id": "00000000-0000-0000-0000-000000000000",
"item_name": "Rutter shirt",
"quantity": "1",
"quantity_received": "1",
"quantity_bill": "1",
"unit_amount": "12.34",
"amount": "12.34",
"amount_received": "12.34",
"amount_billed": "12.34",
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"class_id": "00000000-0000-0000-0000-000000000000"
}
],
"status": "active",
"total_quantity": "1",
"total_amount": "12.34",
"currency_code": "USD",
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Purchase Order
GET /accounting/purchase_orders/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
purchase_order
Purchase Orderpurchase_order
attributes{
"purchase_order": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"document_number": "VENDPO-1",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"vendor_name": "Rutter API",
"posted_date": "2023-01-02T02:34:56.000Z",
"line_items": [
{
"platform_id": "12345678",
"item_id": "00000000-0000-0000-0000-000000000000",
"item_name": "Rutter shirt",
"quantity": "1",
"quantity_received": "1",
"quantity_bill": "1",
"unit_amount": "12.34",
"amount": "12.34",
"amount_received": "12.34",
"amount_billed": "12.34",
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"class_id": "00000000-0000-0000-0000-000000000000"
}
],
"status": "active",
"total_quantity": "1",
"total_amount": "12.34",
"currency_code": "USD",
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}