List Invoices | Coperniq API

const url = 'https://api.coperniq.io/v1/invoices';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 1,
    "invoiceNumber": 1,
    "status": "DRAFT",
    "amount": 1.1,
    "amountPaid": 1.1,
    "calculationMethod": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "description": "string",
    "basedOnId": 1,
    "basedOnUid": 1,
    "dueDate": "2024-01-15T09:30:00Z",
    "issueDate": "2024-01-15T09:30:00Z",
    "isArchived": true,
    "sharedWithPortal": true,
    "percentage": 1.1,
    "baseAmount": 1.1,
    "account": {
      "id": 1,
      "title": "string"
    },
    "record": {
      "id": 1,
      "uid": 1,
      "title": "string"
    },
    "lineItems": [
      {
        "id": 1,
        "catalogItemId": 1,
        "quantity": 1,
        "unitCost": 1.1,
        "unitPrice": 1.1,
        "description": "string",
        "catalogItem": {
          "id": 1,
          "name": "string",
          "manufacturer": "string",
          "sku": "string",
          "type": "PRODUCT"
        }
      }
    ]
  }
]

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_afterstringOptional

Filter items updated after this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

updated_beforestringOptional

Filter items updated before this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

Response

List of invoices

idinteger

Invoice identifier

invoiceNumberinteger

Unique invoice number

statusenum

Invoice status

amountdouble

Total invoice amount

amountPaiddouble

Amount paid

calculationMethodstring

Calculation method (e.g., LINE_ITEMS)

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

descriptionstring or nullOptional

Invoice description

basedOnIdinteger or nullOptional

ID of the record this invoice is based on

basedOnUidinteger or nullOptional

UID of the record this invoice is based on

dueDatestringOptionalformat: "date-time"

Due date

issueDatestring or nullOptionalformat: "date-time"

Issue date when the invoice has been issued

isArchivedbooleanOptional

Whether the invoice is archived

sharedWithPortalbooleanOptional

Whether the invoice is shared with portal

percentagedouble or nullOptional

Percentage if applicable

baseAmountdouble or nullOptional

Base amount if applicable

accountobject or nullOptional

recordobject or nullOptional

lineItemslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error