Skip to main content
POST
Create bill

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Body

application/json
date
string<date>
required

Bill date.

document_due
string<date>
required

Payment due date. Alias: due_date.

currency
string
required

Currency code.

items
object[]
required
Minimum array length: 1
customer
string

Vendor uuid, name, or email. Alias: vendor.

document_number
string

Bill reference. Alias: bill_no.

narration
string

Document title.

memo
string

Internal note.

payable_account
string

Optional accounts payable control account.

amount_paid
number

Amount paid now. Omit for an open bill.

payment_category
string

Cash or bank account name payment came from.

exchange_rate
number

Default 1.

status
string

Default pending. Use draft to save without posting.

branch
string

Branch id. Same as branch_uuid. Leave both off to use the business default branch. A name is not accepted, and a new branch is not created. An id that is not one of your branches is still saved, but it will not show under a location in reports.

branch_uuid
string

Branch id from GET /branches. Alias: branch.

department
string

Department id. Same as department_uuid. An unknown id is saved as sent and does not create a department. To add one from a name, send department_name and leave this off.

department_uuid
string

Department id from GET /departments. Alias: department.

department_name
string

Department name. Capitalization does not matter. If no department has that name, Tyms adds one and tags this document with it. Ignored when department or department_uuid is set.

project_uuid
string

Project id from GET /projects. An unknown id is saved as sent and does not create a project. To add one from a name, send project_name and leave this off.

project_name
string

Project name, matched exactly, including capital letters. If no project has that name, Tyms adds an active project that starts today and ends in one month, then tags this document with it. Ignored when project_uuid is set.

employee
string

Team member id. Same as employee_uuid. An unknown id is saved as sent and does not add a person. To add one from a name, send employee_name and leave this off.

employee_uuid
string

Team member id. Alias: employee.

employee_name
string

Full name of the team member. If nobody matches, Tyms adds them. Ignored when employee or employee_uuid is set.

Response

Bill created

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.