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
id
stringRequiredThe Rutter generated unique ID of the vendor.
platform_id
stringRequiredThe platform specific ID of the vendor.
status
enumRequiredThe status of the address.
bank_account_number
stringnullableRequiredThe bank account number of vendor. Only supported for Xero and Sage Business Cloud
contact_name
stringnullableRequiredThe name of the primary contact associated with the vendor.
currency_code
enumnullableRequiredThe ISO 4217 currency code of the vendor.
email
stringnullableRequiredThe email of the primary contact associated with the vendor.
phone
stringnullableRequiredThe phone number of the primary contact associated with the vendor.
registration_number
stringnullableRequiredThe registration number of the vendor
tax_number
stringnullableRequiredThe tax number of the vendor.
vendor_name
stringnullableRequiredThe name of the vendor as it would appear in the platform's listings ("display name").
website
stringnullableRequiredThe website associated with the vendor.
subsidiaries
arrayRequiredAn array of Subsidiaries linked to the vendor. This feature is currently only supported on NetSuite. A subsidiary_id query parameter can be optionally included in GET requests to filter the vendor results.
subsidiaries
attributesaddresses
arrayRequiredAn array of addresses associated with the vendor.
addresses
attributescreated_at
stringnullableRequiredThe ISO 8601 timestamp that the vendor was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the vendor was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the vendor was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Vendors
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe limit on the number of entities returned.
sort
stringqueryThe 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_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
vendor_name
stringqueryThe exact vendor name to filter on. Supported for QuickBooks Desktop only.
Response Body
connection
objectRequiredconnection
attributesvendors
arrayRequiredvendors
attributesnext_cursor
stringnullable- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "vendors": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "status": "active",
12 "bank_account_number": "123456",
13 "contact_name": "Eric Yu",
14 "currency_code": "USD",
15 "email": "eric@rutter.com",
16 "phone": "1234567890",
17 "registration_number": "123456789",
18 "tax_number": "12-3456789",
19 "vendor_name": "Rutter",
20 "website": "https://rutter.com",
21 "subsidiaries": [
22 {
23 "id": "00000000-0000-0000-0000-000000000000",
24 "primary": true
25 },
26 {
27 "id": "00000000-0000-0000-0000-000000000000",
28 "primary": false
29 },
30 {
31 "id": "00000000-0000-0000-0000-000000000000",
32 "primary": false
33 }
34 ],
35 "addresses": [
36 {
37 "type": "billing",
38 "address1": "123 Rutter Road",
39 "address2": "Floor 4",
40 "city": "San Francisco",
41 "country": "US",
42 "postal_code": "94110",
43 "region": "CA"
44 }
45 ],
46 "created_at": "2023-01-02T02:34:56.000Z",
47 "updated_at": "2023-01-02T02:34:56.000Z",
48 "last_synced_at": "2023-01-02T02:34:56.000Z",
49 "platform_data": {
50 "id": 123,
51 "data": "Varies by platform"
52 }
53 }
54 ],
55 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
56}
Fetch a Vendor
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
id_type
enumqueryOptionally, search for a connection by Rutter ID or platform ID. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
Response Body
connection
objectRequiredconnection
attributesvendor
objectRequiredvendor
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "vendor": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "status": "active",
11 "bank_account_number": "123456",
12 "contact_name": "Eric Yu",
13 "currency_code": "USD",
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 },
25 {
26 "id": "00000000-0000-0000-0000-000000000000",
27 "primary": false
28 },
29 {
30 "id": "00000000-0000-0000-0000-000000000000",
31 "primary": false
32 }
33 ],
34 "addresses": [
35 {
36 "type": "billing",
37 "address1": "123 Rutter Road",
38 "address2": "Floor 4",
39 "city": "San Francisco",
40 "country": "US",
41 "postal_code": "94110",
42 "region": "CA"
43 }
44 ],
45 "created_at": "2023-01-02T02:34:56.000Z",
46 "updated_at": "2023-01-02T02:34:56.000Z",
47 "last_synced_at": "2023-01-02T02:34:56.000Z",
48 "platform_data": {
49 "id": 123,
50 "data": "Varies by platform"
51 }
52 }
53}
Create a Vendor
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
vendor
objectRequiredvendor
attributesResponse Body
Any of:
vendor
objectRequiredvendor
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
- Xero
- QuickBooks Desktop
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}
1{
2 "vendor": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "status": "active",
6 "bank_account_number": "123456",
7 "contact_name": "Eric Yu",
8 "currency_code": "USD",
9 "email": "eric@rutter.com",
10 "phone": "1234567890",
11 "registration_number": "123456789",
12 "tax_number": "12-3456789",
13 "vendor_name": "Rutter",
14 "website": "https://rutter.com",
15 "subsidiaries": [
16 {
17 "id": "00000000-0000-0000-0000-000000000000",
18 "primary": true
19 },
20 {
21 "id": "00000000-0000-0000-0000-000000000000",
22 "primary": false
23 },
24 {
25 "id": "00000000-0000-0000-0000-000000000000",
26 "primary": false
27 }
28 ],
29 "addresses": [
30 {
31 "type": "billing",
32 "address1": "123 Rutter Road",
33 "address2": "Floor 4",
34 "city": "San Francisco",
35 "country": "US",
36 "postal_code": "94110",
37 "region": "CA"
38 }
39 ],
40 "created_at": "2023-01-02T02:34:56.000Z",
41 "updated_at": "2023-01-02T02:34:56.000Z",
42 "last_synced_at": "2023-01-02T02:34:56.000Z",
43 "platform_data": {
44 "id": 123,
45 "data": "Varies by platform"
46 }
47 }
48}
Update a Vendor
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
vendor
objectRequiredvendor
attributesResponse Body
Any of:
vendor
objectRequiredvendor
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- QuickBooks
- Netsuite
- QuickBooks Desktop
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 "addresses": [
12 {
13 "type": "billing",
14 "address1": "123 Rutter Road",
15 "address2": "Floor 4",
16 "city": "San Francisco",
17 "country": "US",
18 "postal_code": "94110",
19 "region": "CA"
20 }
21 ]
22 }
23}
1{
2 "vendor": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "status": "active",
6 "bank_account_number": "123456",
7 "contact_name": "Eric Yu",
8 "currency_code": "USD",
9 "email": "eric@rutter.com",
10 "phone": "1234567890",
11 "registration_number": "123456789",
12 "tax_number": "12-3456789",
13 "vendor_name": "Rutter",
14 "website": "https://rutter.com",
15 "subsidiaries": [
16 {
17 "id": "00000000-0000-0000-0000-000000000000",
18 "primary": true
19 },
20 {
21 "id": "00000000-0000-0000-0000-000000000000",
22 "primary": false
23 },
24 {
25 "id": "00000000-0000-0000-0000-000000000000",
26 "primary": false
27 }
28 ],
29 "addresses": [
30 {
31 "type": "billing",
32 "address1": "123 Rutter Road",
33 "address2": "Floor 4",
34 "city": "San Francisco",
35 "country": "US",
36 "postal_code": "94110",
37 "region": "CA"
38 }
39 ],
40 "created_at": "2023-01-02T02:34:56.000Z",
41 "updated_at": "2023-01-02T02:34:56.000Z",
42 "last_synced_at": "2023-01-02T02:34:56.000Z",
43 "platform_data": {
44 "id": 123,
45 "data": "Varies by platform"
46 }
47 }
48}
Have questions?
Contact support for personalized guidance.