Accounting Transactions

The AccountingTransaction Object

This endpoint fetchs information about all transactions on the underlying platform, regardless of transaction type. As the data for each type of transaction can vary greatly, most information will be under platform_data.

If the transaction exists elsewhere in Rutter's API, the rutter_transaction_type field will indicate the type of transaction (e.g., "bills", "invoices", etc.). If not, this field will return null.

Properties

idstring

The Rutter generated unique ID of the transaction.

platform_idstring

The platform specific ID of the transaction.

rutter_transaction_idstringnullable

The Rutter ID of the specific entity (invoice, bill, etc.) that this transaction refers to. Supported for NetSuite and QuickBooks.

transaction_datestringfilterable

The ISO 8601 date (YYYY-MM-DD) for the transaction date for the transaction.

rutter_transaction_typestringnullable

The transaction type, such as 'bill', 'invoice', etc. Returns the lowercase equivalent if there's a corresponding Rutter entity. Otherwise, we return null.

last_synced_atstringfilterable

The ISO 8601 timestamp when the transaction 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/transactions

GET

/accounting/transactions/:id

List Accounting Transactions

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

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: transaction_date, 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: transaction_date, last_synced_at.

expandenumqueryOptional

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

Must beplatform_data.

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  "transactions": [
3    {
4      "id": "00000000-0000-0000-0000-000000000000",
5      "platform_id": "12345678",
6      "rutter_transaction_id": "00000000-0000-0000-0000-000000000000",
7      "transaction_date": "2023-01-02",
8      "rutter_transaction_type": "bills",
9      "last_synced_at": "2023-01-02T02:34:56.000Z",
10      "platform_url": "https://platform.com/resource?id=123",
11      "platform_data": {
12        "id": 123,
13        "data": "Varies by platform"
14      }
15    }
16  ],
17  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
18  "connection": {
19    "id": "00000000-0000-0000-0000-000000000000",
20    "orgId": "00000000-0000-0000-0000-000000000000",
21    "platform": "NETSUITE"
22  }
23}

Fetch an Accounting Transaction

GEThttps://production.rutterapi.com/versioned/accounting/transactions/: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  "transaction": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "rutter_transaction_id": "00000000-0000-0000-0000-000000000000",
6    "transaction_date": "2023-01-02",
7    "rutter_transaction_type": "bills",
8    "last_synced_at": "2023-01-02T02:34:56.000Z",
9    "platform_url": "https://platform.com/resource?id=123",
10    "platform_data": {
11      "id": 123,
12      "data": "Varies by platform"
13    }
14  },
15  "connection": {
16    "id": "00000000-0000-0000-0000-000000000000",
17    "orgId": "00000000-0000-0000-0000-000000000000",
18    "platform": "NETSUITE"
19  }
20}

Have questions?

Contact support for personalized guidance.

Contact support