invoices

Get Invoice

Retrieve a specific invoice by ID

get/invoices/{invoice_id}

Request

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

Path parameters

invoice_idinteger required

Invoice identifier

Response

Invoice details

idinteger required

Invoice identifier

invoiceNumberinteger required

Unique invoice number

descriptionstring nullable

Invoice description

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

Invoice status

basedOnIdinteger nullable

ID of the record this invoice is based on

basedOnUidinteger nullable

UID of the record this invoice is based on

dueDatestring date-time

Due date

issueDatestring date-time nullable

Issue date when the invoice has been issued

amountnumber double required

Total invoice amount

amountPaidnumber double required

Amount paid

isArchivedboolean

Whether the invoice is archived

sharedWithPortalboolean

Whether the invoice is shared with portal

calculationMethodstring required

Calculation method (e.g., LINE_ITEMS)

percentagenumber double nullable

Percentage if applicable

baseAmountnumber double nullable

Base amount if applicable

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.