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
stringRequiredThe Rutter generated unique ID of the journal entry.
platform_id
stringRequiredThe platform specific ID of the journal entry.
subsidiary_id
stringnullableRequiredThe Rutter ID of the Subsidiary linked to the journal entry. This feature is currently only supported on NetSuite.
transaction_date
stringRequiredThe ISO 8601 timestamp for when the journal entry was issued.
currency_code
enumnullableRequiredThe ISO 4217 currency code of the journal entry.
currency_rate
numberThe exchange rate between the currency of the journal entry and the business default currency.
deposited
booleannullableRequiredIf 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
stringnullableRequiredThe memo of the journal entry.
line_items
arrayRequiredline_items
attributescreated_at
stringnullableRequiredThe ISO 8601 timestamp that the journal entry was created.
updated_at
stringnullableRequiredThe ISO 8601 timestamp that the journal entry was last updated.
last_synced_at
stringRequiredThe ISO 8601 timestamp when the journal entry was last synced by Rutter.
platform_data
objectThe raw platform data corresponding to the Rutter object.
List Journal Entries
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumqueryUsed to request inclusion of optional objects.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
last_synced_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.
limit
integerqueryThe limit on the number of entities returned.
sort
stringqueryThe field and direction to sort by (ASC
or DESC
), e.g. last_synced_at ASC
. Currently supports the fields: updated_at
, last_synced_at
. If a field is provided but ASC
or DESC
is not, defaults to ASC
. If this field is omitted, defaults, to updated_at DESC
.
updated_at_max
integerqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integerqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectRequiredconnection
attributesjournal_entries
arrayRequiredjournal_entries
attributesnext_cursor
stringnullable- Exact
- Freshbooks
- KashFlow
- Netsuite
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "journal_entries": [
8 {
9 "id": "00000000-0000-0000-0000-000000000000",
10 "platform_id": "12345678",
11 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
12 "transaction_date": "2023-01-02T02:34:56.000Z",
13 "currency_code": "USD",
14 "currency_rate": 1,
15 "deposited": true,
16 "memo": "For goods sold.",
17 "line_items": [
18 {
19 "account_id": "00000000-0000-0000-0000-000000000000",
20 "tax_rate_id": "123",
21 "total_amount": 12.34,
22 "description": "Debit amount for goods sold"
23 },
24 {
25 "account_id": "00000000-0000-0000-0000-000000000000",
26 "tax_rate_id": "123",
27 "total_amount": -12.34,
28 "description": "Credit amount for goods sold"
29 }
30 ],
31 "created_at": "2023-01-02T02:34:56.000Z",
32 "updated_at": "2023-01-02T02:34:56.000Z",
33 "last_synced_at": "2023-01-02T02:34:56.000Z",
34 "platform_data": {
35 "id": 123,
36 "data": "Varies by platform"
37 }
38 }
39 ],
40 "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
41}
Fetch a Journal Entry
Request Parameters
id
stringpathRequiredThe Rutter generated unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
force_fetch
enumqueryForce a response even if the underlying connection hasn't finished the initial sync.
id_type
enumqueryOptionally, search for a connection by Rutter ID or platform ID. Defaults to rutter
. Not supported on Quickbooks Desktop or Dynamics 365.
Response Body
connection
objectRequiredconnection
attributesjournal_entry
objectRequiredjournal_entry
attributes- Exact
- Freshbooks
- KashFlow
- Netsuite
1{
2 "connection": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "orgId": "00000000-0000-0000-0000-000000000000",
5 "platform": "NETSUITE"
6 },
7 "journal_entry": {
8 "id": "00000000-0000-0000-0000-000000000000",
9 "platform_id": "12345678",
10 "subsidiary_id": "00000000-0000-0000-0000-000000000000",
11 "transaction_date": "2023-01-02T02:34:56.000Z",
12 "currency_code": "USD",
13 "currency_rate": 1,
14 "deposited": true,
15 "memo": "For goods sold.",
16 "line_items": [
17 {
18 "account_id": "00000000-0000-0000-0000-000000000000",
19 "tax_rate_id": "123",
20 "total_amount": 12.34,
21 "description": "Debit amount for goods sold"
22 },
23 {
24 "account_id": "00000000-0000-0000-0000-000000000000",
25 "tax_rate_id": "123",
26 "total_amount": -12.34,
27 "description": "Credit amount for goods sold"
28 }
29 ],
30 "created_at": "2023-01-02T02:34:56.000Z",
31 "updated_at": "2023-01-02T02:34:56.000Z",
32 "last_synced_at": "2023-01-02T02:34:56.000Z",
33 "platform_data": {
34 "id": 123,
35 "data": "Varies by platform"
36 }
37 }
38}
Create a Journal Entry
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
Request Body
journal_entry
objectRequiredjournal_entry
attributesResponse Body
Any of:
journal_entry
objectRequiredjournal_entry
attributesasync_response
objectasync_response
attributeserrors
arrayerrors
attributes- Dynamics 365
- Exact
- Freshbooks
- KashFlow
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_data": {
29 "id": 123,
30 "data": "Varies by platform"
31 }
32 }
33}
Have questions?
Contact support for personalized guidance.