Customers
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.
parent_id
stringnullableOptionalThe Rutter ID of the Parent Customer linked to the customer. Supported for QuickBooks.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the customer. Supported for NetSuite.
status
enumThe status of the customer.
contact_name
stringnullableThe name of the primary contact of the customer.
currency_code
stringnullableThe ISO 4217 currency code of the customer.
customer_name
stringfilterablenullableThe business name of the customer.
email
stringfilterablenullableThe email of the customer.
phone
stringfilterablenullableThe phone number of the customer.
registration_number
stringnullableThe registration number of the customer.
tax_number
stringnullableThe tax number of the customer.
addresses
arrayAn array of addresses linked to the customer.
addresses
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the customer was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the customer was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the customer was last synced by Rutter.
platform_url
stringnullableA 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_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Customers
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
filter
stringqueryOptionalUsed to specify criteria to filter out the objects returned. Supports all filterable
fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
sort
stringqueryOptionalUsed to sort the returned objects, e.g. last_synced_at ASC
. Supports all filterable
fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at
and last_synced_at
fields are supported. If a value is provided but ASC
or DESC
is not, defaults to ASC
. If omitted, defaults to updated_at DESC
.
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
customer_name
stringqueryOptionalDeprecated - use filter
instead. The exact customer name to filter on. Not supported on Sage Intacct, or Dynamics 365.
last_synced_at_min
integerqueryOptionalDeprecated - 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_max
integerqueryOptionalDeprecated - 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_min
integerqueryOptionalDeprecated - 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.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
customers
arraycustomers
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "customers": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
7 "status": "ACTIVE",
8 "contact_name": "Eric Yu",
9 "currency_code": "USD",
10 "customer_name": "Rutter API",
11 "email": "eric@rutter.com",
12 "phone": "1234567890",
13 "registration_number": "123456789",
14 "tax_number": "12-3456789",
15 "addresses": [
16 {
17 "type": "billing",
18 "address1": "123 Rutter Road",
19 "address2": "Floor 4",
20 "city": "San Francisco",
21 "country": "US",
22 "postal_code": "94110",
23 "region": "CA"
24 }
25 ],
26 "created_at": "2023-01-02T02:34:56.000Z",
27 "updated_at": "2023-01-02T02:34:56.000Z",
28 "last_synced_at": "2023-01-02T02:34:56.000Z",
29 "platform_url": "https://platform.com/resource?id=123",
30 "platform_data": {
31 "id": 123,
32 "data": "Varies by platform"
33 }
34 }
35 ],
36 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
37 "connection": {
38 "id": "00000000-0000-0000-0000-000000000000",
39 "orgId": "00000000-0000-0000-0000-000000000000",
40 "platform": "NETSUITE"
41 }
42}
Fetch a Customer
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
customer
objectcustomer
attributesconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "customer": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
6 "status": "ACTIVE",
7 "contact_name": "Eric Yu",
8 "currency_code": "USD",
9 "customer_name": "Rutter API",
10 "email": "eric@rutter.com",
11 "phone": "1234567890",
12 "registration_number": "123456789",
13 "tax_number": "12-3456789",
14 "addresses": [
15 {
16 "type": "billing",
17 "address1": "123 Rutter Road",
18 "address2": "Floor 4",
19 "city": "San Francisco",
20 "country": "US",
21 "postal_code": "94110",
22 "region": "CA"
23 }
24 ],
25 "created_at": "2023-01-02T02:34:56.000Z",
26 "updated_at": "2023-01-02T02:34:56.000Z",
27 "last_synced_at": "2023-01-02T02:34:56.000Z",
28 "platform_url": "https://platform.com/resource?id=123",
29 "platform_data": {
30 "id": 123,
31 "data": "Varies by platform"
32 }
33 },
34 "connection": {
35 "id": "00000000-0000-0000-0000-000000000000",
36 "orgId": "00000000-0000-0000-0000-000000000000",
37 "platform": "NETSUITE"
38 }
39}
Create a Customer
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
customer
objectcustomer
attributesResponse Body
Any of:
customer
objectcustomer
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "customer": {
3 "contact_name": "Eric Yu",
4 "customer_name": "Rutter",
5 "email": "eric@rutter.com",
6 "phone": "1234567890",
7 "addresses": [
8 {
9 "type": "billing",
10 "address1": "123 Rutter Road",
11 "address2": "Floor 4",
12 "city": "San Francisco",
13 "country": "US",
14 "postal_code": "94110",
15 "region": "CA"
16 }
17 ]
18 }
19}
1{
2 "customer": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
6 "status": "ACTIVE",
7 "contact_name": "Eric Yu",
8 "currency_code": "USD",
9 "customer_name": "Rutter API",
10 "email": "eric@rutter.com",
11 "phone": "1234567890",
12 "registration_number": "123456789",
13 "tax_number": "12-3456789",
14 "addresses": [
15 {
16 "type": "billing",
17 "address1": "123 Rutter Road",
18 "address2": "Floor 4",
19 "city": "San Francisco",
20 "country": "US",
21 "postal_code": "94110",
22 "region": "CA"
23 }
24 ],
25 "created_at": "2023-01-02T02:34:56.000Z",
26 "updated_at": "2023-01-02T02:34:56.000Z",
27 "last_synced_at": "2023-01-02T02:34:56.000Z",
28 "platform_url": "https://platform.com/resource?id=123",
29 "platform_data": {
30 "id": 123,
31 "data": "Varies by platform"
32 }
33 }
34}
Update a Customer
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
Request Body
customer
objectcustomer
attributesResponse Body
Any of:
customer
objectcustomer
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- Xero
- QuickBooks Desktop
- FreshBooks
1{
2 "customer": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
6 "status": "ACTIVE",
7 "contact_name": "Eric Yu",
8 "currency_code": "USD",
9 "customer_name": "Rutter API",
10 "email": "eric@rutter.com",
11 "phone": "1234567890",
12 "registration_number": "123456789",
13 "tax_number": "12-3456789",
14 "addresses": [
15 {
16 "type": "billing",
17 "address1": "123 Rutter Road",
18 "address2": "Floor 4",
19 "city": "San Francisco",
20 "country": "US",
21 "postal_code": "94110",
22 "region": "CA"
23 }
24 ],
25 "created_at": "2023-01-02T02:34:56.000Z",
26 "updated_at": "2023-01-02T02:34:56.000Z",
27 "last_synced_at": "2023-01-02T02:34:56.000Z",
28 "platform_url": "https://platform.com/resource?id=123",
29 "platform_data": {
30 "id": 123,
31 "data": "Varies by platform"
32 }
33 }
34}
Have questions?
Contact support for personalized guidance.