Deposits

The Deposit object

From the Deposits endpoint, you can retrieve a list of all deposits for a specified business.

Field	Type	Description
id sortable, filterable	string	Identifier for the deposit, unique to the business in the accounting service provider.
postedDate sortable, filterable	string See Date	Date on which the deposit was posted to the accounting service, and had an impact on the general ledger. This may be different from the creation date.
currency	string	ISO-4217 currency code of the deposit.
currencyRate	decimal	Rate to convert the total amount of the transaction into the base currency for the business at the time of the transaction.
bankAccountRef	Reference Types	Reference to the account the deposit is recorded against. Query the Chart of Accounts endpoint to determine the appropriate Account object for this reference, where isBankAccount is true.
lines	array	An array of deposit lines.
subTotal sortable, filterable	decimal	Amount of the deposit, inclusive of discounts but exclusive of tax.
taxAmount sortable, filterable	decimal	Amount of tax on the deposit.
totalAmount sortable, filterable	decimal	Total amount of the deposit, inclusive of tax.
status sortable, filterable	string	Current status of a deposit.
memo	string	Any additional information or business notes about the deposit.
sourceModifiedDate sortable, filterable	string See Date	The date on which this record was last modified in the accounting service.

Field	Type	Description
description	string	Description of the line item.
unitAmount	decimal	Line item unit amount.
quantity sortable, filterable	integer	Line item quantity.
taxAmount sortable, filterable	decimal	Line item tax amount.
amount sortable, filterable	decimal	Line item total amount, inclusive of discounts & tax.
accountRef	Reference Types	Reference to the account the line item is linked to. Pushing data requires a valid bank account reference. Query Accounts and use the `id` parameter of an account with `isBankAccount=true` as a value. For Xero, use `nomincalCode` parameter.
taxRateRef	Reference Types	Reference to the tax rate the line item is linked to.
entityRef	Reference Types	Reference to the Vendor/Customer the line item is linked to.
trackingCategoryRefs	Reference Types	Reference to the tracking categories associated with this line item, e.g. classes or departments.
links	array	Deposit linked transaction.

Field	Type	Description
type	string	Types of links to deposit lines.
id	string	Unique identifier of the transaction represented by the link.

open - Deposit is no longer a draft. It has been processed and/or sent to the customer/vendor. In this state, it will impact the ledger.
paid - Deposit is paid in full.
void - A Deposit can become void by being deleted, refunded, written off, or cancelled.
draft - Deposit is yet to be authorized and sent to the customer/vendor, and will not be used in any reports. It may contain incomplete line items.
unknown - Railz was not able to recognize the status of the deposit. This can be due to missing values in the accounting service provider or unavailable in the data we received.