---
title: "Retrieves the collection of BatchPayment resources."
method: GET
path: "/batch_payments"
tags: ["BatchPayment"]
---

# Retrieves the collection of BatchPayment resources.

`GET /batch_payments`

Retrieves the collection of BatchPayment resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

BatchPayment collection

- BatchPayment[]
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string — Unique identifier for each batch payment
  - `accountId` string — ID of the account used to make the payment
  - `date` string — Date the payment is being made
  - `paymentId` string, nullable — The ID of the payment
  - `paymentAmount` integer, nullable — The amount being paid for
  - `type` string, nullable — The type of batch payment e.g. "PAYBATCH" e.g. "RECBATCH"
  - `status` string — Status of the batch payment e.g. "authorised" e.g. "deleted"
  - `totalAmount` integer — Total of the payments that make up the batch
  - `modified` string, nullable — The date and time the batch payment was last modified
  - `isReconciled` boolean, nullable — Whether the batch payment has been reconciled

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)