List Invoices | Coperniq | Developer Docs

curl https://api.coperniq.io/v1/invoices \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json"

{
  "items": [
    {
      "id": 1024,
      "uid": 458732,
      "title": "Website Development Invoice",
      "status": "SENT",
      "amount": 12500,
      "amountPaid": 5000,
      "calculationMethod": "LINE_ITEMS",
      "createdAt": "2024-04-15T10:15:00Z",
      "updatedAt": "2024-04-20T14:45:00Z",
      "description": "Invoice for website redesign and development services",
      "type": "INVOICE",
      "basedOnId": 512,
      "basedOnUid": 2301,
      "dueDate": "2024-05-30T17:00:00Z",
      "isArchived": false,
      "sharedWithPortal": true,
      "account": {
        "id": 305,
        "title": "Acme Corporation"
      },
      "record": {
        "id": 512,
        "uid": 2301,
        "title": "Web Dev Project #2301"
      },
      "lineItems": [
        {
          "id": 7890,
          "catalogItemId": 450,
          "quantity": 1,
          "unitCost": 10000,
          "unitPrice": 12500,
          "description": "Custom website design and development",
          "catalogItem": {
            "id": 450,
            "name": "Website Development Service",
            "type": "SERVICE"
          }
        },
        {
          "id": 7891,
          "catalogItemId": 451,
          "quantity": 5,
          "unitCost": 100,
          "unitPrice": 125,
          "description": "Additional support hours",
          "catalogItem": {
            "id": 451,
            "name": "Support Hour",
            "type": "SERVICE"
          }
        }
      ]
    }
  ],
  "page": 1,
  "page_size": 20,
  "has_more": true
}

Retrieve a paginated list of invoices.

Supports:

Pagination (page_size, page)
Date filtering (updated_after, updated_before)
Sorting (order_by)

Retrieve a paginated list of invoices. Supports: - Pagination (`page_size`, `page`) - Date filtering (`updated_after`, `updated_before`) - Sorting (`order_by`)

Authentication

x-api-keystring

API Key authentication via header

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

order_byenumOptionalDefaults to asc

Sort order for results

Allowed values:

updated_afterstringOptionalformat: "date-time"

Filter items updated after this timestamp (ISO 8601)

updated_beforestringOptionalformat: "date-time"

Filter items updated before this timestamp (ISO 8601)

Response

List of invoices

itemslist of objects

List of invoices

pageinteger

Current page number

page_sizeinteger

Number of items per page

has_moreboolean

Whether there are more items

Authentication

Query parameters

Response

Errors