Journal Entries
The JournalEntry Object
A Rutter Journal Entry represents the atomic transaction used in any accounting system. It must contain at least one credit and debit, and the sum of credit and debit amounts must equal 0.
Files can be attached to Rutter Journal Entries in the form of Rutter Attachments.
Properties
id
stringThe Rutter generated unique ID of the journal entry.
platform_id
stringThe platform specific ID of the journal entry.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the journal entry. Supported for NetSuite.
transaction_date
stringThe ISO 8601 timestamp for when the journal entry was issued.
currency_code
enumnullableThe ISO 4217 currency code of the journal entry.
currency_rate
numberOptionalThe exchange rate between the currency of the journal entry and the business default currency.
deposited
booleannullableIf the journal entry debits the 'Undeposited Funds' account, this field will show whether the journal entry has been deposited (usually in another Bank Deposit transaction). Null if the journal entry doesn't debit the 'Undeposited Funds' account or if the platform does not support this field.
memo
stringnullableThe memo of the journal entry.
line_items
arrayline_items
attributescreated_at
stringfilterablenullableThe ISO 8601 timestamp that the journal entry was created.
updated_at
stringfilterablenullableThe ISO 8601 timestamp that the journal entry was last updated.
last_synced_at
stringfilterableThe ISO 8601 timestamp when the journal entry 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 Journal Entries
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).
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
journal_entries
arrayjournal_entries
attributesnext_cursor
stringnullableOptionalconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "journal_entries": [
3 {
4 "id": "00000000-0000-0000-0000-000000000000",
5 "platform_id": "12345678",
6 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
7 "transaction_date": "2023-01-02T02:34:56.000Z",
8 "currency_code": "USD",
9 "currency_rate": 1,
10 "deposited": true,
11 "memo": "For goods sold.",
12 "line_items": [
13 {
14 "account_id": "00000000-0000-0000-0000-000000000000",
15 "tax_rate_id": "123",
16 "total_amount": 12.34,
17 "description": "Debit amount for goods sold"
18 },
19 {
20 "account_id": "00000000-0000-0000-0000-000000000000",
21 "tax_rate_id": "123",
22 "total_amount": -12.34,
23 "description": "Credit amount for goods sold"
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 Journal Entry
Request Parameters
id
stringpathRequiredThe Rutter generated 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
journal_entry
objectjournal_entry
attributesconnection
objectconnection
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "journal_entry": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
6 "transaction_date": "2023-01-02T02:34:56.000Z",
7 "currency_code": "USD",
8 "currency_rate": 1,
9 "deposited": true,
10 "memo": "For goods sold.",
11 "line_items": [
12 {
13 "account_id": "00000000-0000-0000-0000-000000000000",
14 "tax_rate_id": "123",
15 "total_amount": 12.34,
16 "description": "Debit amount for goods sold"
17 },
18 {
19 "account_id": "00000000-0000-0000-0000-000000000000",
20 "tax_rate_id": "123",
21 "total_amount": -12.34,
22 "description": "Credit amount for goods sold"
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 Journal Entry
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
journal_entry
objectjournal_entry
attributesResponse Body
Any of:
journal_entry
objectjournal_entry
attributesasync_response
objectOptionalasync_response
attributeserrors
arrayOptionalerrors
attributes- QuickBooks
- NetSuite
- Xero
- QuickBooks Desktop
1{
2 "journal_entry": {
3 "transaction_date": "2023-01-02T02:34:56.000Z",
4 "currency_code": "USD",
5 "memo": "For goods sold.",
6 "line_items": [
7 {
8 "account_id": "00000000-0000-0000-0000-000000000000",
9 "total_amount": 12.34,
10 "description": "Debit amount for goods sold."
11 },
12 {
13 "account_id": "00000000-0000-0000-0000-000000000000",
14 "total_amount": -12.34,
15 "description": "Credit amount for goods sold."
16 }
17 ]
18 }
19}
1{
2 "journal_entry": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "platform_id": "12345678",
5 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
6 "transaction_date": "2023-01-02T02:34:56.000Z",
7 "currency_code": "USD",
8 "currency_rate": 1,
9 "deposited": true,
10 "memo": "For goods sold.",
11 "line_items": [
12 {
13 "account_id": "00000000-0000-0000-0000-000000000000",
14 "tax_rate_id": "123",
15 "total_amount": 12.34,
16 "description": "Debit amount for goods sold"
17 },
18 {
19 "account_id": "00000000-0000-0000-0000-000000000000",
20 "tax_rate_id": "123",
21 "total_amount": -12.34,
22 "description": "Credit amount for goods sold"
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.