πŸ“‰ Liabilities

Liability and obligation tracking

List liabilities

get
/api/v1.0/organisation/{org_uid}/liabilities/

Get a paginated list of liabilities with optional filters

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
Query parameters
classificationstringOptional

Filter liabilities by classification

creditorstringOptional

Filter liabilities by creditor name

liability_typestringOptional

Filter liabilities by type

namestringOptional

Filter liabilities by name/title (case-insensitive partial match)

overduebooleanOptional

Filter only overdue liabilities (true/false)

searchstringOptional

Search liabilities by name, code, reference number, or creditor

statusstringOptional

Filter liabilities by status (pending, overdue, paid, etc.)

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

Create liability

post
/api/v1.0/organisation/{org_uid}/liabilities/create/

Create a new liability

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
Body

Full serializer for Liability creation and updates. Handles translatable fields correctly.

namestring Β· min: 1 Β· max: 300Required
descriptionstring Β· nullableOptional
liability_codestring Β· max: 100 Β· nullableOptional
reference_numberstring Β· max: 200 Β· nullableOptional
liability_typestring Β· enumOptional
  • accounts_payable - Accounts Payable
  • notes_payable - Notes Payable
  • loans_payable - Loans Payable
  • mortgage_payable - Mortgage Payable
  • bonds_payable - Bonds Payable
  • accrued_expenses - Accrued Expenses
  • deferred_revenue - Deferred Revenue
  • tax_payable - Tax Payable
  • salary_payable - Salary/Wages Payable
  • interest_payable - Interest Payable
  • rent_payable - Rent Payable
  • utilities_payable - Utilities Payable
  • lease_obligations - Lease Obligations
  • warranty_obligations - Warranty Obligations
  • legal_obligations - Legal Obligations
  • other - Other
Possible values:
classificationstring Β· enumOptional
  • current - Current Liability
  • non_current - Non-Current Liability
  • contingent - Contingent Liability
Possible values:
original_amountstring Β· decimalRequired

Original amount is required and must be non-negative.

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
current_balancestring Β· decimalRequired

Current outstanding balance

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
paid_amountstring Β· decimalOptional

Total amount paid so far

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
interest_ratestring Β· decimal Β· nullableOptional

Annual interest rate percentage

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
liability_datestring Β· dateRequired

Liability date is required.

due_datestring Β· date Β· nullableOptional
payment_datestring Β· date Β· nullableOptional
maturity_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • pending - Pending
  • overdue - Overdue
  • paid - Paid
  • partially_paid - Partially Paid
  • disputed - Disputed
  • cancelled - Cancelled
  • deferred - Deferred
Possible values:
prioritystring Β· enumOptional
  • low - Low
  • medium - Medium
  • high - High
  • critical - Critical
Possible values:
creditor_namestring Β· max: 300 Β· nullableOptional
creditor_contactstring Β· max: 200 Β· nullableOptional
creditor_emailstring Β· email Β· max: 254 Β· nullableOptional
creditor_phonestring Β· max: 50 Β· nullableOptional
payment_termsstring Β· max: 200 Β· nullableOptional
late_fee_ratestring Β· decimal Β· nullableOptional

Late payment fee percentage

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
categorystring Β· max: 200 Β· nullableOptional
departmentstring Β· max: 200 Β· nullableOptional
project_referencestring Β· max: 200 Β· nullableOptional
supporting_documentstring Β· binary Β· nullableOptional

Upload contract, invoice, or agreement document (PDF, DOC, DOCX, JPG, PNG)

Responses
post
/api/v1.0/organisation/{org_uid}/liabilities/create/

Retrieve liability

get
/api/v1.0/organisation/{org_uid}/liabilities/{unique_id}/

Get detailed information about a specific liability

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/liabilities/{unique_id}/

Update liability

put
/api/v1.0/organisation/{org_uid}/liabilities/{unique_id}/update/

Update liability information (PUT for full update, PATCH for partial)

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Body

Full serializer for Liability creation and updates. Handles translatable fields correctly.

namestring Β· min: 1 Β· max: 300Required
descriptionstring Β· nullableOptional
liability_codestring Β· max: 100 Β· nullableOptional
reference_numberstring Β· max: 200 Β· nullableOptional
liability_typestring Β· enumOptional
  • accounts_payable - Accounts Payable
  • notes_payable - Notes Payable
  • loans_payable - Loans Payable
  • mortgage_payable - Mortgage Payable
  • bonds_payable - Bonds Payable
  • accrued_expenses - Accrued Expenses
  • deferred_revenue - Deferred Revenue
  • tax_payable - Tax Payable
  • salary_payable - Salary/Wages Payable
  • interest_payable - Interest Payable
  • rent_payable - Rent Payable
  • utilities_payable - Utilities Payable
  • lease_obligations - Lease Obligations
  • warranty_obligations - Warranty Obligations
  • legal_obligations - Legal Obligations
  • other - Other
Possible values:
classificationstring Β· enumOptional
  • current - Current Liability
  • non_current - Non-Current Liability
  • contingent - Contingent Liability
Possible values:
original_amountstring Β· decimalRequired

Original amount is required and must be non-negative.

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
current_balancestring Β· decimalRequired

Current outstanding balance

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
paid_amountstring Β· decimalOptional

Total amount paid so far

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
interest_ratestring Β· decimal Β· nullableOptional

Annual interest rate percentage

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
liability_datestring Β· dateRequired

Liability date is required.

due_datestring Β· date Β· nullableOptional
payment_datestring Β· date Β· nullableOptional
maturity_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • pending - Pending
  • overdue - Overdue
  • paid - Paid
  • partially_paid - Partially Paid
  • disputed - Disputed
  • cancelled - Cancelled
  • deferred - Deferred
Possible values:
prioritystring Β· enumOptional
  • low - Low
  • medium - Medium
  • high - High
  • critical - Critical
Possible values:
creditor_namestring Β· max: 300 Β· nullableOptional
creditor_contactstring Β· max: 200 Β· nullableOptional
creditor_emailstring Β· email Β· max: 254 Β· nullableOptional
creditor_phonestring Β· max: 50 Β· nullableOptional
payment_termsstring Β· max: 200 Β· nullableOptional
late_fee_ratestring Β· decimal Β· nullableOptional

Late payment fee percentage

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
categorystring Β· max: 200 Β· nullableOptional
departmentstring Β· max: 200 Β· nullableOptional
project_referencestring Β· max: 200 Β· nullableOptional
supporting_documentstring Β· binary Β· nullableOptional

Upload contract, invoice, or agreement document (PDF, DOC, DOCX, JPG, PNG)

Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{org_uid}/liabilities/{unique_id}/update/

Update liability

patch
/api/v1.0/organisation/{org_uid}/liabilities/{unique_id}/update/

Update liability information (PUT for full update, PATCH for partial)

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Body

Full serializer for Liability creation and updates. Handles translatable fields correctly.

namestring Β· min: 1 Β· max: 300Optional
descriptionstring Β· nullableOptional
liability_codestring Β· max: 100 Β· nullableOptional
reference_numberstring Β· max: 200 Β· nullableOptional
liability_typestring Β· enumOptional
  • accounts_payable - Accounts Payable
  • notes_payable - Notes Payable
  • loans_payable - Loans Payable
  • mortgage_payable - Mortgage Payable
  • bonds_payable - Bonds Payable
  • accrued_expenses - Accrued Expenses
  • deferred_revenue - Deferred Revenue
  • tax_payable - Tax Payable
  • salary_payable - Salary/Wages Payable
  • interest_payable - Interest Payable
  • rent_payable - Rent Payable
  • utilities_payable - Utilities Payable
  • lease_obligations - Lease Obligations
  • warranty_obligations - Warranty Obligations
  • legal_obligations - Legal Obligations
  • other - Other
Possible values:
classificationstring Β· enumOptional
  • current - Current Liability
  • non_current - Non-Current Liability
  • contingent - Contingent Liability
Possible values:
original_amountstring Β· decimalOptional

Original amount is required and must be non-negative.

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
current_balancestring Β· decimalOptional

Current outstanding balance

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
paid_amountstring Β· decimalOptional

Total amount paid so far

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
interest_ratestring Β· decimal Β· nullableOptional

Annual interest rate percentage

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
liability_datestring Β· dateOptional

Liability date is required.

due_datestring Β· date Β· nullableOptional
payment_datestring Β· date Β· nullableOptional
maturity_datestring Β· date Β· nullableOptional
statusstring Β· enumOptional
  • pending - Pending
  • overdue - Overdue
  • paid - Paid
  • partially_paid - Partially Paid
  • disputed - Disputed
  • cancelled - Cancelled
  • deferred - Deferred
Possible values:
prioritystring Β· enumOptional
  • low - Low
  • medium - Medium
  • high - High
  • critical - Critical
Possible values:
creditor_namestring Β· max: 300 Β· nullableOptional
creditor_contactstring Β· max: 200 Β· nullableOptional
creditor_emailstring Β· email Β· max: 254 Β· nullableOptional
creditor_phonestring Β· max: 50 Β· nullableOptional
payment_termsstring Β· max: 200 Β· nullableOptional
late_fee_ratestring Β· decimal Β· nullableOptional

Late payment fee percentage

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
categorystring Β· max: 200 Β· nullableOptional
departmentstring Β· max: 200 Β· nullableOptional
project_referencestring Β· max: 200 Β· nullableOptional
supporting_documentstring Β· binary Β· nullableOptional

Upload contract, invoice, or agreement document (PDF, DOC, DOCX, JPG, PNG)

Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{org_uid}/liabilities/{unique_id}/update/

Perform action on liability

get
/api/v1.0/organisation/{org_uid}/liabilities/{unique_id}/action/

Perform actions on a liability (mark_paid, mark_overdue). Uses query parameters.

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Query parameters
actionstring Β· enumRequired

Action to perform: mark_paid or mark_overdue

Possible values:
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/liabilities/{unique_id}/action/

Last updated