Purchase Orders

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

idstringRequired

The Rutter generated unique ID of the purchase order.

platform_idstringRequired

The platform specific ID of the purchase order.

subsidiary_idstringnullableRequired

The Rutter ID of the Subsidiary linked to the purchase order. Supported for NetSuite.

vendor_idstringnullableRequired

The Rutter ID of the Vendor linked to the purchase order.

issue_datestringRequired

The ISO 8601 timestamp for the issue date of the purchase order.

statusenumRequired

The status of the purchase order.

One ofopenclosedpending_bill, or unknown.
currency_codeenumnullableRequired

The ISO 4217 currency code of the purchase order.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
document_numberstringnullableRequired

The buyer facing document number of the purchase order.

memostringnullableRequired

The memo of the purchase order.

total_amountnumbernullableRequired

The total payment amount of the purchase order.

total_quantitynumbernullableRequired

The total quantity of items in the purchase order.

line_itemsarrayRequired

An array of line items associated with the purchase order.

Show line_items attributes
created_atstringnullableRequired

The ISO 8601 timestamp that the purchase order was created.

updated_atstringnullableRequired

The ISO 8601 timestamp that the purchase order was last updated.

last_synced_atstringRequired

The ISO 8601 timestamp when the purchase order was last synced by Rutter.

platform_dataobject

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/purchase_orders
GET
/accounting/purchase_orders/:id
POST
/accounting/purchase_orders

List Purchase Orders

GEThttps://production.rutterapi.com/versioned/accounting/purchase_orders

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    last_synced_at_minintegerquery

    Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

    limitintegerquery

    The limit on the number of entities returned.

    sortstringquery

    The field and direction to sort by (ASC or DESC), e.g. last_synced_at ASC. Currently supports the fields: updated_at, last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults, to updated_at DESC.

    updated_at_maxintegerquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegerquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    connectionobjectRequired
    Show connection attributes
    purchase_ordersarrayRequired
    Show purchase_orders attributes
    next_cursorstringnullable
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
Example Response Body
JSON
1
{
2
"connection": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"orgId": "00000000-0000-0000-0000-000000000000",
5
"platform": "NETSUITE"
6
},
7
"purchase_orders": [
8
{
9
"id": "00000000-0000-0000-0000-000000000000",
10
"platform_id": "12345678",
11
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
12
"vendor_id": "00000000-0000-0000-0000-000000000000",
13
"issue_date": "2023-01-02T02:34:56.000Z",
14
"status": "open",
15
"currency_code": "USD",
16
"document_number": "VENDPO-1",
17
"memo": "Example purchase order top-level memo",
18
"total_amount": 12.34,
19
"total_quantity": 1,
20
"line_items": [
21
{
22
"account_id": "00000000-0000-0000-0000-000000000000",
23
"class_id": "00000000-0000-0000-0000-000000000000",
24
"department_id": "00000000-0000-0000-0000-000000000000",
25
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
26
"description": "Example description",
27
"total_amount": 12.34,
28
"item": {
29
"id": "00000000-0000-0000-0000-000000000000",
30
"quantity": 1,
31
"unit_amount": 12.34
32
}
33
}
34
],
35
"created_at": "2023-01-02T02:34:56.000Z",
36
"updated_at": "2023-01-02T02:34:56.000Z",
37
"last_synced_at": "2023-01-02T02:34:56.000Z",
38
"platform_data": {
39
"id": 123,
40
"data": "Varies by platform"
41
}
42
}
43
],
44
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
45
}

Fetch a Purchase Order

GEThttps://production.rutterapi.com/versioned/accounting/purchase_orders/:id

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobjectRequired
    Show connection attributes
    purchase_orderobjectRequired
    Show purchase_order attributes
Support by integration
  • QuickBooks
    QuickBooks
  • Netsuite
    Netsuite
  • Xero
    Xero
Example Response Body
JSON
1
{
2
"connection": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"orgId": "00000000-0000-0000-0000-000000000000",
5
"platform": "NETSUITE"
6
},
7
"purchase_order": {
8
"id": "00000000-0000-0000-0000-000000000000",
9
"platform_id": "12345678",
10
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
11
"vendor_id": "00000000-0000-0000-0000-000000000000",
12
"issue_date": "2023-01-02T02:34:56.000Z",
13
"status": "open",
14
"currency_code": "USD",
15
"document_number": "VENDPO-1",
16
"memo": "Example purchase order top-level memo",
17
"total_amount": 12.34,
18
"total_quantity": 1,
19
"line_items": [
20
{
21
"account_id": "00000000-0000-0000-0000-000000000000",
22
"class_id": "00000000-0000-0000-0000-000000000000",
23
"department_id": "00000000-0000-0000-0000-000000000000",
24
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
25
"description": "Example description",
26
"total_amount": 12.34,
27
"item": {
28
"id": "00000000-0000-0000-0000-000000000000",
29
"quantity": 1,
30
"unit_amount": 12.34
31
}
32
}
33
],
34
"created_at": "2023-01-02T02:34:56.000Z",
35
"updated_at": "2023-01-02T02:34:56.000Z",
36
"last_synced_at": "2023-01-02T02:34:56.000Z",
37
"platform_data": {
38
"id": 123,
39
"data": "Varies by platform"
40
}
41
}
42
}

Create a Purchase Order

POSThttps://production.rutterapi.com/versioned/accounting/purchase_orders

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    purchase_orderobjectRequired
    Show purchase_order attributes

Response Body

    Any of:

    purchase_orderobjectRequired
    Show purchase_order attributes
    async_responseobject
    Show async_response attributes
    errorsarray
    Show errors attributes
Support by integration
  • Netsuite
    Netsuite
Example Request Body
JSON
1
{
2
"purchase_order": {
3
"vendor_id": "00000000-0000-0000-0000-000000000000",
4
"currency": "USD",
5
"line_items": [
6
{
7
"item": "00000000-0000-0000-0000-000000000000",
8
"quantity": 1,
9
"description": "Example description",
10
"unit_amount": 10
11
}
12
]
13
}
14
}
Example Response Body
JSON
1
{
2
"purchase_order": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"platform_id": "12345678",
5
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
6
"vendor_id": "00000000-0000-0000-0000-000000000000",
7
"posted_date": "2023-01-02T02:34:56.000Z",
8
"currency_code": "USD",
9
"document_number": "VENDPO-1",
10
"memo": "For a Rutter shirt.",
11
"status": "active",
12
"vendor_name": "Rutter API",
13
"total_amount": "12.34",
14
"total_quantity": "1",
15
"line_items": [
16
{
17
"platform_id": "12345678",
18
"account_id": "00000000-0000-0000-0000-000000000000",
19
"class_id": "00000000-0000-0000-0000-000000000000",
20
"item_id": "00000000-0000-0000-0000-000000000000",
21
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
22
"description": "Example description",
23
"item_name": "Rutter shirt",
24
"amount": "12.34",
25
"amount_billed": "12.34",
26
"amount_received": "12.34",
27
"quantity": "1",
28
"quantity_bill": "1",
29
"quantity_received": "1",
30
"unit_amount": "12.34"
31
}
32
],
33
"created_at": "2023-01-02T02:34:56.000Z",
34
"updated_at": "2023-01-02T02:34:56.000Z",
35
"last_synced_at": "2023-01-02T02:34:56.000Z",
36
"platform_data": {
37
"id": 123,
38
"data": "Varies by platform"
39
}
40
}
41
}

Have questions?

Contact support for personalized guidance.

Contact support