🧾 Invoices

Invoice creation, management, and tracking

List invoices

get
/api/v1.0/organisation/{org_id}/invoices/

List all invoices for an organization

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
Query parameters
client_idstringOptional

Filter by client unique_id

from_datestringOptional

Filter invoices from this invoice_date (YYYY-MM-DD)

overduestringOptional

Filter overdue invoices (true/false)

searchstringOptional

Search invoice_number or title

statusstring · enumOptional

Filter by invoice status

Possible values:
to_datestringOptional

Filter invoices up to this invoice_date (YYYY-MM-DD)

Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/invoices/

Create invoice

post
/api/v1.0/organisation/{org_id}/invoices/create/

Create a new invoice

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
Body

Comprehensive serializer for Invoice model.

unique_idstring · max: 100 · nullableOptional
titlestring · min: 1Required
descriptionstring · nullableOptional
invoice_numberstring · min: 1 · max: 100Required
statusstring · enumOptional
  • draft - Draft
  • sent - Sent
  • viewed - Viewed by Client
  • paid - Paid
  • partially_paid - Partially Paid
  • overdue - Overdue
  • cancelled - Cancelled
  • refunded - Refunded
Possible values:
invoice_datestring · date · nullableOptional
due_datestring · dateRequired
paid_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
client_idstring · min: 1Write-onlyRequired

Client unique_id (required)

Responses
post
/api/v1.0/organisation/{org_id}/invoices/create/

Retrieve invoice

get
/api/v1.0/organisation/{org_id}/invoices/{invoice_id}/

Retrieve a specific invoice with full details

Authorizations
AuthorizationstringRequired
Path parameters
invoice_idstringRequired
org_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/invoices/{invoice_id}/

Update invoice

put
/api/v1.0/organisation/{org_id}/invoices/{invoice_id}/update/

Update an existing invoice

Authorizations
AuthorizationstringRequired
Path parameters
invoice_idstringRequired
org_idstringRequired
Body

Comprehensive serializer for Invoice model.

unique_idstring · max: 100 · nullableOptional
titlestring · min: 1Required
descriptionstring · nullableOptional
invoice_numberstring · min: 1 · max: 100Required
statusstring · enumOptional
  • draft - Draft
  • sent - Sent
  • viewed - Viewed by Client
  • paid - Paid
  • partially_paid - Partially Paid
  • overdue - Overdue
  • cancelled - Cancelled
  • refunded - Refunded
Possible values:
invoice_datestring · date · nullableOptional
due_datestring · dateRequired
paid_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
client_idstring · min: 1Write-onlyRequired

Client unique_id (required)

Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{org_id}/invoices/{invoice_id}/update/

Update invoice

patch
/api/v1.0/organisation/{org_id}/invoices/{invoice_id}/update/

Update an existing invoice

Authorizations
AuthorizationstringRequired
Path parameters
invoice_idstringRequired
org_idstringRequired
Body

Comprehensive serializer for Invoice model.

unique_idstring · max: 100 · nullableOptional
titlestring · min: 1Optional
descriptionstring · nullableOptional
invoice_numberstring · min: 1 · max: 100Optional
statusstring · enumOptional
  • draft - Draft
  • sent - Sent
  • viewed - Viewed by Client
  • paid - Paid
  • partially_paid - Partially Paid
  • overdue - Overdue
  • cancelled - Cancelled
  • refunded - Refunded
Possible values:
invoice_datestring · date · nullableOptional
due_datestring · dateOptional
paid_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
client_idstring · min: 1Write-onlyOptional

Client unique_id (required)

Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{org_id}/invoices/{invoice_id}/update/

Perform invoice action

get
/api/v1.0/organisation/{org_id}/invoices/{invoice_id}/action/

Perform an action on an invoice using query parameter.

**Available Actions:**
- `send` - Mark a draft invoice as sent to the client
- `mark_as_paid` - Mark an invoice as fully paid
- `cancel` - Cancel an invoice
- `duplicate` - Create a duplicate of the invoice
- `record_payment` - Record a payment received for the invoice (requires `amount` parameter)

**Examples:**
- `/invoices/{id}/action?action=send`
- `/invoices/{id}/action?action=mark_as_paid`
- `/invoices/{id}/action?action=cancel`
- `/invoices/{id}/action?action=duplicate`
- `/invoices/{id}/action?action=record_payment&amount=1000.00`
Authorizations
AuthorizationstringRequired
Path parameters
invoice_idstringRequired
org_idstringRequired
Query parameters
actionstring · enumRequired

The action to perform on the invoice

Possible values:
amountnumber · doubleOptional

Payment amount (required when action=record_payment)

payment_datestringOptional

Payment date in YYYY-MM-DD format (optional, defaults to today)

Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/invoices/{invoice_id}/action/

Last updated