Skip to main content
GET
/
creditnotes
List credit notes
curl --request GET \
  --url https://api.piriod.com/creditnotes/ \
  --header 'Authorization: <api-key>' \
  --header 'x-simple-workspace: <x-simple-workspace>'
{
  "count": 142,
  "results": [
    {
      "invoice": "<string>",
      "date": "2023-12-25",
      "id": 123,
      "document": 123,
      "number": 123,
      "note": "<string>",
      "internal_note": "<string>",
      "amount": 123,
      "exempt": 123,
      "tax": 123,
      "tax_percent": 123,
      "subtotal": 123,
      "total": 123,
      "retention": 123,
      "discount": 123,
      "discount_scheme": "%",
      "status": "draft",
      "biller_status": "<string>",
      "tax_agency": {},
      "local_file": "<string>",
      "imported": true,
      "test_mode": true,
      "lines": [
        {
          "name": "<string>",
          "amount": 123,
          "quantity": 123,
          "exempt": true,
          "id": 123,
          "description": "<string>",
          "tax": 123,
          "tax_percent": 123,
          "total": 123,
          "discount": 123,
          "discount_scheme": "%",
          "code": "<string>",
          "code_scheme": "<string>",
          "retention": 123,
          "retention_percent": 0,
          "retention_scheme": "subtotal"
        }
      ],
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://piriod-d406ac55.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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).

invoice
string
document
integer
number
integer
date
string<date>
status
enum<string>
Available options:
draft,
finalized,
cancelled
note
string
created
string<date-time>
expand
string

Comma list. Supported: invoice, document.

Response

Paginated credit-note list.

count
integer
required

Total number of items matching the filter.

Example:

142

results
object[]
required

The items in the current page.

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.