The Journal Entry 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.
Properties
id
stringThe Rutter generated unique ID of the journal entry.
platform_id
stringThe platform specific ID of the journal entry.
memo
stringnullableThe memo of the journal entry.
created_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
optionalThe raw platform data corresponding to the Rutter object.
currency
enumnullablecurrency_rate
stringnullableThe exchange rate between the business default currency and the currency of the journal entry.
line_items
arrayline_items
attributesissue_date
stringThe ISO 8601 timestamp for when the journal entry was issued.
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"currency": "USD",
"currency_rate": "1",
"line_items": [
{
"platform_id": "12345678",
"description": "Debit amount for goods sold",
"amount": 12.34,
"tax_amount": 1.23,
"account_ref": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Expenses"
},
"tax_rate_id": "123"
},
{
"platform_id": "12345678",
"description": "Credit amount for goods sold",
"amount": -12.34,
"tax_amount": 0,
"account_ref": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Cash"
},
"tax_rate_id": "123"
}
],
"memo": "For goods sold.",
"issue_date": "2023-01-02T02:34:56.000Z",
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
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
integeroptionalqueryThe Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.
updated_at_min
integeroptionalqueryThe Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.
Response Body
connection
Connectionconnection
attributesjournal_entries
arrayjournal_entries
attributesnext_cursor
stringnullableoptional{
"journal_entries": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"currency": "USD",
"currency_rate": "1",
"line_items": [
{
"platform_id": "12345678",
"description": "Debit amount for goods sold",
"amount": 12.34,
"tax_amount": 1.23,
"account_ref": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Expenses"
},
"tax_rate_id": "123"
},
{
"platform_id": "12345678",
"description": "Credit amount for goods sold",
"amount": -12.34,
"tax_amount": 0,
"account_ref": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Cash"
},
"tax_rate_id": "123"
}
],
"memo": "For goods sold.",
"issue_date": "2023-01-02T02:34:56.000Z",
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE",
"orgId": "00000000-0000-0000-0000-000000000000"
}
}
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
Connectionconnection
attributesjournal_entry
Journal Entryjournal_entry
attributes{
"journal_entry": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"currency": "USD",
"currency_rate": "1",
"line_items": [
{
"platform_id": "12345678",
"description": "Debit amount for goods sold",
"amount": 12.34,
"tax_amount": 1.23,
"account_ref": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Expenses"
},
"tax_rate_id": "123"
},
{
"platform_id": "12345678",
"description": "Credit amount for goods sold",
"amount": -12.34,
"tax_amount": 0,
"account_ref": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Cash"
},
"tax_rate_id": "123"
}
],
"memo": "For goods sold.",
"issue_date": "2023-01-02T02:34:56.000Z",
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
},
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE",
"orgId": "00000000-0000-0000-0000-000000000000"
}
}
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 Response
journal_entry
Journal Entryjournal_entry
attributesAsync Response Payload
async_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"journal_entry": {
"created_at": "2023-01-02T02:34:56.000Z",
"memo": "For goods sold.",
"line_items": [
{
"description": "Debit amount for goods sold.",
"amount": 12.34,
"account_id": "00000000-0000-0000-0000-000000000000"
},
{
"description": "Credit amount for goods sold.",
"amount": 12.34,
"account_id": "00000000-0000-0000-0000-000000000000"
}
]
}
}
{
"journal_entry": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"currency": "USD",
"currency_rate": "1",
"line_items": [
{
"platform_id": "12345678",
"description": "Debit amount for goods sold",
"amount": 12.34,
"tax_amount": 1.23,
"account_ref": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Expenses"
},
"tax_rate_id": "123"
},
{
"platform_id": "12345678",
"description": "Credit amount for goods sold",
"amount": -12.34,
"tax_amount": 0,
"account_ref": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Cash"
},
"tax_rate_id": "123"
}
],
"memo": "For goods sold.",
"issue_date": "2023-01-02T02:34:56.000Z",
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z"
}
}