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,
  "billNumber": 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",
  "internalMemo": "string",
  "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

bill_idintegerRequired

Bill identifier

Response

Bill details

idinteger

Bill identifier

billNumberinteger

Unique bill number

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

descriptionstring or nullOptional

Bill description

internalMemostring or nullOptional

Internal-only memo, never shown to customers or on the PDF or portal. Rich text (HTML, like the app’s editor stores). On update, send null or "" to clear it; responses return null when empty. Invoices and bills created in the app from a quote or purchase order inherit its memo.

basedOnIdinteger or nullOptional

ID of the record this bill is based on

basedOnUidinteger or nullOptional

UID of the record this bill is based on

dueDatestringOptionalformat: "date-time"

Due date

issueDatestring or nullOptionalformat: "date-time"

Issue date

isArchivedbooleanOptional

Whether the bill is archived

percentagedouble or nullOptional

Percentage if calculationMethod is PERCENTAGE

baseAmountdouble or nullOptional

Base amount if calculationMethod is PERCENTAGE

accountobject or nullOptional

recordobject or nullOptional

lineItemslist of objectsOptional

Errors

401

Unauthorized Error

404

Not Found Error