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

idstring

The Rutter generated unique ID of the customer.

platform_idstring

The platform specific ID of the customer.

parent_idstringnullable

The Rutter ID of the Parent Customer linked to the customer. Supported for QuickBooks and QuickBooks Desktop.

payment_terms_idstringnullable

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

subsidiary_idstringnullable

The Rutter ID of the Subsidiary linked to the customer. Supported for NetSuite.

statusenum

The status of the customer.

One ofactive, archived, or unknown.
contact_namestringnullable

The name of the primary contact of the customer.

currency_codestringnullable

The ISO 4217 currency code of the customer.

customer_namestringfilterablenullable

The business name of the customer.

emailstringfilterablenullable

The email of the customer.

phonestringfilterablenullable

The phone number of the customer.

registration_numberstringnullable

The registration number of the customer.

tax_numberstringnullable

The tax number of the customer.

addressesarray

An array of addresses linked to the customer. For Zoho Books, only customers that were created/updated through Rutter will have the addresses array populated.

Show addresses attributes
created_atstringfilterablenullable

The ISO 8601 timestamp that the customer was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the customer was last updated.

last_synced_atstringfilterable

The ISO 8601 timestamp when the customer 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/customers
GET
/accounting/customers/:id
POST
/accounting/customers
PATCH
/accounting/customers/:id

List Customers

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

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: customer_name, email, phone, updated_at, created_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: customer_name, email, phone, updated_at, created_at, last_synced_at.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    customer_namestringfilterablequeryOptional

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

    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.

    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
  "customers": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "platform_id": "12345678",


6
      "parent_id": "00000000-0000-0000-0000-000000000000",


7
      "payment_terms_id": "00000000-0000-0000-0000-000000000000",


8
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",


9
      "status": "active",


10
      "contact_name": "Eric Yu",


11
      "currency_code": "USD",


12
      "customer_name": "Rutter API",


13
      "email": "eric@rutter.com",


14
      "phone": "1234567890",


15
      "registration_number": "123456789",


16
      "tax_number": "12-3456789",


17
      "addresses": [


18
        {


19
          "type": "billing",


20
          "address1": "123 Rutter Road",


21
          "address2": "Floor 4",


22
          "address3": "Apt 1",


23
          "city": "San Francisco",


24
          "country": "US",


25
          "postal_code": "94110",


26
          "region": "CA"


27
        }


28
      ],


29
      "created_at": "2023-01-02T02:34:56.000Z",


30
      "updated_at": "2023-01-02T02:34:56.000Z",


31
      "last_synced_at": "2023-01-02T02:34:56.000Z",


32
      "platform_url": "https://platform.com/resource?id=123",


33
      "platform_data": {


34
        "id": 123,


35
        "data": "Varies by platform"


36
      }


37
    }


38
  ],


39
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


40
  "connection": {


41
    "id": "00000000-0000-0000-0000-000000000000",


42
    "orgId": "00000000-0000-0000-0000-000000000000",


43
    "platform": "NETSUITE"


44
  }


45
}

Fetch a Customer

GEThttps://production.rutterapi.com/versioned/accounting/customers/: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
  "customer": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "parent_id": "00000000-0000-0000-0000-000000000000",


6
    "payment_terms_id": "00000000-0000-0000-0000-000000000000",


7
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


8
    "status": "active",


9
    "contact_name": "Eric Yu",


10
    "currency_code": "USD",


11
    "customer_name": "Rutter API",


12
    "email": "eric@rutter.com",


13
    "phone": "1234567890",


14
    "registration_number": "123456789",


15
    "tax_number": "12-3456789",


16
    "addresses": [


17
      {


18
        "type": "billing",


19
        "address1": "123 Rutter Road",


20
        "address2": "Floor 4",


21
        "address3": "Apt 1",


22
        "city": "San Francisco",


23
        "country": "US",


24
        "postal_code": "94110",


25
        "region": "CA"


26
      }


27
    ],


28
    "created_at": "2023-01-02T02:34:56.000Z",


29
    "updated_at": "2023-01-02T02:34:56.000Z",


30
    "last_synced_at": "2023-01-02T02:34:56.000Z",


31
    "platform_url": "https://platform.com/resource?id=123",


32
    "platform_data": {


33
      "id": 123,


34
      "data": "Varies by platform"


35
    }


36
  },


37
  "connection": {


38
    "id": "00000000-0000-0000-0000-000000000000",


39
    "orgId": "00000000-0000-0000-0000-000000000000",


40
    "platform": "NETSUITE"


41
  }


42
}

Create a Customer

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

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.
    customerobject
    Show customer attributes

Response Body

Example Request Body
JSON
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
}
200
Example Response Body
JSON
1
{


2
  "customer": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "parent_id": "00000000-0000-0000-0000-000000000000",


6
    "payment_terms_id": "00000000-0000-0000-0000-000000000000",


7
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


8
    "status": "active",


9
    "contact_name": "Eric Yu",


10
    "currency_code": "USD",


11
    "customer_name": "Rutter API",


12
    "email": "eric@rutter.com",


13
    "phone": "1234567890",


14
    "registration_number": "123456789",


15
    "tax_number": "12-3456789",


16
    "addresses": [


17
      {


18
        "type": "billing",


19
        "address1": "123 Rutter Road",


20
        "address2": "Floor 4",


21
        "address3": "Apt 1",


22
        "city": "San Francisco",


23
        "country": "US",


24
        "postal_code": "94110",


25
        "region": "CA"


26
      }


27
    ],


28
    "created_at": "2023-01-02T02:34:56.000Z",


29
    "updated_at": "2023-01-02T02:34:56.000Z",


30
    "last_synced_at": "2023-01-02T02:34:56.000Z",


31
    "platform_url": "https://platform.com/resource?id=123",


32
    "platform_data": {


33
      "id": 123,


34
      "data": "Varies by platform"


35
    }


36
  }


37
}

Update a Customer

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

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    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.
    customerobject
    Show customer attributes

Response Body

200
Example Response Body
JSON
1
{


2
  "customer": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "parent_id": "00000000-0000-0000-0000-000000000000",


6
    "payment_terms_id": "00000000-0000-0000-0000-000000000000",


7
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


8
    "status": "active",


9
    "contact_name": "Eric Yu",


10
    "currency_code": "USD",


11
    "customer_name": "Rutter API",


12
    "email": "eric@rutter.com",


13
    "phone": "1234567890",


14
    "registration_number": "123456789",


15
    "tax_number": "12-3456789",


16
    "addresses": [


17
      {


18
        "type": "billing",


19
        "address1": "123 Rutter Road",


20
        "address2": "Floor 4",


21
        "address3": "Apt 1",


22
        "city": "San Francisco",


23
        "country": "US",


24
        "postal_code": "94110",


25
        "region": "CA"


26
      }


27
    ],


28
    "created_at": "2023-01-02T02:34:56.000Z",


29
    "updated_at": "2023-01-02T02:34:56.000Z",


30
    "last_synced_at": "2023-01-02T02:34:56.000Z",


31
    "platform_url": "https://platform.com/resource?id=123",


32
    "platform_data": {


33
      "id": 123,


34
      "data": "Varies by platform"


35
    }


36
  }


37
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Invoice Attachments