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

# List submission requests

`GET /supporting-documents/submission-requests/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `customer` string
- `status` 'pending' | 'sent' | 'overdue' | 'fulfilled' | 'cancelled'
- `submission_type` 'order' | 'hes'
- `is_automatic` boolean
- `due_date` string, date

## Headers

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

## Response `200`

Paginated submission-request 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` SubmissionRequest[], required — The items in the current page.
    - `id` integer
    - `customer` string, required — Customer ID.
    - `submission_type` 'order' | 'hes', required — `order` = Purchase Order. `hes` = Service Entry Sheet.
    - `status` 'pending' | 'sent' | 'overdue' | 'fulfilled' | 'cancelled'
    - `recipients` string[]
    - `subscriptions` string[] — IDs of subscriptions this request is tied to. Must belong to the customer.
    - `due_date` string, date, nullable
    - `is_automatic` boolean
    - `billing_cycle` integer, nullable
    - `email_subject` string
    - `email_message` string
    - `sent_at` string, date-time, nullable
    - `fulfilled_at` string, date-time, nullable
    - `created` 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)