List Invoices

GET

https://api.coperniq.io/v1/invoices

GET

/v1/invoices

1 const url = 'https://api.coperniq.io/v1/invoices';
2 const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 [
2   {
3     "id": 1,
4     "invoiceNumber": 1,
5     "status": "DRAFT",
6     "amount": 1.1,
7     "amountPaid": 1.1,
8     "calculationMethod": "string",
9     "createdAt": "2024-01-15T09:30:00Z",
10     "updatedAt": "2024-01-15T09:30:00Z",
11     "description": "string",
12     "basedOnId": 1,
13     "basedOnUid": 1,
14     "dueDate": "2024-01-15T09:30:00Z",
15     "isArchived": true,
16     "sharedWithPortal": true,
17     "percentage": 1.1,
18     "baseAmount": 1.1,
19     "account": {
20       "id": 1,
21       "title": "string"
22     },
23     "record": {
24       "id": 1,
25       "uid": 1,
26       "title": "string"
27     },
28     "lineItems": [
29       {
30         "id": 1,
31         "catalogItemId": 1,
32         "quantity": 1,
33         "unitCost": 1.1,
34         "unitPrice": 1.1,
35         "description": "string",
36         "catalogItem": {
37           "id": 1,
38           "name": "string",
39           "manufacturer": "string",
40           "sku": "string",
41           "type": "PRODUCT"
42         }
43       }
44     ]
45   }
46 ]

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

Errors

400

Bad Request Error

401

Unauthorized Error