---
title: "GET /deposits"
method: GET
path: "/deposits"
tags: ["Deposits"]
---

# GET /deposits

`GET /deposits`

Gets the latest deposits for a business.

## Query parameters

- `businessName` string, required
- `serviceName` 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud', required
- `startDate` string
- `endDate` string
- `offset` number
- `limit` number
- `orderBy` string
- `totalAmount` number, float
- `status` 'open' | 'paid' | 'void' | 'unknown' | 'draft'

## Response `200`

- GetDepositResponseDto
  - `pagination` PaginationMetaData, required
    - `offset` number, required
    - `limit` number, required
    - `count` number, required
  - `count` number, required
  - `meta` BasicStartEndDateReportMetaData, required
    - `reportId` string[], required
    - `serviceName` 'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod', required
    - `businessName` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `startDate` string, date-time, required
    - `endDate` string, date-time, required
  - `data` GetDepositData[], required
    - `id` string, required
    - `postedDate` string, date-time, required
    - `currencyRef` CurrencyRef
      - `id` string, required
      - `name` string
      - `symbol` string
    - `currencyRate` number, float
    - `lines` DepositLineItems[]
      - `description` string
      - `unitAmount` number, float
      - `quantity` number
      - `subTotal` number, float
      - `taxAmount` number, float
      - `totalAmount` number, float, required
      - `accountRef` AccountRef
        - `id` string, required
        - `name` string
      - `taxRateRef` TaxRateRef
        - `id` string, required
        - `name` string
        - `effectiveTaxRate` number, float
      - `entityRef` DepositEntityRef
        - `name` string
        - `id` string, required
        - `type` 'customer' | 'employee' | 'unknown', required
      - `link` Link
        - `type` 'billPayment' | 'transfer' | 'journalEntry' | 'paymentOnAccount' | 'other'
        - `id` string, required
      - `links` Links[]
        - `type` 'billPayment' | 'transfer' | 'journalEntry' | 'paymentOnAccount' | 'other', required
        - `id` string, required
    - `subTotal` number, float
    - `taxAmount` number, float
    - `totalAmount` number, float, required
    - `status` 'open' | 'paid' | 'void' | 'unknown' | 'draft', required
    - `memo` string
    - `sourceModifiedDate` string, date-time

## Other responses

- `202` — Data in pending state
- `204` — No data available
- `400` — Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401` — Unauthorized - Not logged in or log in expired
- `403` — Forbidden - Not enough permission
- `500` — Server Error

---

[API](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api.md) · [All operations](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/railz/fis-accounting-data-as-a-service-api/revisions/5cdfae3fa1fa/schema)