Get Invoice

GET

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

GET

/v1/invoices/:invoice_id

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

Retrieve a specific invoice by ID

Authentication

x-api-keystring

API Key authentication via header

Path parameters

invoice_idintegerRequired

Invoice identifier

Response

Invoice details

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

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

401

Unauthorized Error

404

Not Found Error