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

idstring

The Rutter generated unique ID of the purchase order.

platform_idstring

The platform specific ID of the purchase order.

subsidiary_idstringnullable

The Rutter ID of the Subsidiary linked to the purchase order. This feature is currently only supported on NetSuite.

vendor_idstringnullable

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

issue_datestring

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

statusenum

The status of the purchase order.

One ofopenclosedpending_bill, or unknown.
currency_codeenumnullable

The ISO 4217 currency code of the purchase order.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
document_numberstringnullable

The buyer facing document number of the purchase order.

memostringnullable

The memo of the purchase order.

total_amountnumbernullable

The total payment amount of the purchase order.

total_quantitynumbernullable

The total quantity of items in the purchase order.

line_itemsarray

An array of line items associated with the purchase order.

Show line_items attributes
created_atstringnullable

The ISO 8601 timestamp that the purchase order was created.

updated_atstringnullable

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

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example PurchaseOrder Object
{
  "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_orders
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

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

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

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

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

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

    updated_at_minintegeroptionalquery

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

Response Body

    connectionobject
    Show connection attributes
    purchase_ordersarray
    Show purchase_orders attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "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/:id
Supported for: NetSuiteQuickBooksXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

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

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    purchase_orderobject
    Show purchase_order attributes
Example Response Body
{
  "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_orders
Supported for: NetSuite

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    purchase_orderobject
    Show purchase_order attributes

Response Body

    Any of:

    purchase_orderobject
    Show purchase_order attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "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
      }
    ]
  }
}
Example Response Body
{
  "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"
    }
  }
}