---
title: "List supporting documents"
method: GET
path: "/supporting-documents/documents/"
tags: ["Billing"]
---

# List supporting documents

`GET /supporting-documents/documents/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `customer` string
- `document_type` '801' | '802'
- `status` 'active' | 'consumed' | 'expired' | 'archived'
- `subscriptions` string
- `submission_request` integer
- `used` boolean
- `valid_until` string, date
- `date_issued` string, date

## Headers

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

## Response `200`

Paginated supporting-document 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` SupportingDocument[], required — The items in the current page.
    - `id` integer
    - `customer` string, required — Customer ID.
    - `document_type` '801' | '802', required — `801` = Purchase Order. `802` = Contract.
    - `serial` string, required
    - `description` string, nullable
    - `date_issued` string, date, required
    - `valid_until` string, date, required
    - `file` string, binary, required — PDF/image file uploaded as multipart on create.
    - `subscriptions` string[]
    - `submission_request` integer, nullable — Linked submission request (when delivered as response to one).
    - `used` boolean
    - `status` 'active' | 'consumed' | 'expired' | 'archived'
    - `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)