---
title: "Return a chronological list of Financial Batches."
method: GET
path: "/Ams/{ClientID}/FinanceBatches"
tags: ["Ams"]
---

# Return a chronological list of Financial Batches.

`GET /Ams/{ClientID}/FinanceBatches`

## Request

- Base URL: `https://ws.yourmembership.com`
- URL: `https://ws.yourmembership.com/Ams/{ClientID}/FinanceBatches`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/:ClientID/FinanceBatches/get.ts> (a function with typed inputs; its response is checked against the schema)

Uses either a specific batch (recommended) or timestamp as a starting point. This method would typically be used in conjunction with subsequent calls to Sa.Export.Finance.Batch for each BatchID returned for the purposes of importing financial data into a 3rd-party accounting sytem. Server time information is also returned, specifically the current date/time ServerTime and GMT bias ServerGmtBias.

## Path parameters

- `ClientID` integer, required

## Query parameters

- `CommerceType` string
- `ClosingDate` string, date-time
- `ClosedOnly` boolean
- `Timestamp` string, date-time
- `StartBatchID` string
- `PageSize` integer
- `PageNumber` integer
- `UsingRedis` boolean
- `AppInitTime` string, date-time
- `ServerID` string
- `ResponseStatus` string
- `BypassCache` boolean
- `DateCached` string, date-time
- `Device` string

## Response `200`

Success

- FinanceBatchesResponse: FinanceBatchesResponse
  - `BatchID` string
  - `ItemCount` integer
  - `FinanceBatchList` FinanceBatch[]
    - `BatchID` string
    - `CommerceType` string
    - `ItemCount` integer
    - `ClosedDate` string, date-time
    - `CreateDateTime` string, date-time
  - `CommerceType` string
  - `ClosingDate` string, date-time
  - `ClosedOnly` boolean
  - `Timestamp` string, date-time
  - `StartBatchID` string
  - `PageSize` integer
  - `PageNumber` integer
  - `UsingRedis` boolean
  - `AppInitTime` string, date-time
  - `ServerID` string
  - `ClientID` integer
  - `ResponseStatus` ResponseStatus: ResponseStatus
    - `ErrorCode` string
    - `Message` string
    - `StackTrace` string
    - `Errors` ResponseError[]
      - `ErrorCode` string
      - `FieldName` string
      - `Message` string
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `Meta` DictionaryStringString: Dictionary<String,String>
  - `BypassCache` boolean
  - `DateCached` string, date-time
  - `Device` string

---

[API](https://skmtc.dev/yourmembership/apis/ym-rest-services.md) - [All operations](https://skmtc.dev/yourmembership/apis/ym-rest-services/llms.txt) - [OpenAPI document](https://skmtc.dev/yourmembership/apis/ym-rest-services/revisions/8d8a2e7e7d56?raw)