Sales Orders

The SalesOrder Object

A Rutter Sales Order represents a document generated by a vendor in response to a customer's purchase order or as a result of a direct sales transaction. It outlines the details of a customer's request to purchase specific products or services from the vendor.

Properties

idstring

The Rutter generated unique ID of the sales order.

platform_idstring

The platform specific ID of the sales order.

class_idstringnullable

The Rutter ID of the Class linked to the sales order.

customer_idstringnullable

The Rutter ID of the Customer linked to the sales order.

department_idstringnullable

The Rutter ID of the Department linked to the sales order.

location_idstringnullable

The Rutter ID of the Location linked to the sales order.

subsidiary_idstringnullable

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

issue_datestring

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

statusenum

The status of the sales order.

One ofopen, closed, pending_approval, or unknown.
currency_codeenumnullable

The ISO 4217 currency code of the sales order.

One ofAED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, or ZMW.
currency_ratenumbernullable

The exchange rate between the currency of the sales order and the business default currency.

discount_amountnumbernullable

The discount amount applied to the sales order.

document_numberstringnullable

The buyer facing document number of the sales order.

memostringnullable

The memo of the sales order.

reference_numberstringnullable

The reference number of the sales order.

tax_amountnumbernullable

The tax amount applied to the sales order.

total_amountnumbernullable

The total amount of the sales order.

line_itemsarray

An array of line items associated with the sales order.

Show line_items attributes
created_atstringfilterablenullable

The ISO 8601 timestamp that the sales order was created.

updated_atstringfilterablenullable

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

last_synced_atstringfilterable

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

Endpoints
GET
/accounting/sales_orders
GET
/accounting/sales_orders/:id
POST
/accounting/sales_orders
PATCH
/accounting/sales_orders/:id

List Sales Orders

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Used to specify criteria to filter out the objects returned. Supports all filterable fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    sortstringqueryOptional

    Used to sort the returned objects, e.g. last_synced_at ASC. Supports all filterable fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at and last_synced_at fields are supported. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    sales_ordersarray
    Show sales_orders attributes
    next_cursorstringnullableOptional
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{


2
  "sales_orders": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "platform_id": "12345678",


6
      "class_id": "00000000-0000-0000-0000-000000000000",


7
      "customer_id": "00000000-0000-0000-0000-000000000000",


8
      "department_id": "00000000-0000-0000-0000-000000000000",


9
      "location_id": "00000000-0000-0000-0000-000000000000",


10
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",


11
      "issue_date": "2023-01-02T02:34:56.000Z",


12
      "status": "open",


13
      "currency_code": "USD",


14
      "currency_rate": 1,


15
      "discount_amount": 0,


16
      "document_number": "VENDPO-1",


17
      "memo": "Example sales order top-level memo",


18
      "reference_number": "2",


19
      "tax_amount": 0,


20
      "total_amount": 12.34,


21
      "line_items": [


22
        {


23
          "tax_rate_id": "00000000-0000-0000-0000-000000000000",


24
          "description": "Example description",


25
          "total_amount": 12.34,


26
          "item": {


27
            "id": "00000000-0000-0000-0000-000000000000",


28
            "quantity": 1,


29
            "unit_amount": 12.34


30
          }


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
    }


37
  ],


38
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


39
  "connection": {


40
    "id": "00000000-0000-0000-0000-000000000000",


41
    "orgId": "00000000-0000-0000-0000-000000000000",


42
    "platform": "NETSUITE"


43
  }


44
}

Fetch a Sales Order

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

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    sales_orderobject
    Show sales_order attributes
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{


2
  "sales_order": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "class_id": "00000000-0000-0000-0000-000000000000",


6
    "customer_id": "00000000-0000-0000-0000-000000000000",


7
    "department_id": "00000000-0000-0000-0000-000000000000",


8
    "location_id": "00000000-0000-0000-0000-000000000000",


9
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


10
    "issue_date": "2023-01-02T02:34:56.000Z",


11
    "status": "open",


12
    "currency_code": "USD",


13
    "currency_rate": 1,


14
    "discount_amount": 0,


15
    "document_number": "VENDPO-1",


16
    "memo": "Example sales order top-level memo",


17
    "reference_number": "2",


18
    "tax_amount": 0,


19
    "total_amount": 12.34,


20
    "line_items": [


21
      {


22
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",


23
        "description": "Example description",


24
        "total_amount": 12.34,


25
        "item": {


26
          "id": "00000000-0000-0000-0000-000000000000",


27
          "quantity": 1,


28
          "unit_amount": 12.34


29
        }


30
      }


31
    ],


32
    "created_at": "2023-01-02T02:34:56.000Z",


33
    "updated_at": "2023-01-02T02:34:56.000Z",


34
    "last_synced_at": "2023-01-02T02:34:56.000Z"


35
  },


36
  "connection": {


37
    "id": "00000000-0000-0000-0000-000000000000",


38
    "orgId": "00000000-0000-0000-0000-000000000000",


39
    "platform": "NETSUITE"


40
  }


41
}

Create a Sales Order

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

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    sales_orderobject
    Show sales_order attributes

Response Body

    Any of:

    sales_orderobject
    Show sales_order attributes
    async_responseobjectOptional
    Show async_response attributes
    errorsarrayOptional
    Show errors attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • QuickBooks Desktop
    QuickBooks Desktop
Example Request Body
JSON
1
{


2
  "sales_order": {


3
    "customer_id": "00000000-0000-0000-0000-000000000000",


4
    "issue_date": "2023-01-02T02:34:56.000Z",


5
    "currency_code": "USD",


6
    "line_items": [


7
      {


8
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",


9
        "description": "Example description",


10
        "item": {


11
          "id": "00000000-0000-0000-0000-000000000000",


12
          "quantity": 1,


13
          "unit_amount": 10


14
        }


15
      }


16
    ]


17
  }


18
}
Example Response Body
JSON
1
{


2
  "sales_order": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "class_id": "00000000-0000-0000-0000-000000000000",


6
    "customer_id": "00000000-0000-0000-0000-000000000000",


7
    "department_id": "00000000-0000-0000-0000-000000000000",


8
    "location_id": "00000000-0000-0000-0000-000000000000",


9
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


10
    "issue_date": "2023-01-02T02:34:56.000Z",


11
    "status": "open",


12
    "currency_code": "USD",


13
    "currency_rate": 1,


14
    "discount_amount": 0,


15
    "document_number": "VENDPO-1",


16
    "memo": "Example sales order top-level memo",


17
    "reference_number": "2",


18
    "tax_amount": 0,


19
    "total_amount": 12.34,


20
    "line_items": [


21
      {


22
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",


23
        "description": "Example description",


24
        "total_amount": 12.34,


25
        "item": {


26
          "id": "00000000-0000-0000-0000-000000000000",


27
          "quantity": 1,


28
          "unit_amount": 12.34


29
        }


30
      }


31
    ],


32
    "created_at": "2023-01-02T02:34:56.000Z",


33
    "updated_at": "2023-01-02T02:34:56.000Z",


34
    "last_synced_at": "2023-01-02T02:34:56.000Z"


35
  }


36
}

Update a Sales Order

PATCHhttps://production.rutterapi.com/versioned/accounting/sales_orders/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    sales_orderobject
    Show sales_order attributes

Response Body

    Any of:

    sales_orderobject
    Show sales_order attributes
    async_responseobjectOptional
    Show async_response attributes
    errorsarrayOptional
    Show errors attributes
Support by integration
  • QuickBooks
    QuickBooks
  • QuickBooks Desktop
    QuickBooks Desktop
Example Request Body
JSON
1
{


2
  "sales_order": {


3
    "customer_id": "00000000-0000-0000-0000-000000000000",


4
    "currency_code": "USD",


5
    "line_items": [


6
      {


7
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",


8
        "description": "Example description",


9
        "item": {


10
          "id": "00000000-0000-0000-0000-000000000000",


11
          "quantity": 1,


12
          "unit_amount": 10


13
        }


14
      }


15
    ]


16
  }


17
}
Example Response Body
JSON
1
{


2
  "sales_order": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "class_id": "00000000-0000-0000-0000-000000000000",


6
    "customer_id": "00000000-0000-0000-0000-000000000000",


7
    "department_id": "00000000-0000-0000-0000-000000000000",


8
    "location_id": "00000000-0000-0000-0000-000000000000",


9
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


10
    "issue_date": "2023-01-02T02:34:56.000Z",


11
    "status": "open",


12
    "currency_code": "USD",


13
    "currency_rate": 1,


14
    "discount_amount": 0,


15
    "document_number": "VENDPO-1",


16
    "memo": "Example sales order top-level memo",


17
    "reference_number": "2",


18
    "tax_amount": 0,


19
    "total_amount": 12.34,


20
    "line_items": [


21
      {


22
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",


23
        "description": "Example description",


24
        "total_amount": 12.34,


25
        "item": {


26
          "id": "00000000-0000-0000-0000-000000000000",


27
          "quantity": 1,


28
          "unit_amount": 12.34


29
        }


30
      }


31
    ],


32
    "created_at": "2023-01-02T02:34:56.000Z",


33
    "updated_at": "2023-01-02T02:34:56.000Z",


34
    "last_synced_at": "2023-01-02T02:34:56.000Z"


35
  }


36
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Subsidiaries