Vendors

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.

payment_terms_idstringnullable

The Rutter ID of the Payment Terms linked to the vendor. Supported for NetSuite.

statusenum

The status of the vendor.

One ofactive, archived, or unknown.

bank_account_numberstringnullable

The bank account number of vendor. Supported for Sage Business Cloud and Xero.

contact_namestringnullable

The name of the primary contact associated with the vendor.

currency_codesarray

An array of ISO 4217 currency codes of the vendor.

One or more 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, ZMW, ETH, or BTC.

display_namestringnullable

The unique display name of the vendor. Supported for QuickBooks and Xero.

emailstringnullable

The email of the primary contact associated with the vendor.

phonestringnullable

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

registration_numberstringnullable

The registration number of the vendor

tax_numberstringnullable

The tax number of the vendor.

vendor_namestringfilterablenullable

The name of the vendor as it would appear on the platform. This field is not guaranteed to be unique in value.

websitestringnullable

The website associated with the vendor.

subsidiariesarray

An array of Subsidiaries linked to the vendor. Supported for NetSuite.

Show subsidiaries attributes

addressesarray

An array of addresses associated with the vendor.

Show addresses attributes

created_atstringfilterablenullable

The ISO 8601 timestamp that the vendor was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the vendor was last updated.

last_synced_atstringfilterable

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

platform_urlstringnullable

A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/accounting/vendors

GET

/accounting/vendors/:id

POST

/accounting/vendors

PATCH

/accounting/vendors/:id

List Vendors

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

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

Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.

Filterable fields: vendor_name, created_at, updated_at, last_synced_at.

sortstringqueryOptional

Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Sage Business Cloud. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

Sortable fields: vendor_name, created_at, updated_at, last_synced_at.

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.

vendor_namestringfilterablequeryOptional

Deprecated - use filter instead. The exact vendor name to filter on. Not currently supported on Sage Intacct or Sage Business Cloud.

force_fetchenumqueryOptional

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

One oftrue or false.

Response Body

200

Example Response Body

JSON

1{
2  "vendors": [
3    {
4      "id": "00000000-0000-0000-0000-000000000000",
5      "platform_id": "12345678",
6      "payment_terms_id": "00000000-0000-0000-0000-000000000000",
7      "status": "active",
8      "bank_account_number": "123456",
9      "contact_name": "Eric Yu",
10      "currency_codes": [
11        "USD"
12      ],
13      "display_name": "Rutter Inc.",
14      "email": "eric@rutter.com",
15      "phone": "1234567890",
16      "registration_number": "123456789",
17      "tax_number": "12-3456789",
18      "vendor_name": "Rutter",
19      "website": "https://rutter.com",
20      "subsidiaries": [
21        {
22          "id": "00000000-0000-0000-0000-000000000000",
23          "primary": true,
24          "status": "active"
25        },
26        {
27          "id": "00000000-0000-0000-0000-000000000000",
28          "primary": false,
29          "status": "active"
30        },
31        {
32          "id": "00000000-0000-0000-0000-000000000000",
33          "primary": false,
34          "status": "inactive"
35        }
36      ],
37      "addresses": [
38        {
39          "type": "billing",
40          "address1": "123 Rutter Road",
41          "address2": "Floor 4",
42          "address3": null,
43          "city": "San Francisco",
44          "country": "US",
45          "postal_code": "94110",
46          "region": "CA"
47        }
48      ],
49      "created_at": "2023-01-02T02:34:56.000Z",
50      "updated_at": "2023-01-02T02:34:56.000Z",
51      "last_synced_at": "2023-01-02T02:34:56.000Z",
52      "platform_url": "https://platform.com/resource?id=123",
53      "platform_data": {
54        "id": 123,
55        "data": "Varies by platform"
56      }
57    }
58  ],
59  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
60  "connection": {
61    "id": "00000000-0000-0000-0000-000000000000",
62    "orgId": "00000000-0000-0000-0000-000000000000",
63    "platform": "NETSUITE"
64  }
65}

Support by integration

Expand to view platform rules

Xero
QuickBooks Desktop
NetSuite

Fetch a Vendor

GEThttps://production.rutterapi.com/versioned/accounting/vendors/: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 currently supported on Sage Intacct or Sage Business Cloud.

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

200

Example Response Body

JSON

1{
2  "vendor": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "payment_terms_id": "00000000-0000-0000-0000-000000000000",
6    "status": "active",
7    "bank_account_number": "123456",
8    "contact_name": "Eric Yu",
9    "currency_codes": [
10      "USD"
11    ],
12    "display_name": "Rutter Inc.",
13    "email": "eric@rutter.com",
14    "phone": "1234567890",
15    "registration_number": "123456789",
16    "tax_number": "12-3456789",
17    "vendor_name": "Rutter",
18    "website": "https://rutter.com",
19    "subsidiaries": [
20      {
21        "id": "00000000-0000-0000-0000-000000000000",
22        "primary": true,
23        "status": "active"
24      },
25      {
26        "id": "00000000-0000-0000-0000-000000000000",
27        "primary": false,
28        "status": "active"
29      },
30      {
31        "id": "00000000-0000-0000-0000-000000000000",
32        "primary": false,
33        "status": "inactive"
34      }
35    ],
36    "addresses": [
37      {
38        "type": "billing",
39        "address1": "123 Rutter Road",
40        "address2": "Floor 4",
41        "address3": null,
42        "city": "San Francisco",
43        "country": "US",
44        "postal_code": "94110",
45        "region": "CA"
46      }
47    ],
48    "created_at": "2023-01-02T02:34:56.000Z",
49    "updated_at": "2023-01-02T02:34:56.000Z",
50    "last_synced_at": "2023-01-02T02:34:56.000Z",
51    "platform_url": "https://platform.com/resource?id=123",
52    "platform_data": {
53      "id": 123,
54      "data": "Varies by platform"
55    }
56  },
57  "connection": {
58    "id": "00000000-0000-0000-0000-000000000000",
59    "orgId": "00000000-0000-0000-0000-000000000000",
60    "platform": "NETSUITE"
61  }
62}

Support by integration

Expand to view platform rules

Xero
QuickBooks Desktop
NetSuite

Create a Vendor

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

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

One ofasync or prefer_sync.

vendorobject

Show vendor attributes

Response Body

Example Request Body

JSON

1{
2  "vendor": {
3    "contact_name": "Eric Yu",
4    "currency_code": "USD",
5    "vendor_name": "Rutter",
6    "email": "eric@rutter.com",
7    "phone": "1234567890",
8    "registration_number": "123456789",
9    "tax_number": "12-3456789",
10    "website": "https://rutter.com",
11    "subsidiaries": [
12      {
13        "id": "00000000-0000-0000-0000-000000000000",
14        "primary": true
15      },
16      {
17        "id": "00000000-0000-0000-0000-000000000000",
18        "primary": false
19      },
20      {
21        "id": "00000000-0000-0000-0000-000000000000",
22        "primary": false
23      }
24    ],
25    "addresses": [
26      {
27        "type": "billing",
28        "address1": "123 Rutter Road",
29        "address2": "Floor 4",
30        "city": "San Francisco",
31        "country": "US",
32        "postal_code": "94110",
33        "region": "CA"
34      }
35    ]
36  }
37}

200

Example Response Body

JSON

1{
2  "vendor": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "payment_terms_id": "00000000-0000-0000-0000-000000000000",
6    "status": "active",
7    "bank_account_number": "123456",
8    "contact_name": "Eric Yu",
9    "currency_codes": [
10      "USD"
11    ],
12    "display_name": "Rutter Inc.",
13    "email": "eric@rutter.com",
14    "phone": "1234567890",
15    "registration_number": "123456789",
16    "tax_number": "12-3456789",
17    "vendor_name": "Rutter",
18    "website": "https://rutter.com",
19    "subsidiaries": [
20      {
21        "id": "00000000-0000-0000-0000-000000000000",
22        "primary": true,
23        "status": "active"
24      },
25      {
26        "id": "00000000-0000-0000-0000-000000000000",
27        "primary": false,
28        "status": "active"
29      },
30      {
31        "id": "00000000-0000-0000-0000-000000000000",
32        "primary": false,
33        "status": "inactive"
34      }
35    ],
36    "addresses": [
37      {
38        "type": "billing",
39        "address1": "123 Rutter Road",
40        "address2": "Floor 4",
41        "address3": null,
42        "city": "San Francisco",
43        "country": "US",
44        "postal_code": "94110",
45        "region": "CA"
46      }
47    ],
48    "created_at": "2023-01-02T02:34:56.000Z",
49    "updated_at": "2023-01-02T02:34:56.000Z",
50    "last_synced_at": "2023-01-02T02:34:56.000Z",
51    "platform_url": "https://platform.com/resource?id=123",
52    "platform_data": {
53      "id": 123,
54      "data": "Varies by platform"
55    }
56  }
57}

Update a Vendor

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

Request Parameters

idstringpathRequired

The Rutter generated unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

Request Body

response_modeenumOptional

One ofasync or prefer_sync.

vendorobject

Show vendor attributes

Response Body

Example Request Body

JSON

1{
2  "vendor": {
3    "contact_name": "Eric Yu",
4    "currency_code": "USD",
5    "email": "eric@rutter.com",
6    "phone": "1234567890",
7    "registration_number": "123456789",
8    "tax_number": "12-3456789",
9    "vendor_name": "Rutter",
10    "website": "https://rutter.comTTTTTTTTTTTTTTT",
11    "subsidiaries": [
12      {
13        "id": "00000000-0000-0000-0000-000000000000",
14        "primary": true
15      },
16      {
17        "id": "00000000-0000-0000-0000-000000000000",
18        "primary": false
19      },
20      {
21        "id": "00000000-0000-0000-0000-000000000000",
22        "primary": false
23      }
24    ],
25    "addresses": [
26      {
27        "type": "billing",
28        "address1": "123 Rutter Road",
29        "address2": "Floor 4",
30        "city": "San Francisco",
31        "country": "US",
32        "postal_code": "94110",
33        "region": "CA"
34      }
35    ]
36  }
37}

200

Example Response Body

JSON

1{
2  "vendor": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "payment_terms_id": "00000000-0000-0000-0000-000000000000",
6    "status": "active",
7    "bank_account_number": "123456",
8    "contact_name": "Eric Yu",
9    "currency_codes": [
10      "USD"
11    ],
12    "display_name": "Rutter Inc.",
13    "email": "eric@rutter.com",
14    "phone": "1234567890",
15    "registration_number": "123456789",
16    "tax_number": "12-3456789",
17    "vendor_name": "Rutter",
18    "website": "https://rutter.com",
19    "subsidiaries": [
20      {
21        "id": "00000000-0000-0000-0000-000000000000",
22        "primary": true,
23        "status": "active"
24      },
25      {
26        "id": "00000000-0000-0000-0000-000000000000",
27        "primary": false,
28        "status": "active"
29      },
30      {
31        "id": "00000000-0000-0000-0000-000000000000",
32        "primary": false,
33        "status": "inactive"
34      }
35    ],
36    "addresses": [
37      {
38        "type": "billing",
39        "address1": "123 Rutter Road",
40        "address2": "Floor 4",
41        "address3": null,
42        "city": "San Francisco",
43        "country": "US",
44        "postal_code": "94110",
45        "region": "CA"
46      }
47    ],
48    "created_at": "2023-01-02T02:34:56.000Z",
49    "updated_at": "2023-01-02T02:34:56.000Z",
50    "last_synced_at": "2023-01-02T02:34:56.000Z",
51    "platform_url": "https://platform.com/resource?id=123",
52    "platform_data": {
53      "id": 123,
54      "data": "Varies by platform"
55    }
56  }
57}

Have questions?

Contact support for personalized guidance.

Contact support