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

# Retrieves the collection of Payment resources.

`GET /payments`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/payments`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/payments/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the collection of Payment resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Payment collection

- Payment[]
  - `id` string
  - `integration` string: The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string: The unique identifier of the source 3rd party integration
  - `paymentDate` string, date-time: Date of the payment
  - `totalAmount` string, nullable: Total amount listed in the payment in cents
  - `status` string, nullable: Status of the payment e.g. PAID e.g: AUTHORISED e.g: DELETED
  - `modified` string, date-time, nullable: Date entry was last modified
  - `accountId` string, nullable: Account Id the payment was made from
  - `customerId` string, nullable: Customer Id
  - `customerName` string, nullable: Customer name
  - `linkedTxnId` string, nullable: Transaction Id
  - `linkedTxnType` string, nullable: Transaction type e.g. Deposit, Invoice
  - `created` string, date-time, nullable: Date entry was created
  - `invoiceId` string, nullable: Invoice Id
  - `currencyCode` string, nullable: Currency code
  - `paymentType` string, nullable: Payment type e.g. CreditCard

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)