---
title: "List payment receipts"
method: GET
path: "/payment-receipts/"
tags: ["Billing"]
---

# List payment receipts

`GET /payment-receipts/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `sources` string
- `status` 'draft' | 'finalized'
- `biller_status` string

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated payment-receipt list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` PaymentReceipt[], required — The items in the current page.
    - `id` integer
    - `sources` string[], required — IDs of payment sources covered by this receipt. All sources must belong to invoices for the same customer and document type, and cannot already have a payment receipt.
    - `document` 'MX22', nullable — Fiscal document type (set automatically by the biller).
    - `number` integer
    - `date` string, date, nullable
    - `custom_change` number, nullable — Custom currency conversion factor.
    - `metadata` object
    - `tax_settings` object — Country-specific tax-agency settings (validated at create/update).
    - `status` 'draft' | 'finalized'
    - `biller_status` string
    - `tax_agency` object
    - `local_file` string, uri, nullable
    - `created` string, date-time
    - `updated` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/revisions/70cbc827dc7b/schema)