Overview

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

Data Model

Field

Type

Description

id

string

Identifier for the deposit, unique to the business in the accounting service provider.

postedDate
sortable, filterable

string
See Date

Date of the deposit as recorded in the accounting service provider.

currencyRef

Reference Types

Currency of the deposit.

Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency.

currencyRate

decimal

Rate between the currency of the deposit and the base currency of the business. Not applicable when multi-currency is not supported.

lines

array

An array of deposit lines.

status
sortable, filterable

string

Current status of a deposit.

subTotal
sortable, filterable

decimal

Value of the deposit, including discounts and excluding tax.

taxAmount
sortable, filterable

decimal

Any tax applied to the deposit amount.

totalAmount
sortable, filterable

decimal

Amount of the deposit, inclusive of tax.

memo

string

User-friendly reference for the deposit.

sourceModifiedData

string
See Date

Date the record was last changed in the accounting service provider.

Lines

Field

Type

Description

description

string

Friendly name of the goods or services received.

unitAmount

decimal

Price of each unit of goods or services.

quantity

decimal

Number of units of goods or services.

subTotal

decimal

Amount of the line, inclusive of discounts but exclusive of tax.

taxAmount

decimal

Amount of tax for the line.

totalAmount

decimal

Total amount of the line, inclusive of discounts and tax.

accountRef

Reference Types

Reference to the account to which 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 to which the line item is linked to.

inventoryRef

Reference Types

Reference to the product or inventory item to which the line item is linked to.

entityRef

Reference Types

Reference to the customer or vendor to which the line item is linked to.

link

array

An deposit linked transaction.

Link

Field

Type

Description

type

string

Types of deposit line links. Valid values:
transfer
journalEntry
billPayment
paymentOnAccount
other

id

string

Unique identifier of the transaction represented by the link.

Deposit Status

  • 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.

Example Data

{
  "data": [
    {
      "id": "1",
      "postedDate": "2021-03-09T10:18:29.985Z",
      "currencyRef": {
        "id": "CAD",
        "name": "Canadian Dollar"
      },
      "currencyRate": 1.13,
      "lines": [
        {
          "description": "Services rendered.",
          "unitAmount": 100.5,
          "quantity": 3,
          "subTotal": 301.5,
          "taxAmount": 20.5,
          "totalAmount": 322,
          "accountRef": {
            "id": "145",
            "name": "Depreciation Expense"
          },
          "taxRateRef": {
            "id": "1",
            "name": "HST",
            "effectiveTaxRate": 13
          },
          "entityRef": {
            "id": "1",
            "name": "ABC Inc.",
            "type": "vendor"
          },
          "link": {
            "id": "1",
            "type": "billPayment"
          }
        }
      ],
      "subTotal": 301.5,
      "taxAmount": 20.5,
      "totalAmount": 322,
      "status": "open",
      "memo": "Example bill memo.",
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z"
    }
  ]
}

Did this page help you?