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. This feature is currently only supported on 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
stringnullableThe ISO 8601 timestamp that the journal entry was created.
updated_at
stringnullableThe ISO 8601 timestamp that the journal entry was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"currency_rate": 1,
"deposited": true,
"memo": "For goods sold.",
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "123",
"total_amount": 12.34,
"description": "Debit amount for goods sold"
},
{
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "123",
"total_amount": -12.34,
"description": "Credit amount for goods sold"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
List Journal Entries
GET /accounting/journal_entriesRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
expand
enumoptionalqueryUsed to request inclusion of optional objects.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
updated_at_max
integeroptionalqueryUnix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryUnix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.
Response Body
connection
objectconnection
attributesjournal_entries
arrayjournal_entries
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"journal_entries": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"currency_rate": 1,
"deposited": true,
"memo": "For goods sold.",
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "123",
"total_amount": 12.34,
"description": "Debit amount for goods sold"
},
{
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "123",
"total_amount": -12.34,
"description": "Credit amount for goods sold"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}
Fetch a Journal Entry
GET /accounting/journal_entries/:idRequest Parameters
id
stringpathThe Rutter generated unique ID of the object.
access_token
stringqueryThe access token of the connection.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
Response Body
connection
objectconnection
attributesjournal_entry
objectjournal_entry
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"journal_entry": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"currency_rate": 1,
"deposited": true,
"memo": "For goods sold.",
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "123",
"total_amount": 12.34,
"description": "Debit amount for goods sold"
},
{
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "123",
"total_amount": -12.34,
"description": "Credit amount for goods sold"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}
Create a Journal Entry
POST /accounting/journal_entriesRequest Parameters
access_token
stringqueryThe 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{
"journal_entry": {
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"memo": "For goods sold.",
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"total_amount": 12.34,
"description": "Debit amount for goods sold."
},
{
"account_id": "00000000-0000-0000-0000-000000000000",
"total_amount": 12.34,
"description": "Credit amount for goods sold."
}
]
}
}
{
"journal_entry": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"currency_rate": 1,
"deposited": true,
"memo": "For goods sold.",
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "123",
"total_amount": 12.34,
"description": "Debit amount for goods sold"
},
{
"account_id": "00000000-0000-0000-0000-000000000000",
"tax_rate_id": "123",
"total_amount": -12.34,
"description": "Credit amount for goods sold"
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}