Get Bill | Coperniq API

const url = 'https://api.coperniq.io/v1/bills/1';
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,
  "status": "DRAFT",
  "amount": 1.1,
  "amountPaid": 1.1,
  "calculationMethod": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "billNumber": 1,
  "description": "string",
  "type": "BILL",
  "basedOnId": 1,
  "basedOnUid": 1,
  "dueDate": "2024-01-15T09:30:00Z",
  "issueDate": "2024-01-15T09:30:00Z",
  "isArchived": 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 specific bill by ID

Authentication

x-api-keystring

API Key authentication via header

Path parameters

billIdintegerRequired

Bill identifier

Response

Bill details

idinteger

Bill identifier

statusenum

Bill status

amountdouble

Total bill amount

amountPaiddouble

Amount paid

calculationMethodstring

Calculation method (LINE_ITEMS or PERCENTAGE)

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

billNumberinteger

Unique bill number

descriptionstring or null

Bill description

typeenum or null

Document type

Allowed values:

basedOnIdinteger or null

ID of the record this bill is based on

basedOnUidinteger or null

UID of the record this bill is based on

dueDatestringformat: "date-time"

Due date

issueDatestring or nullformat: "date-time"

Issue date

isArchivedboolean

Whether the bill is archived

percentagedouble or null

Percentage if calculationMethod is PERCENTAGE

baseAmountdouble or null

Base amount if calculationMethod is PERCENTAGE

accountobject or null

recordobject or null

lineItemslist of objects

Errors

401

Unauthorized Error

404

Not Found Error