Bill
A bill is an invoice received for products and services purchased from vendors. Bill object allows you to perform the following operations:
- Retrieve a specific bill or a list of bills
- Create a bill
- Update a bill
- Delete a bill
- cURL
- NODE.JS
- PHP
- C#
- PYTHON
- JAVA
The Bill Object
asterisk denotes required| Name | Description | Format | Attributes |
|---|---|---|---|
| date | Date when a bill is created in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| number | This represents a bill number | string | Filterable, Sortable MaxLength = 50 |
| vendorId | Identifier of a vendor | uuid | Filterable |
| accountingDate | Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | |
| accountsPayableId | Identifier of the Accounts Payable account associated with the bill | uuid | |
| accountSplits | Represents the account splits | AccountSplits Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. | |
| amount | Total amount of a bill | double | |
| balance | The outstanding amount on a bill | double | Filterable, Sortable |
| createdById | Identifier of the user who created this object | uuid | Filterable |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| customFields []Array: Parent object can have multiple instances of this nested object under it. | List of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. | |
| dueDate | The due date of a bill based on the payment terms set in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | |
| expenseItems []Array: Parent object can have multiple instances of this nested object under it. | List of expense line items on a bill | BillExpenseItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. | |
| id | Object identifier | uuid | Filterable |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
| lastUpdatedById | Identifier of the user who last updated this object | uuid | Filterable |
| lineItems []Array: Parent object can have multiple instances of this nested object under it. | List of line items on a bill | BillLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. | |
| memo | Records any extra information or details about a bill | string | |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState Enumerated type: Click to see possible values and their descriptions. | |
| paymentStatus | Payment status of a bill, whether paid, partially paid, or unpaid | BillPaymentStatus Enumerated type: Click to see possible values and their descriptions. | Filterable, Sortable |
| referenceNumber | Reference number used to track a bill | string | MaxLength = 200 |
| reimbursable | Indicates whether the bill is an employee reimbursable expense | boolean | Filterable, Sortable |
| term | Payment term associated with a bill, e.g., Due Upon Receipt, Net 30, etc. | string | |
| termId | Identifier of the payment term associated with a bill | uuid | |
| token | Represents the token for update operations | int32 | |
| vendor | Name of a vendor | string | |
| version | Implements concurrency on this object | byte | |
| workflow []Array: Parent object can have multiple instances of this nested object under it. | Determines a list of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
Bill List
Use this method to retrieve a list of bills. You can optionally pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned. The expand parameter is used to request nested properties in the model.
Request URL
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Bill
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| fields | Query | Specifies the model properties you want in the response body | string |
| where | Query | Specifies only those records that match an expression in the query. | string |
| orderBy | Query | Specifies the order of the records. | string |
| page | Query | Specifies the page number and number of records on each page. | string |
| expand | Query | Specifies the nested model properties you want in the response body | string |
Response Body
| Name | Description | Format |
|---|---|---|
| date | Date when a bill is created in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| number | This represents a bill number | string |
| vendorId | Identifier of a vendor | uuid |
| accountingDate | Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| accountsPayableId | Identifier of the Accounts Payable account associated with the bill | uuid |
| accountSplits | Represents the account splits | AccountSplits Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| amount | Total amount of a bill | double |
| balance | The outstanding amount on a bill | double |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| customFields []Array: Parent object can have multiple instances of this nested object under it. | List of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| dueDate | The due date of a bill based on the payment terms set in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| expenseItems []Array: Parent object can have multiple instances of this nested object under it. | List of expense line items on a bill | BillExpenseItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| lineItems []Array: Parent object can have multiple instances of this nested object under it. | List of line items on a bill | BillLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| memo | Records any extra information or details about a bill | string |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| paymentStatus | Payment status of a bill, whether paid, partially paid, or unpaid | BillPaymentStatusEnumerated type: Click to see possible values and their descriptions. |
| referenceNumber | Reference number used to track a bill | string |
| reimbursable | Indicates whether the bill is an employee reimbursable expense | boolean |
| term | Payment term associated with a bill, e.g., Due Upon Receipt, Net 30, etc. | string |
| termId | Identifier of the payment term associated with a bill | uuid |
| token | Represents the token for update operations | int32 |
| vendor | Name of a vendor | string |
| version | Implements concurrency on this object | byte |
| workflow []Array: Parent object can have multiple instances of this nested object under it. | Determines a list of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
[
{
"date": "2026-01-14T04:56:14Z",
"number": "173567",
"vendorId": "2a7b6ea6-0c0e-453e-8864-8a8821610de5",
"accountingDate": "2026-01-14T04:56:14Z",
"accountsPayableId": "9e0aa4da-c297-4682-9917-492b54d0495e",
"accountSplits": {
"accrual": [
{
"account": "account",
"accountId": "7c0903f8-7b28-49c7-adbc-bba6039340e9",
"amount": 1,
"isDebit": true,
"isParent": true,
"transactionType": null
}
],
"cash": [
{
"account": "account",
"accountId": "93b47ffa-38d4-4d25-9f5c-a58f68bdfb13",
"amount": 1,
"isDebit": true,
"isParent": true,
"transactionType": null
}
]
},
"amount": 1,
"balance": 1,
"createdById": "7f5d2af5-c7f5-4fd1-baf9-bdc029be915a",
"createdOn": "2026-01-14T04:56:14Z",
"customFields": [
{
"definitionId": "cb579315-0a31-491d-a8d0-8bb85ee0ebb4",
"createdById": "59586435-3ee0-4822-805c-6390174c0265",
"createdOn": "2026-01-14T04:56:14Z",
"description": "CustomFieldData Description",
"id": "9a5d2691-a544-4c94-9cc0-de2cc372a475",
"label": "label",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "a17572aa-ec62-4f21-9499-4e854c712b43",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"dueDate": "2026-01-14T04:56:14Z",
"expenseItems": [
{
"accountId": "4a7ba3db-1be3-4515-836f-311ccb634eaf",
"amount": 1,
"account": "account",
"class": "class",
"classId": "1846379a-d2d0-4c3a-9a3f-509551c38900",
"createdById": "7b0488c1-e2fa-40ea-9d90-0e03768d7207",
"createdOn": "2026-01-14T04:56:14Z",
"entity": "entity",
"entityId": "2a179e26-84fb-4134-99c3-350eddb1b392",
"entityType": null,
"id": "f762ae28-35d1-44a3-9600-9e87a3b8c0f9",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "f4bdc345-8d5f-4e31-8a03-b49346e2d74e",
"memo": "memo",
"objectState": null,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"id": "65a9db17-7298-44d5-a900-645678a7ed56",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "f5c44b47-745d-41ef-8ba6-b65be99f530e",
"lineItems": [
{
"itemId": "7f0f2994-a44a-4409-b5bd-0d8b2bfa6ded",
"itemType": null,
"projectId": "9841af16-4b5e-4721-abb9-df7c51cad1c7",
"rate": 1,
"units": 1,
"amount": 1,
"billable": true,
"billRate": 1,
"class": "class",
"classId": "775710a9-31c9-44e1-9c91-704ab34cc78e",
"createdById": "c903429e-61cb-41e8-a4cb-af565ba75864",
"createdOn": "2026-01-14T04:56:14Z",
"description": "BillLineItem Description",
"expenseAccount": "expenseAccount",
"expenseAccountId": "42b8a875-b2db-4560-910d-96b364583fca",
"extra": true,
"id": "5c935bba-39a9-47f8-9054-27e5b3ed7f3c",
"incomeAccount": "incomeAccount",
"incomeAccountId": "d3ebd54d-3f88-464d-89c7-1d33fbbe66c1",
"item": "item",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "a9ed3aa1-bf82-4725-947d-5a9451232ffd",
"markup": 1,
"memo": "memo",
"objectState": null,
"project": "project",
"purchaseTaxRate": 1,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"memo": "memo",
"objectState": null,
"paymentStatus": null,
"referenceNumber": "referenceNumber",
"reimbursable": true,
"term": "term",
"termId": "2824f6c0-49c3-4aeb-bafb-68d5dedd2ec6",
"token": 0,
"vendor": "vendor",
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "3774655b-1950-4e73-9f7e-2fa4a1bef27b",
"action": null,
"actionBy": "actionBy",
"createdById": "c3927490-0ba7-4d20-9789-6692b6d3c067",
"createdOn": "2026-01-14T04:56:14Z",
"date": "2026-01-14T04:56:14Z",
"id": "62d9bbe6-3359-4ace-bc42-5f03905e5736",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "698b1788-dd31-442a-8250-9cd68f21729d",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "55c8e597-fe7e-439a-800e-8f5b1ff1adad",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
}
]Retrieve a Bill
Use this method to retrieve a specific bill. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Bill
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Bill identifier | string |
Response Body
| Name | Description | Format |
|---|---|---|
| date | Date when a bill is created in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| number | This represents a bill number | string |
| vendorId | Identifier of a vendor | uuid |
| accountingDate | Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| accountsPayableId | Identifier of the Accounts Payable account associated with the bill | uuid |
| accountSplits | Represents the account splits | AccountSplits Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| amount | Total amount of a bill | double |
| balance | The outstanding amount on a bill | double |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| customFields []Array: Parent object can have multiple instances of this nested object under it. | List of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| dueDate | The due date of a bill based on the payment terms set in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| expenseItems []Array: Parent object can have multiple instances of this nested object under it. | List of expense line items on a bill | BillExpenseItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| lineItems []Array: Parent object can have multiple instances of this nested object under it. | List of line items on a bill | BillLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| memo | Records any extra information or details about a bill | string |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| paymentStatus | Payment status of a bill, whether paid, partially paid, or unpaid | BillPaymentStatusEnumerated type: Click to see possible values and their descriptions. |
| referenceNumber | Reference number used to track a bill | string |
| reimbursable | Indicates whether the bill is an employee reimbursable expense | boolean |
| term | Payment term associated with a bill, e.g., Due Upon Receipt, Net 30, etc. | string |
| termId | Identifier of the payment term associated with a bill | uuid |
| token | Represents the token for update operations | int32 |
| vendor | Name of a vendor | string |
| version | Implements concurrency on this object | byte |
| workflow []Array: Parent object can have multiple instances of this nested object under it. | Determines a list of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
{
"date": "2026-01-14T04:56:14Z",
"number": "173567",
"vendorId": "1c6d9d2a-497b-41bb-8928-24de40a16787",
"accountingDate": "2026-01-14T04:56:14Z",
"accountsPayableId": "d6eaa8d6-9f7a-4fe5-a55a-d9b6dbcaf519",
"accountSplits": {
"accrual": [
{
"account": "account",
"accountId": "274e41fd-998a-4583-a58c-f4ad8db9d2ed",
"amount": 1,
"isDebit": true,
"isParent": true,
"transactionType": null
}
],
"cash": [
{
"account": "account",
"accountId": "c518f972-b806-4fe4-8d8b-3628566897aa",
"amount": 1,
"isDebit": true,
"isParent": true,
"transactionType": null
}
]
},
"amount": 1,
"balance": 1,
"createdById": "261f1193-6822-49c1-aeb7-26dbff79d7a4",
"createdOn": "2026-01-14T04:56:14Z",
"customFields": [
{
"definitionId": "c7765735-5281-48d8-88c3-fc3483e50fcc",
"createdById": "c887e874-e58a-41dd-9759-4807b58f4d0c",
"createdOn": "2026-01-14T04:56:14Z",
"description": "CustomFieldData Description",
"id": "feba0225-1c99-4c37-b4fd-766ca7dd262b",
"label": "label",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "7f081190-08d3-4774-a204-709379557963",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"dueDate": "2026-01-14T04:56:14Z",
"expenseItems": [
{
"accountId": "7f62275e-920e-4584-a06f-998cfccec2ec",
"amount": 1,
"account": "account",
"class": "class",
"classId": "2ffe7c60-d712-4050-8948-1dacf9b117b2",
"createdById": "b74733d2-efcd-4eba-85fd-b43c79c0541b",
"createdOn": "2026-01-14T04:56:14Z",
"entity": "entity",
"entityId": "c99238b4-d5c3-4353-80cb-909476afc0bc",
"entityType": null,
"id": "b549b424-d356-45e3-884f-58aa99e3adc2",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "47af3b11-36f9-4646-bc79-26c215a68756",
"memo": "memo",
"objectState": null,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"id": "655ac619-b6cc-4396-8003-a62813774aad",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "5b76fffe-888c-4331-98f0-dfc49853ca56",
"lineItems": [
{
"itemId": "262f2c4d-eff9-433b-8fc6-1952303de4c0",
"itemType": null,
"projectId": "0b383e39-4a12-4290-99f5-266507aa8f24",
"rate": 1,
"units": 1,
"amount": 1,
"billable": true,
"billRate": 1,
"class": "class",
"classId": "79643331-c6c4-4ebe-a722-afff969f23b0",
"createdById": "a90e2af8-3f3d-4392-89ee-c9e1c1bd1c35",
"createdOn": "2026-01-14T04:56:14Z",
"description": "BillLineItem Description",
"expenseAccount": "expenseAccount",
"expenseAccountId": "53a4916b-d2dc-43e3-8133-ba2ee9654149",
"extra": true,
"id": "361e6987-2cc3-49f2-87d8-7ad85a4220a9",
"incomeAccount": "incomeAccount",
"incomeAccountId": "81a9c226-e974-40d1-b1bb-43aebbab35d5",
"item": "item",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "1a85888a-0192-4cac-99f9-fdde8b10cb33",
"markup": 1,
"memo": "memo",
"objectState": null,
"project": "project",
"purchaseTaxRate": 1,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"memo": "memo",
"objectState": null,
"paymentStatus": null,
"referenceNumber": "referenceNumber",
"reimbursable": true,
"term": "term",
"termId": "8454e2c9-f50a-43b5-9611-ef190ad2625b",
"token": 0,
"vendor": "vendor",
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "f51f6beb-a9e3-4790-9a94-e764bc82e454",
"action": null,
"actionBy": "actionBy",
"createdById": "180a0f38-776c-46d0-b8b6-160e49bb9329",
"createdOn": "2026-01-14T04:56:14Z",
"date": "2026-01-14T04:56:14Z",
"id": "a9a3ae51-f6e4-4154-bee7-c298d7228336",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "05706216-539d-45cc-8499-b3ec882fa278",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "dab04f2b-3051-4594-97b2-f477f70d6213",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
}Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Bill
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Bill object | Bill |
Response Body
| Name | Description | Format |
|---|---|---|
| date | Date when a bill is created in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| number | This represents a bill number | string |
| vendorId | Identifier of a vendor | uuid |
| accountingDate | Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| accountsPayableId | Identifier of the Accounts Payable account associated with the bill | uuid |
| accountSplits | Represents the account splits | AccountSplits Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| amount | Total amount of a bill | double |
| balance | The outstanding amount on a bill | double |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| customFields []Array: Parent object can have multiple instances of this nested object under it. | List of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| dueDate | The due date of a bill based on the payment terms set in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| expenseItems []Array: Parent object can have multiple instances of this nested object under it. | List of expense line items on a bill | BillExpenseItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| lineItems []Array: Parent object can have multiple instances of this nested object under it. | List of line items on a bill | BillLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| memo | Records any extra information or details about a bill | string |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| paymentStatus | Payment status of a bill, whether paid, partially paid, or unpaid | BillPaymentStatusEnumerated type: Click to see possible values and their descriptions. |
| referenceNumber | Reference number used to track a bill | string |
| reimbursable | Indicates whether the bill is an employee reimbursable expense | boolean |
| term | Payment term associated with a bill, e.g., Due Upon Receipt, Net 30, etc. | string |
| termId | Identifier of the payment term associated with a bill | uuid |
| token | Represents the token for update operations | int32 |
| vendor | Name of a vendor | string |
| version | Implements concurrency on this object | byte |
| workflow []Array: Parent object can have multiple instances of this nested object under it. | Determines a list of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
{
"date": "2026-01-14T04:56:14Z",
"number": "173567",
"vendorId": "69e0f5fb-7dc7-4987-960e-a25bf1aebc1c",
"accountingDate": "2026-01-14T04:56:14Z",
"accountsPayableId": "1171b6c0-0529-4104-829f-cfc907398705",
"accountSplits": {
"accrual": [
{
"account": "account",
"accountId": "b0c8a19b-66e2-4dfd-98fd-3cb2873999cb",
"amount": 1,
"isDebit": true,
"isParent": true,
"transactionType": null
}
],
"cash": [
{
"account": "account",
"accountId": "47c88cf5-1ec6-49db-97c1-3271cb99f838",
"amount": 1,
"isDebit": true,
"isParent": true,
"transactionType": null
}
]
},
"amount": 1,
"balance": 1,
"createdById": "e7684859-940f-4b40-8335-6c4a2e81604d",
"createdOn": "2026-01-14T04:56:14Z",
"customFields": [
{
"definitionId": "d239ae8f-1db5-43ac-bfc4-c4c5bff4e112",
"createdById": "1ebfdd64-9298-499b-9db1-2ccfb2bec1a2",
"createdOn": "2026-01-14T04:56:14Z",
"description": "CustomFieldData Description",
"id": "ffbd1cfe-1a43-416c-b077-a2e040555292",
"label": "label",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "736e4707-d021-4000-b0fb-2611709b59da",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"dueDate": "2026-01-14T04:56:14Z",
"expenseItems": [
{
"accountId": "ccbf9453-662e-45a4-bd70-18d92d6b18d6",
"amount": 1,
"account": "account",
"class": "class",
"classId": "57509769-d5e5-444b-9a72-948fc91dd0a4",
"createdById": "19fa54ef-1ef9-4a5e-9089-363db7e59727",
"createdOn": "2026-01-14T04:56:14Z",
"entity": "entity",
"entityId": "f311258d-a1e2-4ee9-bdee-aa1e9e89a5f7",
"entityType": null,
"id": "59d745b0-3d4e-40e9-864e-5f650b00f8f9",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "d81f0813-c544-40dd-adf7-fcfcd05b471a",
"memo": "memo",
"objectState": null,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"id": "4fadcde2-435f-4430-a592-779be3f03ec3",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "e60fcf3b-4002-44d3-adde-8337274c5083",
"lineItems": [
{
"itemId": "ab6542da-6988-4175-b85e-cb3e792454ea",
"itemType": null,
"projectId": "0d94df34-97f7-4a0e-a850-e41713ba35a3",
"rate": 1,
"units": 1,
"amount": 1,
"billable": true,
"billRate": 1,
"class": "class",
"classId": "0b252d85-4550-4350-9531-33d23aa7e93f",
"createdById": "e1fd0777-aa70-40a5-9432-25062177eced",
"createdOn": "2026-01-14T04:56:14Z",
"description": "BillLineItem Description",
"expenseAccount": "expenseAccount",
"expenseAccountId": "39a57069-82df-4d0f-b464-c279a4df1e06",
"extra": true,
"id": "71cff835-0875-4a3e-a05c-8bfcc56dfbbd",
"incomeAccount": "incomeAccount",
"incomeAccountId": "bb6b1cf9-3516-4b7a-8823-29e8e3b231aa",
"item": "item",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "707308bf-d3f1-4663-9942-4c67a57acbb2",
"markup": 1,
"memo": "memo",
"objectState": null,
"project": "project",
"purchaseTaxRate": 1,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"memo": "memo",
"objectState": null,
"paymentStatus": null,
"referenceNumber": "referenceNumber",
"reimbursable": true,
"term": "term",
"termId": "8a7a8c61-3f54-432d-81a2-9c0a47c7fe79",
"token": 0,
"vendor": "vendor",
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "168b9551-ee52-42c3-9335-b6f2abf896c5",
"action": null,
"actionBy": "actionBy",
"createdById": "7e361b6a-807a-4192-8bda-48ab0ed17630",
"createdOn": "2026-01-14T04:56:14Z",
"date": "2026-01-14T04:56:14Z",
"id": "0b13fdf4-b394-495a-b927-d35a49b3cba1",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "98a89c36-9801-4190-a57f-644a725f2f80",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "82ab921f-f4a7-4004-a1d2-43e1c4475b12",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
}Create a Bill List
Use this method to save multiple bill. Pass model as the parameter.
As saving multiple records in a batch takes time, this endpoint returns a Job object that shows the progress of the batch operation. To check the status of the operation at any time, use the job endpoint.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Bill
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| body | Body | Bill object | BillBatchRequest |
Response Body
| Name | Description | Format |
|---|---|---|
| batchSize | Represents the number of entities in a batch | int64 |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| progress | Represents the total number of entities processed | int64 |
| status | Represents the status of a job e.g., ready, running, completed, or terminated | string |
| token | Represents the token for update operations | int32 |
| type | Represents the type of a job e.g., create, update, or delete | string |
| version | Implements concurrency on this object | byte |
{
"batchSize": 0,
"createdById": "e1248672-f46d-4579-a517-a2fddaa37349",
"createdOn": "2026-01-14T04:56:14Z",
"id": "8034f57a-a4ce-45ab-b31c-b3418d12b696",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "df53e125-1b3d-4946-aa19-711a2c647937",
"objectState": null,
"progress": 0,
"status": "status",
"token": 0,
"type": "type",
"version": "U3dhZ2dlciByb2Nrcw=="
}Update a Bill
Use this method to update a bill. Pass id and bill as the parameters.
Request URL
Method Overview
HTTP Method:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Bill
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Bill identifier | string |
| body | Body | Bill object | Bill |
Response Body
| Name | Description | Format |
|---|---|---|
| date | Date when a bill is created in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| number | This represents a bill number | string |
| vendorId | Identifier of a vendor | uuid |
| accountingDate | Date that determines the accounting period to which the transaction belongs in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| accountsPayableId | Identifier of the Accounts Payable account associated with the bill | uuid |
| accountSplits | Represents the account splits | AccountSplits Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| amount | Total amount of a bill | double |
| balance | The outstanding amount on a bill | double |
| createdById | Identifier of the user who created this object | uuid |
| createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| customFields []Array: Parent object can have multiple instances of this nested object under it. | List of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| dueDate | The due date of a bill based on the payment terms set in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| expenseItems []Array: Parent object can have multiple instances of this nested object under it. | List of expense line items on a bill | BillExpenseItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| id | Object identifier | uuid |
| lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
| lastUpdatedById | Identifier of the user who last updated this object | uuid |
| lineItems []Array: Parent object can have multiple instances of this nested object under it. | List of line items on a bill | BillLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
| memo | Records any extra information or details about a bill | string |
| objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
| paymentStatus | Payment status of a bill, whether paid, partially paid, or unpaid | BillPaymentStatusEnumerated type: Click to see possible values and their descriptions. |
| referenceNumber | Reference number used to track a bill | string |
| reimbursable | Indicates whether the bill is an employee reimbursable expense | boolean |
| term | Payment term associated with a bill, e.g., Due Upon Receipt, Net 30, etc. | string |
| termId | Identifier of the payment term associated with a bill | uuid |
| token | Represents the token for update operations | int32 |
| vendor | Name of a vendor | string |
| version | Implements concurrency on this object | byte |
| workflow []Array: Parent object can have multiple instances of this nested object under it. | Determines a list of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
{
"date": "2026-01-14T04:56:14Z",
"number": "173567",
"vendorId": "6c051eff-2037-49e2-a077-a89ec14efb8f",
"accountingDate": "2026-01-14T04:56:14Z",
"accountsPayableId": "e82e1598-7a80-4f10-8f92-d27bd2262395",
"accountSplits": {
"accrual": [
{
"account": "account",
"accountId": "9d8a56d2-cb8f-42f1-9983-c03a05b6daaa",
"amount": 1,
"isDebit": true,
"isParent": true,
"transactionType": null
}
],
"cash": [
{
"account": "account",
"accountId": "f55eeb11-0d42-4e78-af24-6de62ce10ceb",
"amount": 1,
"isDebit": true,
"isParent": true,
"transactionType": null
}
]
},
"amount": 1,
"balance": 1,
"createdById": "0951d0f4-2dc5-414d-8579-d4af369e871c",
"createdOn": "2026-01-14T04:56:14Z",
"customFields": [
{
"definitionId": "74e9c675-3826-4fc2-9c11-45bb917ab8ed",
"createdById": "54d982d9-a79c-488d-b27a-6d49c10fdc3e",
"createdOn": "2026-01-14T04:56:14Z",
"description": "CustomFieldData Description",
"id": "4e4d258b-3b75-41a5-8972-10554f466706",
"label": "label",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "06882653-13bd-4f4e-b753-33498d50c8d7",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"dueDate": "2026-01-14T04:56:14Z",
"expenseItems": [
{
"accountId": "2511d66b-818a-4147-b28a-9762cd3588bc",
"amount": 1,
"account": "account",
"class": "class",
"classId": "175bd91e-4d4c-4174-81b6-286ccc981ae9",
"createdById": "b05ac88a-22fd-4fb2-8719-785ba96082ab",
"createdOn": "2026-01-14T04:56:14Z",
"entity": "entity",
"entityId": "bbd16d1b-2a20-48b7-a09b-2795faa0c4d2",
"entityType": null,
"id": "c3f34b3d-310a-4005-8e16-c7a866f4dc37",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "b9a53909-9529-4cc6-b136-9ce6f6c8917f",
"memo": "memo",
"objectState": null,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"id": "017a47ae-bbb0-467e-9a6d-b215eaf1aaaa",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "468876fe-246d-4f32-acfc-fbeee3fcd90d",
"lineItems": [
{
"itemId": "a3f7f151-a783-4470-90d6-ca6a5af16c1c",
"itemType": null,
"projectId": "0c36bdc9-0ed3-47ac-8938-c55d7ead75c1",
"rate": 1,
"units": 1,
"amount": 1,
"billable": true,
"billRate": 1,
"class": "class",
"classId": "0b70f011-1e1b-47ea-8859-8404f95ee9fe",
"createdById": "403d8c88-da12-484d-bb4f-ba593d84aef5",
"createdOn": "2026-01-14T04:56:14Z",
"description": "BillLineItem Description",
"expenseAccount": "expenseAccount",
"expenseAccountId": "9e162469-12e1-4ed9-a9bf-7369324cce1f",
"extra": true,
"id": "ec7c7095-44a1-49da-adcc-66ca5e7b590a",
"incomeAccount": "incomeAccount",
"incomeAccountId": "9a78528b-9396-4bda-adfe-c560af6e3a58",
"item": "item",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "a8ef0108-7b17-4580-94c2-6f33ac75713f",
"markup": 1,
"memo": "memo",
"objectState": null,
"project": "project",
"purchaseTaxRate": 1,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"memo": "memo",
"objectState": null,
"paymentStatus": null,
"referenceNumber": "referenceNumber",
"reimbursable": true,
"term": "term",
"termId": "b01571c4-e02e-429b-9963-92533d042525",
"token": 0,
"vendor": "vendor",
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "059b3c8d-e99d-425d-bbcb-0d9c78faae56",
"action": null,
"actionBy": "actionBy",
"createdById": "471d70ec-8567-4d9d-b373-1efea3ec0376",
"createdOn": "2026-01-14T04:56:14Z",
"date": "2026-01-14T04:56:14Z",
"id": "0b3de31b-41e7-4cb7-9e27-31cca0e2d57e",
"lastUpdated": "2026-01-14T04:56:14Z",
"lastUpdatedById": "04cee555-bfd1-4913-9f44-a6db479930a2",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "a034d114-8f18-4002-954a-ac0604c8ce31",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
}Delete a Bill
Use this method to delete a bill. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
DELETE
Content Type:
application/json
Response Format:
N/A
Requires Authentication?
Yes
Headers:
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Bill identifier | string |
Patch a Bill
Use this method to perform partial modifications to a bill. Pass id and patch document as parameters.
Request URL
Method Overview
HTTP Method:
PATCH
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Bill
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
| Name | Parameter Type | Description | Format |
|---|---|---|---|
| id | Path | Bill identifier | string |
| body | Body | A document containing an array of objects with each object representing a single operation to be performed | BillPatchDocument |
Response Body
| Name | Description | Format |
|---|