Accounting

Customers
Get API Keys

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_idstringnullable

The platform specific ID of the customer.

subsidiary_idstringnullable

The Rutter ID of the Subsidiary linked to the customer. This feature is currently only supported on NetSuite.

statusenum
One ofACTIVE, INACTIVE, or UNKNOWN.
contact_namestringnullable

The name of the primary contact of the customer.

currency_codestringnullable

The ISO 4217 currency code of the customer.

customer_namestringnullable

The business name of the customer.

emailstringnullable

The email of the customer.

phonestringnullable

The phone number of the customer.

registration_numberstringnullable

The registration number of the customer

tax_numberstringnullable
addressesarray

An array of addresses linked to the customer.

Show addresses attributes
updated_atstring
platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example AccountingCustomer Object
{
  "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/customers
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    The Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    The Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.

Response Body

    connectionobject
    Show connection attributes
    customersarray
    Show customers attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "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/:id
Supported for: NetSuiteQuickBooksSage IntacctXero

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    connectionobject
    Show connection attributes
    customerobject
    Show customer attributes
Example Response Body
{
  "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/customers
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    customerobject
    Show customer attributes

Response Body

    Any of:

    customerobject
    Show customer attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Response Body
{
  "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"
    }
  }
}
Next
Invoices