{
"status": "success",
"message": "Invoice imported successfully.",
"data": [
{
"uuid": "c4d5e6f7a8b9401a9c2d3e4f5a6b7c8d",
"transaction_type": "invoice",
"status": "pending",
"document_number": "INV-1042"
}
]
}{
"status": "failed",
"message": "<string>"
}Create invoice
{
"status": "success",
"message": "Invoice imported successfully.",
"data": [
{
"uuid": "c4d5e6f7a8b9401a9c2d3e4f5a6b7c8d",
"transaction_type": "invoice",
"status": "pending",
"document_number": "INV-1042"
}
]
}{
"status": "failed",
"message": "<string>"
}Authorizations
Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.
Body
Invoice date.
Due date. Alias: due_date.
Currency code, e.g. NGN.
Line items. Document total is computed from here.
1Hide child attributes
Hide child attributes
Line label. Alias: name.
Quantity sold or purchased.
Unit price. On bills this is unit cost. Alias: price.
Required. Revenue, expense, or inventory account — name, uuid, or account code.
Optional line description.
Tax rate as a percentage (e.g. 7.5 = 7.5%). Preferred over tax_uuid.
Optional tax record uuid instead of tax percentage.
Withholding tax (WHT) rate as a percentage.
Optional WHT uuid instead of withholding_tax percentage.
Line discount value.
percent or amount / fixed.
percent, amount, fixed true if the line affects stock.
Existing inventory item uuid when linking stock.
Contact uuid, name, or email. Aliases: contact, contact_uuid, vendor.
Invoice number. Auto-suggested if omitted.
Document title. Alias: title.
Internal note. Alias: note.
Note printed on the invoice.
Default pending. Use draft to save without posting.
Default 1.
Shipping amount added to the invoice.
Accounts receivable control account — name, uuid, or code.
Payment collected on create. 0 or omit for unpaid.
Cash or bank account name when recording payment on create. Aliases: paid_through, payment_account.
Response
Invoice created