bills

Get Bill

Retrieve a specific bill by ID

get/bills/{bill_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/bills/{bill_id}
  • Auth: API key in header x-api-key

Path parameters

bill_idinteger required

Bill identifier

Response

Bill details

idinteger required

Bill identifier

billNumberinteger required

Unique bill number

descriptionstring nullable

Bill description

status'DRAFT' | 'SENT' | 'DECLINED' | 'PAID' | 'PARTIALLY_PAID' | 'OVERDUE' required

Bill status

basedOnIdinteger nullable

ID of the record this bill is based on

basedOnUidinteger nullable

UID of the record this bill is based on

dueDatestring date-time

Due date

issueDatestring date-time nullable

Issue date

amountnumber double required

Total bill amount

amountPaidnumber double required

Amount paid

isArchivedboolean

Whether the bill is archived

calculationMethodstring required

Calculation method (LINE_ITEMS or PERCENTAGE)

percentagenumber double nullable

Percentage if calculationMethod is PERCENTAGE

baseAmountnumber double nullable

Base amount if calculationMethod is PERCENTAGE

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.