List invoices

Returns a paginated list of invoices. The list excludes draft invoices that belong to a subscription, and (unless filtered by bulk) invoices attached to a bulk in pending, processing or failed status.

GET /invoices

List invoices

cURL

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

200

{
  "count": 142,
  "results": [
    {
      "customer": "<string>",
      "document": 123,
      "date": "2023-12-25",
      "collection_method": "deferred",
      "lines": [
        {
          "name": "<string>",
          "amount": 123,
          "quantity": 123,
          "id": "<string>",
          "description": "<string>",
          "total": 123,
          "exempt": false,
          "tax": 123,
          "tax_percent": 123,
          "discount": 123,
          "discount_scheme": "%",
          "code": "<string>",
          "code_scheme": "<string>",
          "plan": 123,
          "retention": 123,
          "retention_percent": 0,
          "retention_scheme": "subtotal",
          "unit_label": "<string>"
        }
      ],
      "id": "inv_01H8XYZ123ABC",
      "number": 123,
      "currency": "<string>",
      "due_date": "2023-12-25",
      "period_start": "2023-12-25",
      "period_end": "2023-12-25",
      "note": "<string>",
      "amount": 123,
      "exempt": 123,
      "tax": 123,
      "tax_percent": 123,
      "subtotal": 123,
      "total": 123,
      "total_adjusted": 123,
      "retention": 123,
      "discount": 123,
      "discount_scheme": "%",
      "custom_change": 2,
      "status": "draft",
      "biller_status": "pending",
      "tax_agency": {},
      "local_file": "<string>",
      "subscription": 123,
      "imported": true,
      "uncollectible": "2023-11-07T05:31:56Z",
      "test_mode": true,
      "references": [
        {
          "date": "2023-12-25",
          "document": "<string>",
          "serial": "<string>",
          "description": "<string>"
        }
      ],
      "payments": [
        {}
      ],
      "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).

customer · string

number · integer

document · integer

date · string<date>

Use lookups: date__gte, date__lte.

due_date · string<date>

collection_method · enum<string>

Available options: deferred, deferred_dues, automatically

status · enum<string>

Available options: draft, finalized, paid, cancelled, uncollectible, pending

subscription · integer

bulk · integer

imported · boolean

tax_agency · string

total · number

total_adjusted · number

created · string<date-time>

Response

200

application/json

Paginated invoice 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.