The PurchaseOrder object
A Rutter Purchase Order represents a commercial document issued by a vendor to a customer, indicating the types, quantities, and agreed prices for products or services that the customer wishes to purchase. It serves as a formal offer to buy goods or services from a vendor.
Properties
id
stringThe Rutter generated unique ID of the purchase order.
platform_id
stringThe platform specific ID of the purchase order.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the purchase order. This feature is currently only supported on NetSuite.
vendor_id
stringnullableThe Rutter ID of the Vendor linked to the purchase order.
issue_date
stringThe ISO 8601 timestamp for the issue date of the purchase order.
status
enumThe status of the purchase order.
currency_code
enumnullableThe ISO 4217 currency code of the purchase order.
document_number
stringnullableThe buyer facing document number of the purchase order.
memo
stringnullableThe memo of the purchase order.
total_amount
numbernullableThe total payment amount of the purchase order.
total_quantity
numbernullableThe total quantity of items in the purchase order.
line_items
arrayAn array of line items associated with the purchase order.
line_items
attributescreated_at
stringnullableThe ISO 8601 timestamp that the purchase order was created.
updated_at
stringnullableThe ISO 8601 timestamp that the purchase order was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"status": "open",
"currency_code": "USD",
"document_number": "VENDPO-1",
"memo": "Example purchase order top-level memo",
"total_amount": 12.34,
"total_quantity": 1,
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"total_amount": 12.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
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
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributespurchase_orders
arraypurchase_orders
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"purchase_orders": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"status": "open",
"currency_code": "USD",
"document_number": "VENDPO-1",
"memo": "Example purchase order top-level memo",
"total_amount": 12.34,
"total_quantity": 1,
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"total_amount": 12.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Purchase Order
GET /accounting/purchase_orders/:idRequest Parameters
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
connection
objectconnection
attributespurchase_order
objectpurchase_order
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"purchase_order": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"issue_date": "2023-01-02T02:34:56.000Z",
"status": "open",
"currency_code": "USD",
"document_number": "VENDPO-1",
"memo": "Example purchase order top-level memo",
"total_amount": 12.34,
"total_quantity": 1,
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"total_amount": 12.34,
"item": {
"id": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"unit_amount": 12.34
}
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}
Create a Purchase Order
POST /accounting/purchase_ordersRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
purchase_order
objectpurchase_order
attributesResponse Body
Any of:
purchase_order
objectpurchase_order
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"purchase_order": {
"vendor_id": "00000000-0000-0000-0000-000000000000",
"currency": "USD",
"line_items": [
{
"item": "00000000-0000-0000-0000-000000000000",
"quantity": 1,
"description": "Example description",
"unit_amount": 10
}
]
}
}
{
"purchase_order": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"posted_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"document_number": "VENDPO-1",
"memo": "For a Rutter shirt.",
"status": "active",
"vendor_name": "Rutter API",
"total_amount": "12.34",
"total_quantity": "1",
"line_items": [
{
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"item_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
"description": "Example description",
"item_name": "Rutter shirt",
"amount": "12.34",
"amount_billed": "12.34",
"amount_received": "12.34",
"quantity": "1",
"quantity_bill": "1",
"quantity_received": "1",
"unit_amount": "12.34"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}