List payment receipts

GET /payment-receipts

List payment receipts

cURL

curl --request GET \
  --url https://api.piriod.com/payment-receipts/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'

200

{
  "count": 142,
  "results": [
    {
      "sources": [
        "<string>"
      ],
      "id": 123,
      "document": "MX22",
      "number": 123,
      "date": "2023-12-25",
      "custom_change": 2,
      "metadata": {},
      "tax_settings": {},
      "status": "draft",
      "biller_status": "<string>",
      "tax_agency": {},
      "local_file": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

Authorization · string · header · required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

x-simple-workspace · string · required

Workspace (account) identifier. Required for every request.

x-piriod-test-mode · boolean · default: false

Whether to operate against test-mode data. Defaults to false.

Query Parameters

page · integer · default: 1

Page number to retrieve (1-indexed).

Required range: x >= 1

page_size · integer · default: 20

Number of items per page.

Required range: 1 <= x <= 100

ordering · string

Field to sort results by. Prefix with - for descending order (e.g. -created).

sources · string

Filter by linked source ID.

status · enum<string>

Available options: draft, finalized

biller_status · string

Response

200 - application/json

Paginated payment-receipt list.

count · integer · required

Total number of items matching the filter.

Example:

142

results · object[] · required

The items in the current page.

Show child attributes

next · string<uri> | null

URL of the next page, or null if last page.

previous · string<uri> | null

URL of the previous page, or null if first page.