Invoices API

REST API endpoints for reading invoices.

Invoices are issued by the platform as orders are paid — this resource is read-only. To configure whether invoices are issued, or to set the footer note printed on them, use the invoiceSettings group on PATCH /api/v1/settings.

Scope: orders:read.

List Invoices

GET /api/v1/invoices

Query Parameters

Parameter	Type	Default	Description
`offset`	`number`	0	Number of invoices to skip
`limit`	`number`	20	Invoices per page (1-100)
`query`	`string`	—	Match an invoice number or the order's lookup reference
`environment`	`string`	—	`live` or `test`; omit for both

curl -H "Authorization: Bearer your_api_key" \
  https://your-store.yns.store/api/v1/invoices

Response

{
  "data": [
    {
      "id": "0191abc0-1234-7def-8000-000000000001",
      "invoiceNumber": "FV 1/08/2025",
      "invoiceIndex": 1,
      "orderId": "0191abc0-5678-7def-8000-000000000001",
      "orderLookup": "ORD-1234",
      "environment": "live",
      "storeAddress": {
        "name": "Acme Goods",
        "street": "123 Main St",
        "city": "Warsaw",
        "zip": "00-001",
        "country": "PL"
      },
      "createdAt": "2025-08-01T12:00:00.000Z",
      "updatedAt": "2025-08-01T12:00:00.000Z"
    }
  ],
  "meta": {
    "total": 42,
    "offset": 0,
    "limit": 20
  }
}

Get Invoice

GET /api/v1/invoices/:id

Returns a single invoice by UUID. Returns 404 if the invoice does not exist in this store.

curl -H "Authorization: Bearer your_api_key" \
  https://your-store.yns.store/api/v1/invoices/0191abc0-1234-7def-8000-000000000001

Returns the same shape as a single item from the list response.

PreviousEmail TemplatesAPI Reference NextTeamAPI Reference