The AccountingCustomer object
A Rutter Customer is an individual or company that buys goods or services from a business. Customers relate to a corresponding invoice for a business. You can retrieve a list of all the customers of a company.
For customers from a commerce platform, see Customers.
Properties
id
stringThe Rutter generated unique ID of the customer.
platform_id
stringnullableThe platform specific ID of the customer.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the customer. This feature is currently only supported on NetSuite.
status
enumcontact_name
stringnullableThe name of the primary contact of the customer.
currency_code
stringnullableThe ISO 4217 currency code of the customer.
customer_name
stringnullableThe business name of the customer.
email
stringnullableThe email of the customer.
phone
stringnullableThe phone number of the customer.
registration_number
stringnullableThe registration number of the customer
tax_number
stringnullableaddresses
arrayAn array of addresses linked to the customer.
addresses
attributesupdated_at
stringplatform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"status": "ACTIVE",
"contact_name": "Eric Yu",
"currency_code": "USD",
"customer_name": "Rutter API",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
List Customers
GET /accounting/customersRequest 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
attributescustomers
arraycustomers
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"customers": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"status": "ACTIVE",
"contact_name": "Eric Yu",
"currency_code": "USD",
"customer_name": "Rutter API",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Customer
GET /accounting/customers/: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
attributescustomer
objectcustomer
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"status": "ACTIVE",
"contact_name": "Eric Yu",
"currency_code": "USD",
"customer_name": "Rutter API",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}
Create a Customer
POST /accounting/customersRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
customer
objectcustomer
attributesResponse Body
Any of:
customer
objectcustomer
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"status": "ACTIVE",
"contact_name": "Eric Yu",
"currency_code": "USD",
"customer_name": "Rutter API",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}
Update a Customer
PATCH /accounting/customers/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
Request Body
customer
objectcustomer
attributesResponse Body
Any of:
customer
objectcustomer
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"status": "ACTIVE",
"contact_name": "Eric Yu",
"currency_code": "USD",
"customer_name": "Rutter API",
"email": "eric@rutter.com",
"phone": "1234567890",
"registration_number": "123456789",
"tax_number": "12-3456789",
"addresses": [
{
"type": "billing",
"address1": "123 Rutter Road",
"address2": "Floor 4",
"city": "San Francisco",
"country": "USA",
"postal_code": "94110",
"region": "CA"
}
],
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}