Accounting

Vendors
Get API Keys

The Vendor object

A Rutter Vendor represents a business or contact that the business entity has purchased from. In some accounting systems, a vendor may be called a Supplier. The vendor object contains contact information as well as shipping and billing addresses.

Properties

idstring

The Rutter generated unique ID of the vendor.

platform_idstring

The platform specific ID of the vendor.

vendor_namestringnullable

The name of the vendor.

contact_namestringnullable

The name of the primary contact associated with the vendor.

emailstringnullable

The email of the primary contact associated with the vendor.

websitestringnullable

The website associated with the vendor.

phonestringnullable

The phone number of the primary contact associated with the vendor.

addressesarray

An array of addresses associated with the vendor.

Show addresses attributes
registration_numberstringnullable

The registration number of the vendor

tax_numberstringnullable

The tax number of the vendor.

statusenum

The status of the address.

One ofactive, archived, or unknown.
created_atstring

The ISO 8601 timestamp that the vendor was created.

updated_atstring

The ISO 8601 timestamp that the vendor was last updated.

platform_dataoptional

The raw platform data corresponding to the Rutter object.

currencyenumnullable

The ISO 4217 currency code of the vendor.

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, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, 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.
Example Vendor Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "vendor_name": "Rutter",
  "contact_name": "Eric Yu",
  "email": "eric@rutter.com",
  "website": "https://rutter.com",
  "currency": "USD",
  "phone": "1234567890",
  "addresses": [
    {
      "type": "billing",
      "address1": "123 Rutter Road",
      "address2": "Floor 4",
      "city": "San Francisco",
      "region": "CA",
      "country": "USA",
      "postal_code": "94110"
    }
  ],
  "registration_number": "123456789",
  "tax_number": "12-3456789",
  "status": "active",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Vendors

GET /accounting/vendors
Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

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

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

    updated_at_minintegeroptionalquery

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

Response Body

    connectionConnection
    Show connection attributes
    vendorsarray
    Show vendors attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "vendors": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "vendor_name": "Rutter",
      "contact_name": "Eric Yu",
      "email": "eric@rutter.com",
      "website": "https://rutter.com",
      "currency": "USD",
      "phone": "1234567890",
      "addresses": [
        {
          "type": "billing",
          "address1": "123 Rutter Road",
          "address2": "Floor 4",
          "city": "San Francisco",
          "region": "CA",
          "country": "USA",
          "postal_code": "94110"
        }
      ],
      "registration_number": "123456789",
      "tax_number": "12-3456789",
      "status": "active",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }
}

Fetch a Vendor

GET /accounting/vendors/:id
Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    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

    connectionConnection
    Show connection attributes
    vendorVendor
    Show vendor attributes
Example Response Body
{
  "vendor": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "vendor_name": "Rutter",
    "contact_name": "Eric Yu",
    "email": "eric@rutter.com",
    "website": "https://rutter.com",
    "currency": "USD",
    "phone": "1234567890",
    "addresses": [
      {
        "type": "billing",
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "region": "CA",
        "country": "USA",
        "postal_code": "94110"
      }
    ],
    "registration_number": "123456789",
    "tax_number": "12-3456789",
    "status": "active",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }
}

Create a Vendor

POST /accounting/vendors
Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    vendorobject
    Show vendor attributes

Response Body

    Any of:

    Vendor Response

    vendorVendor
    Show vendor attributes

    Async Response Payload

    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "vendor": {
    "vendor_name": "Rutter",
    "contact_name": "Eric Yu",
    "email": "eric@rutter.com",
    "website": "https://rutter.com",
    "currency": "USD",
    "phone": "1234567890",
    "addresses": [
      {
        "type": "billing",
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "region": "CA",
        "country": "USA",
        "postal_code": "94110"
      }
    ],
    "registration_number": "123456789",
    "tax_number": "12-3456789"
  }
}
Example Response Body
{
  "vendor": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "vendor_name": "Rutter",
    "contact_name": "Eric Yu",
    "email": "eric@rutter.com",
    "website": "https://rutter.com",
    "currency": "USD",
    "phone": "1234567890",
    "addresses": [
      {
        "type": "billing",
        "address1": "123 Rutter Road",
        "address2": "Floor 4",
        "city": "San Francisco",
        "region": "CA",
        "country": "USA",
        "postal_code": "94110"
      }
    ],
    "registration_number": "123456789",
    "tax_number": "12-3456789",
    "status": "active",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}
Previous
Accounts
Next
Classes