💳 Bills

Accounts payable and bill management

List bills

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

List all bills for an organization

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
Query parameters
from_datestring · dateOptional

Filter bills from this bill_date (YYYY-MM-DD)

overduebooleanOptional

Filter overdue bills (true/false)

searchstringOptional

Search bill_number, supplier_invoice_number, or bill title

statusstring · enumOptional

Filter by bill status

Possible values:
to_datestring · dateOptional

Filter bills up to this bill_date (YYYY-MM-DD)

vendor_idstringOptional

Filter by vendor unique_id

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

Create bill

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

Create a new bill

Authorizations
AuthorizationstringRequired
Path parameters
org_idstringRequired
Body

Comprehensive serializer for Bill model.

unique_idstring · max: 100 · nullableOptional
titlestring · min: 1Required
descriptionstring · nullableOptional
notesstring · nullableOptional
bill_numberstring · min: 1 · max: 100Required
supplier_invoice_numberstring · max: 100 · nullableOptional
statusstring · enumOptional
  • received - Received
  • approved - Approved for Payment
  • paid - Paid
  • partially_paid - Partially Paid
  • overdue - Overdue
  • disputed - Disputed
  • cancelled - Cancelled
Possible values:
vendor_idstring · min: 1 · nullableWrite-onlyOptional
bill_datestring · dateRequired
due_datestring · dateRequired
received_datestring · dateOptional
subtotalstring · decimalRequiredPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
tax_ratestring · decimalOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$
tax_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
total_amountstring · decimalRequiredPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
paid_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
documentstring · binary · nullableOptional

Scanned bill document (PDF, image)

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

Retrieve bill

get
/api/v1.0/organisation/{org_id}/bills/{bill_id}/

Retrieve a specific bill with full details

Authorizations
AuthorizationstringRequired
Path parameters
bill_idstringRequired
org_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_id}/bills/{bill_id}/

Update bill

put
/api/v1.0/organisation/{org_id}/bills/{bill_id}/update/

Update an existing bill

Authorizations
AuthorizationstringRequired
Path parameters
bill_idstringRequired
org_idstringRequired
Body

Comprehensive serializer for Bill model.

unique_idstring · max: 100 · nullableOptional
titlestring · min: 1Required
descriptionstring · nullableOptional
notesstring · nullableOptional
bill_numberstring · min: 1 · max: 100Required
supplier_invoice_numberstring · max: 100 · nullableOptional
statusstring · enumOptional
  • received - Received
  • approved - Approved for Payment
  • paid - Paid
  • partially_paid - Partially Paid
  • overdue - Overdue
  • disputed - Disputed
  • cancelled - Cancelled
Possible values:
vendor_idstring · min: 1 · nullableWrite-onlyOptional
bill_datestring · dateRequired
due_datestring · dateRequired
received_datestring · dateOptional
subtotalstring · decimalRequiredPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
tax_ratestring · decimalOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$
tax_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
total_amountstring · decimalRequiredPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
paid_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
documentstring · binary · nullableOptional

Scanned bill document (PDF, image)

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

Update bill

patch
/api/v1.0/organisation/{org_id}/bills/{bill_id}/update/

Update an existing bill

Authorizations
AuthorizationstringRequired
Path parameters
bill_idstringRequired
org_idstringRequired
Body

Comprehensive serializer for Bill model.

unique_idstring · max: 100 · nullableOptional
titlestring · min: 1Optional
descriptionstring · nullableOptional
notesstring · nullableOptional
bill_numberstring · min: 1 · max: 100Optional
supplier_invoice_numberstring · max: 100 · nullableOptional
statusstring · enumOptional
  • received - Received
  • approved - Approved for Payment
  • paid - Paid
  • partially_paid - Partially Paid
  • overdue - Overdue
  • disputed - Disputed
  • cancelled - Cancelled
Possible values:
vendor_idstring · min: 1 · nullableWrite-onlyOptional
bill_datestring · dateOptional
due_datestring · dateOptional
received_datestring · dateOptional
subtotalstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
tax_ratestring · decimalOptionalPattern: ^-?\d{0,3}(?:\.\d{0,2})?$
tax_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
total_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
paid_amountstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$
documentstring · binary · nullableOptional

Scanned bill document (PDF, image)

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

Perform bill action

get
/api/v1.0/organisation/{org_id}/bills/{bill_id}/action/

Perform an action on a bill using query parameter.

**Available Actions:**
- `mark_received` - Mark a pending bill as received
- `approve` - Approve a received bill for payment
- `mark_paid` - Mark an approved bill as fully paid
- `mark_partially_paid` - Mark a bill as partially paid
- `mark_disputed` - Mark a bill as disputed
- `mark_cancelled` - Mark a bill as cancelled
- `record_payment` - Record a payment made for the bill (requires `amount` parameter)

**Examples:**
- `/bills/{id}/action?action=mark_received`
- `/bills/{id}/action?action=approve`
- `/bills/{id}/action?action=mark_paid`
- `/bills/{id}/action?action=record_payment&amount=500.00`
Authorizations
AuthorizationstringRequired
Path parameters
bill_idstringRequired
org_idstringRequired
Query parameters
actionstring · enumRequired

The action to perform on the bill

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}/bills/{bill_id}/action/

Last updated