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
stringThe Rutter generated unique ID of the vendor.
platform_id
stringThe platform specific ID of the vendor.
status
enumThe status of the address.
contact_name
stringnullableThe name of the primary contact associated with the vendor.
currency
enumnullableThe ISO 4217 currency code of the vendor.
email
stringnullableThe email of the primary contact associated with the vendor.
phone
stringnullableThe phone number of the primary contact associated with the vendor.
registration_number
stringnullableThe registration number of the vendor
tax_number
stringnullableThe tax number of the vendor.
vendor_name
stringnullableThe name of the vendor.
website
stringnullableThe website associated with the vendor.
subsidiaries
arrayAn 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
arrayAn array of addresses associated with the vendor.
addresses
attributescreated_at
stringThe ISO 8601 timestamp that the vendor was created.
updated_at
stringThe ISO 8601 timestamp that the vendor was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"status": "active",
"contact_name": "Eric Yu",
"currency": "USD",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"vendor_name": "Rutter",
"website": "https://rutter.com",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": true
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
}
],
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"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 Vendors
GET /accounting/vendorsRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributesvendors
arrayvendors
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"vendors": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"status": "active",
"contact_name": "Eric Yu",
"currency": "USD",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"vendor_name": "Rutter",
"website": "https://rutter.com",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": true
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
}
],
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"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 Vendor
GET /accounting/vendors/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributesvendor
objectvendor
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"vendor": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"status": "active",
"contact_name": "Eric Yu",
"currency": "USD",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"vendor_name": "Rutter",
"website": "https://rutter.com",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": true
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
}
],
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"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 Vendor
POST /accounting/vendorsRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
vendor
objectvendor
attributesResponse Body
Any of:
vendor
objectvendor
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"vendor": {
"contact_name": "Eric Yu",
"currency": "USD",
"vendor_name": "Rutter",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"website": "https://rutter.com",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": true
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
}
],
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
]
}
}
{
"vendor": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"status": "active",
"contact_name": "Eric Yu",
"currency": "USD",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"vendor_name": "Rutter",
"website": "https://rutter.com",
"subsidiaries": [
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": true
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
},
{
"id": "00000000-0000-0000-0000-000000000000",
"primary": false
}
],
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}