The BankDeposit object
Currently, there's only support between accounts of the same currency.
Properties
id
stringThe Rutter generated unique ID of the bank deposit.
platform_id
stringThe platform specific ID of the bank deposit.
account_id
stringnullableThe Rutter ID of the Account linked to the bank deposit. Represents the asset account being debited.
subsidiary_id
stringnullableThe Rutter ID of the Subsidiary linked to the bank deposit. This feature is currently only supported on NetSuite.
transaction_date
stringThe ISO 8601 timestamp for the transaction date of the bank deposit.
currency_code
enumThe ISO 4217 currency code of the bank deposit.
total_amount
numberThe total amount on the bank deposit.
memo
stringnullableMemo or description of the bank deposit
linked_payments
arrayAny previously created transactions associated with this deposit, used for reconciliation.
linked_payments
attributesline_items
arrayAn array of line items associated with the bank deposit.
line_items
attributescreated_at
stringnullableThe ISO 8601 timestamp that the bank deposit was created.
updated_at
stringnullableThe ISO 8601 timestamp that the bank deposit 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",
"account_id": "00000000-0000-0000-0000-000000000000",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"total_amount": 123.45,
"memo": "This is a memo.",
"linked_payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"payment_amount": 5,
"type": "invoice_payment"
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"total_amount": 118.45,
"description": "This is a description."
}
],
"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 Bank Deposits
GET /accounting/bank_depositsRequest 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
attributesbank_deposits
arraybank_deposits
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"bank_deposits": [
{
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"total_amount": 123.45,
"memo": "This is a memo.",
"linked_payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"payment_amount": 5,
"type": "invoice_payment"
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"total_amount": 118.45,
"description": "This is a description."
}
],
"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 Bank Deposit
GET /accounting/bank_deposits/:idRequest Parameters
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
attributesbank_deposit
objectbank_deposit
attributes{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"bank_deposit": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"total_amount": 123.45,
"memo": "This is a memo.",
"linked_payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"payment_amount": 5,
"type": "invoice_payment"
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"total_amount": 118.45,
"description": "This is a description."
}
],
"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 Bank Deposit
POST /accounting/bank_depositsRequest Parameters
access_token
stringqueryThe access token of the connection.
Request Body
bank_deposit
objectbank_deposit
attributesResponse Body
Any of:
bank_deposit
objectbank_deposit
attributesasync_response
objectoptionalasync_response
attributeserrors
arrayoptionalerrors
attributes{
"bank_deposit": {
"account_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"memo": "This is a memo.",
"linked_payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "invoice_payment"
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"total_amount": 118.45,
"description": "This is a description."
}
]
}
}
{
"bank_deposit": {
"id": "00000000-0000-0000-0000-000000000000",
"platform_id": "12345678",
"account_id": "00000000-0000-0000-0000-000000000000",
"subsidiary_id": "00000000-0000-0000-0000-000000000000",
"transaction_date": "2023-01-02T02:34:56.000Z",
"currency_code": "USD",
"total_amount": 123.45,
"memo": "This is a memo.",
"linked_payments": [
{
"id": "00000000-0000-0000-0000-000000000000",
"payment_amount": 5,
"type": "invoice_payment"
}
],
"line_items": [
{
"account_id": "00000000-0000-0000-0000-000000000000",
"class_id": "00000000-0000-0000-0000-000000000000",
"customer_id": "00000000-0000-0000-0000-000000000000",
"department_id": "00000000-0000-0000-0000-000000000000",
"location_id": "00000000-0000-0000-0000-000000000000",
"vendor_id": "00000000-0000-0000-0000-000000000000",
"total_amount": 118.45,
"description": "This is a description."
}
],
"created_at": "2023-01-02T02:34:56.000Z",
"updated_at": "2023-01-02T02:34:56.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
}