PIpiriod
Billing

List submission requests

get/supporting-documents/submission-requests/

Request

Query parameters

pageinteger

Page number to retrieve (1-indexed).

page_sizeinteger

Number of items per page.

orderingstring

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

customerstring
status'pending' | 'sent' | 'overdue' | 'fulfilled' | 'cancelled'
submission_type'order' | 'hes'
is_automaticboolean
due_datestring date

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

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

Response

Paginated submission-request list.

countinteger required

Total number of items matching the filter.

nextstring uri nullable

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

previousstring uri nullable

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

Example response

{
  "count": 142
}

Changes

No recorded changes to this operation across all 1 revision of this API.