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

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
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string	Filterable, Sortable
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

base_url/bill

/bill

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

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
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
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.

Example Response

[
  {
    "date": "2025-06-24T05:51:51Z",
    "number": "173567",
    "vendorId": "662375af-cfab-46d8-933f-35d15e277c80",
    "accountingDate": "2025-06-24T05:51:51Z",
    "accountsPayableId": "07602cee-c306-4b40-bf6c-e2c86e14d1b9",
    "accountSplits": {
      "accrual": [
        {
          "account": "account",
          "accountId": "645fc171-b266-4e34-8476-dbd03d0df4db",
          "amount": 1,
          "isDebit": true,
          "isParent": true,
          "transactionType": null
        }
      ],
      "cash": [
        {
          "account": "account",
          "accountId": "d0efe4f6-874e-4870-a707-f532510010ad",
          "amount": 1,
          "isDebit": true,
          "isParent": true,
          "transactionType": null
        }
      ]
    },
    "amount": 1,
    "balance": 1,
    "createdById": "2fbf8ae0-bbb5-4c16-9d50-aadb0e0902c6",
    "createdOn": "2025-06-24T05:51:51Z",
    "customFields": [
      {
        "definitionId": "675be35d-5683-4f09-93a6-ab6f6a82a50c",
        "createdById": "5499ccbf-12d3-45b4-bbb5-864c23420cd3",
        "createdOn": "2025-06-24T05:51:51Z",
        "description": "CustomFieldData Description",
        "id": "bd53c4e1-e68c-495c-ba42-a35940cea43e",
        "integrationSourceId": "integrationSourceId",
        "label": "label",
        "lastUpdated": "2025-06-24T05:51:51Z",
        "lastUpdatedById": "3c0b84ff-3c72-462e-b926-ba0f6061975c",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "dueDate": "2025-06-24T05:51:51Z",
    "expenseItems": [
      {
        "accountId": "2d43a365-7144-4d34-9649-bf1f6c9362e5",
        "amount": 1,
        "account": "account",
        "class": "class",
        "classId": "2789bbfb-a73f-4653-aa09-e8198cdf4b19",
        "createdById": "ac563093-d4a7-431b-aeb0-40f64ce4c6af",
        "createdOn": "2025-06-24T05:51:51Z",
        "entity": "entity",
        "entityId": "e430c3d7-ce6d-4ccc-876b-bdf63f1219ff",
        "entityType": null,
        "id": "cf302a2a-067b-4dab-b57c-d7fc746e801a",
        "integrationSourceId": "integrationSourceId",
        "lastUpdated": "2025-06-24T05:51:51Z",
        "lastUpdatedById": "dde9e921-ed3e-409f-86c0-ba436e782453",
        "memo": "memo",
        "objectState": null,
        "token": 0,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "id": "b5b740cd-06b9-4f99-ac67-bcd37a75c3b0",
    "integrationSourceId": "integrationSourceId",
    "lastUpdated": "2025-06-24T05:51:51Z",
    "lastUpdatedById": "52be8d20-6865-4620-a4c3-da48d07c6ded",
    "lineItems": [
      {
        "itemId": "69245a9e-8590-4c41-a52d-2c3d37ab36e5",
        "itemType": null,
        "projectId": "6880f256-2b0c-4ce1-8bf0-6eb2b9f80933",
        "rate": 1,
        "units": 1,
        "amount": 1,
        "billable": true,
        "billRate": 1,
        "class": "class",
        "classId": "8a72e779-7642-4d3b-b2ae-378839e1f66b",
        "createdById": "d8660a2c-d450-4095-a34e-88064675552b",
        "createdOn": "2025-06-24T05:51:51Z",
        "description": "BillLineItem Description",
        "expenseAccount": "expenseAccount",
        "expenseAccountId": "0ab29877-7512-48e9-871a-cd3c183c21af",
        "extra": true,
        "id": "9a1cade0-b9dc-402d-9408-64a39ef1191d",
        "incomeAccount": "incomeAccount",
        "incomeAccountId": "cafc8912-1ede-45ee-9244-522d0535266e",
        "integrationSourceId": "integrationSourceId",
        "item": "item",
        "lastUpdated": "2025-06-24T05:51:51Z",
        "lastUpdatedById": "dd47bdca-9b50-418c-956b-ae2b0325223b",
        "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": "38ac15e0-bf56-4f15-bfe4-385c7add1a57",
    "token": 0,
    "vendor": "vendor",
    "version": "U3dhZ2dlciByb2Nrcw==",
    "workflow": [
      {
        "actionById": "044c1d18-cb78-4e67-a2e0-52889f5fc838",
        "action": null,
        "actionBy": "actionBy",
        "createdById": "67e17231-7716-4984-9c99-c1469b2b4e9d",
        "createdOn": "2025-06-24T05:51:51Z",
        "date": "2025-06-24T05:51:51Z",
        "id": "e03ef977-4f5d-4c71-bea8-50bd60536240",
        "integrationSourceId": "integrationSourceId",
        "lastUpdated": "2025-06-24T05:51:51Z",
        "lastUpdatedById": "7ed093cc-8a08-47b4-9d46-a0868ab18bec",
        "memo": "memo",
        "objectState": null,
        "sendTo": "sendTo",
        "sendToId": "13a0d446-cc73-4c1f-93b2-27d8095b3c0b",
        "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

base_url/bill/{id}

/bill/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

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
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
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.

Example Response

{
  "date": "2025-06-24T05:51:51Z",
  "number": "173567",
  "vendorId": "b6dbd731-d5fa-443f-af1a-f0586b94b60b",
  "accountingDate": "2025-06-24T05:51:51Z",
  "accountsPayableId": "a046dace-89b6-442a-9b95-4061671e5658",
  "accountSplits": {
    "accrual": [
      {
        "account": "account",
        "accountId": "772435ca-353b-4fc4-824c-206cae092465",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ],
    "cash": [
      {
        "account": "account",
        "accountId": "4c70c35e-b41a-4d3a-bf3a-efe2d89c5624",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ]
  },
  "amount": 1,
  "balance": 1,
  "createdById": "ed4fdcd3-7ef1-4693-91f2-d144a957f655",
  "createdOn": "2025-06-24T05:51:51Z",
  "customFields": [
    {
      "definitionId": "90b0cb96-471e-4767-8ebd-140833d5b4dd",
      "createdById": "982c1983-9dda-4656-8bda-f3b6567b7a50",
      "createdOn": "2025-06-24T05:51:51Z",
      "description": "CustomFieldData Description",
      "id": "87997690-6b1f-4d21-bff6-d1659d8f40af",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "84fca67b-0e83-41f2-87d0-2d2ea60bbf5f",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "dueDate": "2025-06-24T05:51:51Z",
  "expenseItems": [
    {
      "accountId": "4eda80c2-0c2d-410b-ad3a-b771cf790a43",
      "amount": 1,
      "account": "account",
      "class": "class",
      "classId": "0e6e2eb7-6800-42f7-b4c3-0a3ba7a37afe",
      "createdById": "e2ff3666-8277-4429-a6a2-ee70124b1839",
      "createdOn": "2025-06-24T05:51:51Z",
      "entity": "entity",
      "entityId": "7d7fd691-adaf-41c8-beb4-967750de3966",
      "entityType": null,
      "id": "7a348332-27a6-43f7-8770-ec95b05f24d6",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "922c87c2-bb2b-4285-998d-1ae9b8655566",
      "memo": "memo",
      "objectState": null,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "id": "ea32d398-9c18-4a60-91de-85aa69a538f9",
  "integrationSourceId": "integrationSourceId",
  "lastUpdated": "2025-06-24T05:51:51Z",
  "lastUpdatedById": "4b4e1cf3-f248-4481-b4b0-349e00773cd3",
  "lineItems": [
    {
      "itemId": "47f730ab-2318-47dd-af22-29384541f8cb",
      "itemType": null,
      "projectId": "ccca0f02-f8a0-4987-9178-7a7853ab1061",
      "rate": 1,
      "units": 1,
      "amount": 1,
      "billable": true,
      "billRate": 1,
      "class": "class",
      "classId": "37b9fd24-102d-4047-8b47-2975a4861f6c",
      "createdById": "540cb7ad-30ae-4e8e-90fb-cc56db17ecfc",
      "createdOn": "2025-06-24T05:51:51Z",
      "description": "BillLineItem Description",
      "expenseAccount": "expenseAccount",
      "expenseAccountId": "95d282bd-457b-4c41-be12-185a088d7db5",
      "extra": true,
      "id": "abfda802-92d6-4ad7-a5d5-291f7fd960fa",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "42dac588-ccc7-482a-a1af-56267fb137be",
      "integrationSourceId": "integrationSourceId",
      "item": "item",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "57c75a3c-4088-42c5-81d3-e3e0c5252ef5",
      "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": "c1e8cc43-b9ee-43bd-9af8-2832a10ff49d",
  "token": 0,
  "vendor": "vendor",
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "ba313e5f-e4c7-499f-9e00-36767d65bc5f",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "1f182ddb-1506-46b1-92bc-b83e2f5d206b",
      "createdOn": "2025-06-24T05:51:51Z",
      "date": "2025-06-24T05:51:51Z",
      "id": "bd67d537-35c6-46bf-9c80-215068bc12a0",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "55c555d0-6412-4187-acb1-e0cef266fe7e",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "c59f1288-f3af-4967-8a75-9ba8f26b4e6c",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ]
}

Create a Bill

Use this method to save a bill. Pass bill as the parameter.

Request URL

base_url/bill

/bill

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

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
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
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.

Example Response

{
  "date": "2025-06-24T05:51:51Z",
  "number": "173567",
  "vendorId": "f4ce9ba2-479f-4bdb-8502-33c5f3d3e15c",
  "accountingDate": "2025-06-24T05:51:51Z",
  "accountsPayableId": "ab80fcc9-9509-46bf-b172-f3adaa21475e",
  "accountSplits": {
    "accrual": [
      {
        "account": "account",
        "accountId": "870a62f2-786e-4a2f-9e05-2dab64d8ad8d",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ],
    "cash": [
      {
        "account": "account",
        "accountId": "6e66e6cd-e4ba-4fda-85a3-bf3729574096",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ]
  },
  "amount": 1,
  "balance": 1,
  "createdById": "6572d180-f726-497f-81ad-91a94b42401e",
  "createdOn": "2025-06-24T05:51:51Z",
  "customFields": [
    {
      "definitionId": "2d0e047b-6506-41fc-83c0-8240f2d4a1f5",
      "createdById": "83969792-504f-4a8d-aff1-961688ea33ba",
      "createdOn": "2025-06-24T05:51:51Z",
      "description": "CustomFieldData Description",
      "id": "7fc16e96-02d8-40ca-80b8-e4780d8c9c61",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "1e0e5024-df7b-4acb-b175-3d8b7a718a35",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "dueDate": "2025-06-24T05:51:51Z",
  "expenseItems": [
    {
      "accountId": "b800f6c9-8115-4ede-b566-b655c651c631",
      "amount": 1,
      "account": "account",
      "class": "class",
      "classId": "439cff28-d38a-4e4b-8003-b457eec4b161",
      "createdById": "f8728d82-76fc-4c22-9df7-ad2cd47feef9",
      "createdOn": "2025-06-24T05:51:51Z",
      "entity": "entity",
      "entityId": "ace21250-5120-49c1-9ce9-9ebb860793d3",
      "entityType": null,
      "id": "53deeb05-55d2-43b2-9056-42746626e758",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "77e1083b-0a1d-48fc-9a9a-e4443542d478",
      "memo": "memo",
      "objectState": null,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "id": "da9718cb-7ed3-4a25-9eaf-158973520a09",
  "integrationSourceId": "integrationSourceId",
  "lastUpdated": "2025-06-24T05:51:51Z",
  "lastUpdatedById": "4b36df97-15b2-4b4f-bb59-803588108b0e",
  "lineItems": [
    {
      "itemId": "6261efa2-2de5-4a39-aa0f-baa9021491d6",
      "itemType": null,
      "projectId": "25b0ce56-8216-4c3c-ae84-08df2c1fca97",
      "rate": 1,
      "units": 1,
      "amount": 1,
      "billable": true,
      "billRate": 1,
      "class": "class",
      "classId": "dc538075-8eb4-49b0-b4d9-6baa014bdb17",
      "createdById": "3116d0ff-6c0f-4020-bee2-52ee63169ff2",
      "createdOn": "2025-06-24T05:51:51Z",
      "description": "BillLineItem Description",
      "expenseAccount": "expenseAccount",
      "expenseAccountId": "5924fada-216e-4e99-ad70-779143a192ac",
      "extra": true,
      "id": "81efc910-03f3-4278-8cc8-f6d6f4ddfde6",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "5128ed2b-1e76-4757-b6b8-45009815e1a1",
      "integrationSourceId": "integrationSourceId",
      "item": "item",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "44757f7f-963e-4769-a2cc-3e1100c09608",
      "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": "4ff9b431-c11b-4bc2-91eb-2eb9ac92e09f",
  "token": 0,
  "vendor": "vendor",
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "70f7d538-799f-411d-811f-d23bb7c5f9a5",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "8fcaf3ac-2f36-4f55-b693-f34b8a42affe",
      "createdOn": "2025-06-24T05:51:51Z",
      "date": "2025-06-24T05:51:51Z",
      "id": "b4d32089-943d-458a-bde2-c07a9a1d6b0a",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "65b7a94c-57d9-4f39-92c8-665edc3d5d4b",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "f428d5eb-e4a1-45a0-a0b5-a8079a7bdc81",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ]
}

Create a Bill List

Use this method to save multiple bill. Pass model as the parameter.

Request URL

base_url/bill/batch

/bill/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

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
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
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

Example Response

{
  "batchSize": 0,
  "createdById": "f91fc3de-3caa-43d7-abea-0bc6faee2b9a",
  "createdOn": "2025-06-24T05:51:52Z",
  "id": "97ea87bb-f690-4ff0-acff-576b51dfd5b9",
  "integrationSourceId": "integrationSourceId",
  "lastUpdated": "2025-06-24T05:51:52Z",
  "lastUpdatedById": "58bbcb6c-74de-4219-a24c-703717a6b513",
  "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

base_url/bill/{id}

/bill/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

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
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
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.

Example Response

{
  "date": "2025-06-24T05:51:51Z",
  "number": "173567",
  "vendorId": "1e0dafb1-464d-4d7a-9268-e22aac4b87cb",
  "accountingDate": "2025-06-24T05:51:51Z",
  "accountsPayableId": "bc9a8b4b-c745-4704-9f1e-797b1e229b49",
  "accountSplits": {
    "accrual": [
      {
        "account": "account",
        "accountId": "a7346fee-1ba1-411e-8f42-110daed76787",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ],
    "cash": [
      {
        "account": "account",
        "accountId": "5a49042c-d7d5-4fee-913f-b5aa29d2e21c",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ]
  },
  "amount": 1,
  "balance": 1,
  "createdById": "fd385f96-6036-44ee-ae45-614ecf4d1e7f",
  "createdOn": "2025-06-24T05:51:51Z",
  "customFields": [
    {
      "definitionId": "97366774-2f07-44d9-98f0-b12e671ba32c",
      "createdById": "10f973df-2b0d-4668-a9c7-abf8eb64a67f",
      "createdOn": "2025-06-24T05:51:51Z",
      "description": "CustomFieldData Description",
      "id": "3c4d5f6c-d9bc-449c-a751-5da89a1b363b",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "12ab4e20-75e3-4c1c-90a2-8d108034aa02",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "dueDate": "2025-06-24T05:51:51Z",
  "expenseItems": [
    {
      "accountId": "a6ea0ac0-23f8-432f-b5cb-d745f2de68c7",
      "amount": 1,
      "account": "account",
      "class": "class",
      "classId": "3b90aeda-d506-44ee-bf1e-5dfe0a8c2b96",
      "createdById": "eb2cfc3e-831c-4ce0-9a83-ad62540bbbee",
      "createdOn": "2025-06-24T05:51:51Z",
      "entity": "entity",
      "entityId": "fce586f7-6174-498b-a694-fbb3d3413d0c",
      "entityType": null,
      "id": "63142025-2e34-418c-b08a-727af7df4665",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "feb51481-3cf1-40af-a02c-809d1042ae1f",
      "memo": "memo",
      "objectState": null,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "id": "bc5d02a2-f1c1-40d2-bf78-e5aeefc58ed4",
  "integrationSourceId": "integrationSourceId",
  "lastUpdated": "2025-06-24T05:51:51Z",
  "lastUpdatedById": "ac5be392-a728-4e7f-938c-3534a3a43da6",
  "lineItems": [
    {
      "itemId": "0e361794-c802-4250-bc55-9b6cfd7c8f03",
      "itemType": null,
      "projectId": "c58c6af5-f996-488b-8783-dc6be5e3bb2b",
      "rate": 1,
      "units": 1,
      "amount": 1,
      "billable": true,
      "billRate": 1,
      "class": "class",
      "classId": "e7c99995-559c-49ca-b749-01a75ab628ae",
      "createdById": "0163cf13-66ac-4445-b0f3-aaa436eb6d2c",
      "createdOn": "2025-06-24T05:51:51Z",
      "description": "BillLineItem Description",
      "expenseAccount": "expenseAccount",
      "expenseAccountId": "9961ca26-b0a1-4425-8b8c-0c6e3d2049bb",
      "extra": true,
      "id": "d3997787-f0d6-404c-a3e9-2af953a20e5e",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "121e9f80-397f-4af1-a6d7-e675a98697a4",
      "integrationSourceId": "integrationSourceId",
      "item": "item",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "22bd752f-886d-40fd-b8ea-26e7f01d3f19",
      "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": "8ed55f0a-303f-4907-a730-a9801dc41d4d",
  "token": 0,
  "vendor": "vendor",
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "8eddb0fd-cc10-4508-b290-098d8d8cb0a3",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "e509eff5-2a46-4490-9a22-922155a85ae5",
      "createdOn": "2025-06-24T05:51:51Z",
      "date": "2025-06-24T05:51:51Z",
      "id": "c4f65635-7d4c-4151-a5bc-5ebc2d86a8e7",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2025-06-24T05:51:51Z",
      "lastUpdatedById": "f165f565-2481-4ecf-a1de-1c62eb786add",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "91c3ce06-ba67-49dd-9ac8-f5407bc9cb4b",
      "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

base_url/bill/{id}

/bill/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

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

base_url/bill/{id}

/bill/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

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

Bill

The Bill Object

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body