Invoice

Invoices contain billing information of all the active projects, including their approved, un-billed time and expenses. It is useful in implementing billing decisions and invoice processing. Invoice object allows you to perform the following operations:

Retrieve a specific invoice or a list of invoices
Create an invoice
Update an invoice
Delete an invoice

cURL
NODE.JS
PHP
C#
PYTHON
JAVA

Name	Description	Format	Attributes
date	Date on which an invoice was created (mm/dd/yyy). Aging begins from this invoice date	date-time	Filterable, Sortable
invoiceAmount	Total amount on an invoice	double	Filterable, Sortable
invoiceNumber	Invoice number of a created invoice. By default, CORE supports invoice numbers in a prefix-last number-suffix format	string	Filterable, Sortable MaxLength = 255
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.
balance	The outstanding amount or balance on an invoice [Balance = Invoice Amount - Paid Amount]	double	Filterable, Sortable
billingContactId	Identifier of a billing contact of the project	uuid
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	Date when an invoice is due for payment in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
expenseAmount	Amount incurred on the expenses that contribute towards the contract amount of a project	double
expenseTaxAmount	Tax charged on the expenses incurred on a project	double
extendedAccountSplit []Array: Parent object can have multiple instances of this nested object under it.	List of extended accrual account splits	AccountSplitExtended Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
fixedFee	Fixed Fee is the amount charged to a project with Cost Plus contract type. It is added to the bill amount	double
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
invoiceDetails []Array: Parent object can have multiple instances of this nested object under it.	Represents a detailed view of the invoice	InvoiceDetail Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
invoiceFrom	Start date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
invoiceTo	End date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
isDraft	Indicates whether an invoice is processed as draft or not	boolean	Filterable
isJointInvoice	Indicates whether this is a joint invoice or not	boolean	Filterable
isLateFeeInvoice	Indicates whether an invoice has late fee or not	boolean	Filterable
isManualInvoice	Indicates whether an invoice is a manual invoice or not	boolean	Filterable
isVoid	Indicates whether the invoice is void or not	boolean	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.	Service and expense line items on a manual invoice	InvoiceLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
mainExpenseTax	Main tax charged on invoiced expenses, like MET	double
mainServiceTax	Main tax charged on invoiced services or labor, like MST	double
messageOnInvoice	Message you want to display on an invoice	string
miscellaneousAmount	Any miscellaneous charges added to the invoice. It increases the bill amount	double
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.
purchaseOrderNumber	Records a purchase order number associated with a project	string
referenceNumber	It is used to identify an invoice. It is similar to the invoice number property	string	Filterable MaxLength = 200
rfNumber	Denotes a reference number used for electronic invoices	string	MaxLength = 200
serviceAmount	Amount spent on the labor or services that contribute toward the contract amount of a project	double
serviceTaxAmount	Tax charged on the services rendered on a project	double
status	Processing status of an invoice, e.g., posted or un-posted	SendBillFlag Enumerated type: Click to see possible values and their descriptions.	Filterable, Sortable
token	Represents the token for update operations	int32
type	Gets or sets the invoice type.	ModuleNames Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
version	Implements concurrency on this object	byte
workflow []Array: Parent object can have multiple instances of this nested object under it.	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.

Invoice List

Use this method to retrieve a list of invoices. Optionally pass where, orderBy and page as the query parameters to filter the result. Use this method to retrieve a list of bills. You can optionally pass where, orderBy, and page as query parameters to filter the result. The expand parameter is used to request nested properties in the model.

Request URL

base_url/invoice

/invoice

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Invoice

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 on which an invoice was created (mm/dd/yyy). Aging begins from this invoice date	date-time
invoiceAmount	Total amount on an invoice	double
invoiceNumber	Invoice number of a created invoice. By default, CORE supports invoice numbers in a prefix-last number-suffix format	string
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.
balance	The outstanding amount or balance on an invoice [Balance = Invoice Amount - Paid Amount]	double
billingContactId	Identifier of a billing contact of the project	uuid
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	Date when an invoice is due for payment in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expenseAmount	Amount incurred on the expenses that contribute towards the contract amount of a project	double
expenseTaxAmount	Tax charged on the expenses incurred on a project	double
extendedAccountSplit []Array: Parent object can have multiple instances of this nested object under it.	List of extended accrual account splits	AccountSplitExtended Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
fixedFee	Fixed Fee is the amount charged to a project with Cost Plus contract type. It is added to the bill amount	double
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
invoiceDetails []Array: Parent object can have multiple instances of this nested object under it.	Represents a detailed view of the invoice	InvoiceDetail Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
invoiceFrom	Start date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
invoiceTo	End date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
isDraft	Indicates whether an invoice is processed as draft or not	boolean
isJointInvoice	Indicates whether this is a joint invoice or not	boolean
isLateFeeInvoice	Indicates whether an invoice has late fee or not	boolean
isManualInvoice	Indicates whether an invoice is a manual invoice or not	boolean
isVoid	Indicates whether the invoice is void or not	boolean
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.	Service and expense line items on a manual invoice	InvoiceLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
mainExpenseTax	Main tax charged on invoiced expenses, like MET	double
mainServiceTax	Main tax charged on invoiced services or labor, like MST	double
messageOnInvoice	Message you want to display on an invoice	string
miscellaneousAmount	Any miscellaneous charges added to the invoice. It increases the bill amount	double
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
purchaseOrderNumber	Records a purchase order number associated with a project	string
referenceNumber	It is used to identify an invoice. It is similar to the invoice number property	string
rfNumber	Denotes a reference number used for electronic invoices	string
serviceAmount	Amount spent on the labor or services that contribute toward the contract amount of a project	double
serviceTaxAmount	Tax charged on the services rendered on a project	double
status	Processing status of an invoice, e.g., posted or un-posted	SendBillFlagEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Gets or sets the invoice type.	ModuleNames Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
version	Implements concurrency on this object	byte
workflow []Array: Parent object can have multiple instances of this nested object under it.	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": "2024-12-12T05:27:03Z",
    "invoiceAmount": 1,
    "invoiceNumber": "invoiceNumber",
    "accountSplits": {
      "accrual": [
        {
          "account": "account",
          "accountId": "1ee4dc68-3256-43d7-a6d2-6320f0163763",
          "amount": 1,
          "isDebit": true,
          "isParent": true,
          "transactionType": null
        }
      ],
      "cash": [
        {
          "account": "account",
          "accountId": "bb7dbcdd-d898-42d2-8fdf-7645c51d9b38",
          "amount": 1,
          "isDebit": true,
          "isParent": true,
          "transactionType": null
        }
      ]
    },
    "balance": 1,
    "billingContactId": "8bf2e2cd-938e-4fa2-8c11-fa3bbcc37d17",
    "createdById": "376c3386-51fb-480d-af06-69205117e5a8",
    "createdOn": "2024-12-12T05:27:03Z",
    "customFields": [
      {
        "definitionId": "551f3641-0f2e-4209-9e34-47289fa1283a",
        "createdById": "78ede5c3-15dc-4fd3-9f61-d4c3121e51d2",
        "createdOn": "2024-12-12T05:27:03Z",
        "description": "CustomFieldData Description",
        "id": "e8b07833-b9e0-4703-9a05-d61b8b17ee97",
        "integrationSourceId": "integrationSourceId",
        "label": "label",
        "lastUpdated": "2024-12-12T05:27:03Z",
        "lastUpdatedById": "dfd3d7c0-149e-4d5a-9652-110cd1b07198",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "dueDate": "2024-12-12T05:27:03Z",
    "expenseAmount": 1,
    "expenseTaxAmount": 1,
    "extendedAccountSplit": [
      {
        "account": "account",
        "accountId": "346b9c43-19bc-4edf-bd51-85532a0de056",
        "amount": 1,
        "class": "class",
        "classId": "ea02ecbe-80d2-427a-8643-28df026e3194",
        "isDebit": true,
        "isParent": true,
        "project": "project",
        "projectId": "e7e56549-5b60-491c-81e1-17f879370372",
        "transactionType": null
      }
    ],
    "fixedFee": 1,
    "id": "3b4d0bd3-69fe-46dd-ba87-9db931b40988",
    "integrationSourceId": "integrationSourceId",
    "invoiceDetails": [
      {
        "clientId": "0cb06af1-cc39-4f12-967d-cbaecf59a8d6",
        "invoiceId": "e18ae05f-7343-48c5-acfe-a7b3be968961",
        "projectId": "be5ae095-021f-41b6-96e4-10e77cc0f409",
        "amount": 1,
        "class": "class",
        "classId": "ded515d2-3028-4130-8544-21d9bd6efee2",
        "client": "client",
        "createdById": "61cb3b65-97d1-4fea-bf55-2baa5bb51b48",
        "createdOn": "2024-12-12T05:27:03Z",
        "discount": 1,
        "expenseAmount": 1,
        "expenseTaxAmount": 1,
        "fixedFee": 1,
        "id": "5760af24-1753-4126-bad1-48cd067d721c",
        "incomeAccount": "incomeAccount",
        "incomeAccountId": "b2cbe2c5-deff-4b73-9b5c-8be410869f2f",
        "integrationSourceId": "integrationSourceId",
        "lastUpdated": "2024-12-12T05:27:03Z",
        "lastUpdatedById": "1c102eb4-b311-440d-a55b-c075e251d0fc",
        "liabilityAccount": "liabilityAccount",
        "liabilityAccountId": "840df542-aee5-4ae3-aa8b-5a8016fcd291",
        "mainExpenseTax": 1,
        "mainServiceTax": 1,
        "memo1": "memo1",
        "memo2": "memo2",
        "objectState": null,
        "project": "project",
        "receivableAccount": "receivableAccount",
        "receivableAccountId": "4914d205-3144-4e89-beea-9102c834ac35",
        "retainageAmount": 1,
        "rootProjectId": "48942298-1df4-4ba5-8780-6999dc61bb0f",
        "serviceAmount": 1,
        "serviceTaxAmount": 1,
        "term": "term",
        "termId": "35662feb-fbff-4d1a-9914-657054dc4c98",
        "token": 0,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "invoiceFrom": "2024-12-12T05:27:03Z",
    "invoiceTo": "2024-12-12T05:27:03Z",
    "isDraft": true,
    "isJointInvoice": true,
    "isLateFeeInvoice": true,
    "isManualInvoice": true,
    "isVoid": true,
    "lastUpdated": "2024-12-12T05:27:03Z",
    "lastUpdatedById": "ffbeb8ec-f1c8-4806-b320-bf9de2d7d000",
    "lineItems": [
      {
        "description": "InvoiceLineItem Description",
        "invoiceId": "efff4283-1383-4ea0-b903-e8263a77e7a2",
        "rate": 1,
        "units": 1,
        "amount": 1,
        "chargeAmount": 1,
        "class": "class",
        "classId": "8f4bee27-6d82-4367-8caa-b3225ddaa9d6",
        "createdById": "cd376493-b2c2-4c18-8bc7-67fd8a6209c3",
        "createdOn": "2024-12-12T05:27:03Z",
        "expenseAccount": "expenseAccount",
        "expenseAccountId": "2910db0c-2337-4549-bebd-35da2e4bf3dd",
        "id": "4b72ebb3-8967-4bfb-ada7-cd88705e2a26",
        "incomeAccount": "incomeAccount",
        "incomeAccountId": "762d50b5-5657-4a01-b94e-7c4d9f550acd",
        "integrationSourceId": "integrationSourceId",
        "isExpense": true,
        "item": "item",
        "itemId": "dc1b4cf9-3b67-4959-b3fe-d45bcd5f6212",
        "lastUpdated": "2024-12-12T05:27:03Z",
        "lastUpdatedById": "07da5788-87b6-47ff-8034-69ebdd51c0d0",
        "objectState": null,
        "tax": 1,
        "token": 0,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "mainExpenseTax": 1,
    "mainServiceTax": 1,
    "messageOnInvoice": "messageOnInvoice",
    "miscellaneousAmount": 1,
    "objectState": null,
    "purchaseOrderNumber": "purchaseOrderNumber",
    "referenceNumber": "referenceNumber",
    "rfNumber": "rfNumber",
    "serviceAmount": 1,
    "serviceTaxAmount": 1,
    "status": null,
    "token": 0,
    "type": {},
    "version": "U3dhZ2dlciByb2Nrcw==",
    "workflow": [
      {
        "actionById": "c09a9225-5a4a-489b-a25a-ec3fedba3386",
        "action": null,
        "actionBy": "actionBy",
        "createdById": "20c3a2f0-ca43-4c53-a3f4-ded26dd18dca",
        "createdOn": "2024-12-12T05:27:03Z",
        "date": "2024-12-12T05:27:03Z",
        "id": "57eb6965-5b9e-4af8-b6be-3a4547c7d9b3",
        "integrationSourceId": "integrationSourceId",
        "lastUpdated": "2024-12-12T05:27:03Z",
        "lastUpdatedById": "eaca900b-540b-4561-b5cd-0a66ff450411",
        "memo": "memo",
        "objectState": null,
        "sendTo": "sendTo",
        "sendToId": "45ba1011-2f93-4e47-aa66-39f97a9ff8a3",
        "submitTo": null,
        "token": 0,
        "type": null,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ]
  }
]

Retrieve an Invoice

Use this method to retrieve a specific invoice. Pass id as the parameter.

Request URL

base_url/invoice/{id}

/invoice/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Invoice

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Invoice identifier	string

Response Body

Name	Description	Format
date	Date on which an invoice was created (mm/dd/yyy). Aging begins from this invoice date	date-time
invoiceAmount	Total amount on an invoice	double
invoiceNumber	Invoice number of a created invoice. By default, CORE supports invoice numbers in a prefix-last number-suffix format	string
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.
balance	The outstanding amount or balance on an invoice [Balance = Invoice Amount - Paid Amount]	double
billingContactId	Identifier of a billing contact of the project	uuid
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	Date when an invoice is due for payment in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expenseAmount	Amount incurred on the expenses that contribute towards the contract amount of a project	double
expenseTaxAmount	Tax charged on the expenses incurred on a project	double
extendedAccountSplit []Array: Parent object can have multiple instances of this nested object under it.	List of extended accrual account splits	AccountSplitExtended Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
fixedFee	Fixed Fee is the amount charged to a project with Cost Plus contract type. It is added to the bill amount	double
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
invoiceDetails []Array: Parent object can have multiple instances of this nested object under it.	Represents a detailed view of the invoice	InvoiceDetail Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
invoiceFrom	Start date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
invoiceTo	End date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
isDraft	Indicates whether an invoice is processed as draft or not	boolean
isJointInvoice	Indicates whether this is a joint invoice or not	boolean
isLateFeeInvoice	Indicates whether an invoice has late fee or not	boolean
isManualInvoice	Indicates whether an invoice is a manual invoice or not	boolean
isVoid	Indicates whether the invoice is void or not	boolean
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.	Service and expense line items on a manual invoice	InvoiceLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
mainExpenseTax	Main tax charged on invoiced expenses, like MET	double
mainServiceTax	Main tax charged on invoiced services or labor, like MST	double
messageOnInvoice	Message you want to display on an invoice	string
miscellaneousAmount	Any miscellaneous charges added to the invoice. It increases the bill amount	double
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
purchaseOrderNumber	Records a purchase order number associated with a project	string
referenceNumber	It is used to identify an invoice. It is similar to the invoice number property	string
rfNumber	Denotes a reference number used for electronic invoices	string
serviceAmount	Amount spent on the labor or services that contribute toward the contract amount of a project	double
serviceTaxAmount	Tax charged on the services rendered on a project	double
status	Processing status of an invoice, e.g., posted or un-posted	SendBillFlagEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Gets or sets the invoice type.	ModuleNames Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
version	Implements concurrency on this object	byte
workflow []Array: Parent object can have multiple instances of this nested object under it.	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": "2024-12-12T05:27:04Z",
  "invoiceAmount": 1,
  "invoiceNumber": "invoiceNumber",
  "accountSplits": {
    "accrual": [
      {
        "account": "account",
        "accountId": "39392cc6-a864-4944-bf14-709416c9767a",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ],
    "cash": [
      {
        "account": "account",
        "accountId": "dfc85d25-a953-45ca-a0a8-ea8d503c7918",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ]
  },
  "balance": 1,
  "billingContactId": "b0a704ba-4f7b-4623-b155-cfed9faed702",
  "createdById": "f9fb3a9b-b51b-46d2-8a1f-54edb74ed126",
  "createdOn": "2024-12-12T05:27:04Z",
  "customFields": [
    {
      "definitionId": "c40f6a39-1826-4a27-aaee-0fd93acfc3c5",
      "createdById": "d0209338-6442-4087-83cd-8e5d29efc212",
      "createdOn": "2024-12-12T05:27:04Z",
      "description": "CustomFieldData Description",
      "id": "3eabea60-ece0-450b-b032-403d204cd39d",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "ad658387-5e85-4422-b07c-4729e58c951f",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "dueDate": "2024-12-12T05:27:04Z",
  "expenseAmount": 1,
  "expenseTaxAmount": 1,
  "extendedAccountSplit": [
    {
      "account": "account",
      "accountId": "a31d9fe7-748a-4f36-9c77-a1bf4b168444",
      "amount": 1,
      "class": "class",
      "classId": "9f432996-f33c-4baa-93ad-e9dfedf6aa1a",
      "isDebit": true,
      "isParent": true,
      "project": "project",
      "projectId": "4c43de52-0415-4480-998d-4d62040d8a73",
      "transactionType": null
    }
  ],
  "fixedFee": 1,
  "id": "81f9c54f-fc98-471f-8366-5bae5081e02b",
  "integrationSourceId": "integrationSourceId",
  "invoiceDetails": [
    {
      "clientId": "5742abd3-49df-44d5-a47a-571d7e24877b",
      "invoiceId": "7036e849-cfd2-4823-92f0-f8e39e471ca0",
      "projectId": "27661fd9-03b8-44a9-9f92-483556b7f836",
      "amount": 1,
      "class": "class",
      "classId": "a424a334-1685-47be-9db9-9a3cafe41743",
      "client": "client",
      "createdById": "f85209d2-7dd2-46fd-be98-7937140966b0",
      "createdOn": "2024-12-12T05:27:04Z",
      "discount": 1,
      "expenseAmount": 1,
      "expenseTaxAmount": 1,
      "fixedFee": 1,
      "id": "9e549af6-c463-40ff-b3bd-b7c7e1035e23",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "9778ee3c-6d3c-4751-872f-d436e2c5ab3f",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "bb43d4b7-cb78-49e6-8892-f10325b656c2",
      "liabilityAccount": "liabilityAccount",
      "liabilityAccountId": "efcb072e-e171-45b0-9054-c56a1acb0862",
      "mainExpenseTax": 1,
      "mainServiceTax": 1,
      "memo1": "memo1",
      "memo2": "memo2",
      "objectState": null,
      "project": "project",
      "receivableAccount": "receivableAccount",
      "receivableAccountId": "94ed49cb-428a-42a9-8324-f20de1d0adbd",
      "retainageAmount": 1,
      "rootProjectId": "dc72e286-f56a-4753-820f-3ab6a72768bf",
      "serviceAmount": 1,
      "serviceTaxAmount": 1,
      "term": "term",
      "termId": "7f3f880f-ba98-4cd1-bfab-7a47c9330d7c",
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "invoiceFrom": "2024-12-12T05:27:04Z",
  "invoiceTo": "2024-12-12T05:27:04Z",
  "isDraft": true,
  "isJointInvoice": true,
  "isLateFeeInvoice": true,
  "isManualInvoice": true,
  "isVoid": true,
  "lastUpdated": "2024-12-12T05:27:04Z",
  "lastUpdatedById": "ac6fe951-ab2a-43e1-a426-df9fe6bd0610",
  "lineItems": [
    {
      "description": "InvoiceLineItem Description",
      "invoiceId": "7ae2b923-d20a-4984-a288-8518b16b3854",
      "rate": 1,
      "units": 1,
      "amount": 1,
      "chargeAmount": 1,
      "class": "class",
      "classId": "141094e5-fb18-4196-9f40-02f6ebcf102b",
      "createdById": "82435a5c-0868-446e-8fb9-89d22825f0f1",
      "createdOn": "2024-12-12T05:27:04Z",
      "expenseAccount": "expenseAccount",
      "expenseAccountId": "da29e016-18e0-47b1-b424-e18c393ba4c3",
      "id": "595e265b-14de-462a-888d-35a4bb4d4a42",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "38b8c0c7-2471-4ac4-bcd1-f63a9e016cdc",
      "integrationSourceId": "integrationSourceId",
      "isExpense": true,
      "item": "item",
      "itemId": "e7370707-a947-4669-8cb5-234f02fd16f2",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "c2fe2fe4-92ea-4b4e-85ca-8f4fc449c5ed",
      "objectState": null,
      "tax": 1,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "mainExpenseTax": 1,
  "mainServiceTax": 1,
  "messageOnInvoice": "messageOnInvoice",
  "miscellaneousAmount": 1,
  "objectState": null,
  "purchaseOrderNumber": "purchaseOrderNumber",
  "referenceNumber": "referenceNumber",
  "rfNumber": "rfNumber",
  "serviceAmount": 1,
  "serviceTaxAmount": 1,
  "status": null,
  "token": 0,
  "type": {},
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "351d6c3a-32aa-4a5a-811e-2672a9b11135",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "1cc74c26-e312-4eed-87ab-6d15e925cc01",
      "createdOn": "2024-12-12T05:27:04Z",
      "date": "2024-12-12T05:27:04Z",
      "id": "e68828a1-0fcd-431b-8f89-726f0a0d7548",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "9706dd5a-03ee-4334-a8f0-8a95a37dad57",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "b798f506-deda-4c34-b059-c191293ced99",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ]
}

Create an Invoice

Use this method to save an invoice. Pass invoice as the parameter.

Request URL

base_url/invoice

/invoice

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Invoice

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Invoice object	Invoice

Response Body

Name	Description	Format
date	Date on which an invoice was created (mm/dd/yyy). Aging begins from this invoice date	date-time
invoiceAmount	Total amount on an invoice	double
invoiceNumber	Invoice number of a created invoice. By default, CORE supports invoice numbers in a prefix-last number-suffix format	string
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.
balance	The outstanding amount or balance on an invoice [Balance = Invoice Amount - Paid Amount]	double
billingContactId	Identifier of a billing contact of the project	uuid
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	Date when an invoice is due for payment in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expenseAmount	Amount incurred on the expenses that contribute towards the contract amount of a project	double
expenseTaxAmount	Tax charged on the expenses incurred on a project	double
extendedAccountSplit []Array: Parent object can have multiple instances of this nested object under it.	List of extended accrual account splits	AccountSplitExtended Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
fixedFee	Fixed Fee is the amount charged to a project with Cost Plus contract type. It is added to the bill amount	double
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
invoiceDetails []Array: Parent object can have multiple instances of this nested object under it.	Represents a detailed view of the invoice	InvoiceDetail Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
invoiceFrom	Start date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
invoiceTo	End date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
isDraft	Indicates whether an invoice is processed as draft or not	boolean
isJointInvoice	Indicates whether this is a joint invoice or not	boolean
isLateFeeInvoice	Indicates whether an invoice has late fee or not	boolean
isManualInvoice	Indicates whether an invoice is a manual invoice or not	boolean
isVoid	Indicates whether the invoice is void or not	boolean
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.	Service and expense line items on a manual invoice	InvoiceLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
mainExpenseTax	Main tax charged on invoiced expenses, like MET	double
mainServiceTax	Main tax charged on invoiced services or labor, like MST	double
messageOnInvoice	Message you want to display on an invoice	string
miscellaneousAmount	Any miscellaneous charges added to the invoice. It increases the bill amount	double
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
purchaseOrderNumber	Records a purchase order number associated with a project	string
referenceNumber	It is used to identify an invoice. It is similar to the invoice number property	string
rfNumber	Denotes a reference number used for electronic invoices	string
serviceAmount	Amount spent on the labor or services that contribute toward the contract amount of a project	double
serviceTaxAmount	Tax charged on the services rendered on a project	double
status	Processing status of an invoice, e.g., posted or un-posted	SendBillFlagEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Gets or sets the invoice type.	ModuleNames Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
version	Implements concurrency on this object	byte
workflow []Array: Parent object can have multiple instances of this nested object under it.	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": "2024-12-12T05:27:03Z",
  "invoiceAmount": 1,
  "invoiceNumber": "invoiceNumber",
  "accountSplits": {
    "accrual": [
      {
        "account": "account",
        "accountId": "8bc527cc-34da-404b-9faa-67fcbabc7386",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ],
    "cash": [
      {
        "account": "account",
        "accountId": "f1ee9c85-45b1-4ba5-8170-7e6eaecc963e",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ]
  },
  "balance": 1,
  "billingContactId": "9146bb13-1fcb-4579-85af-7b79ee62c303",
  "createdById": "0d76d27d-d986-4d3c-8033-bb708fe30a0b",
  "createdOn": "2024-12-12T05:27:03Z",
  "customFields": [
    {
      "definitionId": "40de4f91-868f-48aa-9773-7f6b1c09aecf",
      "createdById": "c4d4d551-b418-4af5-ac4a-028ba6f067a6",
      "createdOn": "2024-12-12T05:27:03Z",
      "description": "CustomFieldData Description",
      "id": "4d0b4d51-c21f-4e9a-b9c4-74937f96fff8",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2024-12-12T05:27:03Z",
      "lastUpdatedById": "8e17ffc0-7cf1-4785-8ac6-072410312e72",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "dueDate": "2024-12-12T05:27:03Z",
  "expenseAmount": 1,
  "expenseTaxAmount": 1,
  "extendedAccountSplit": [
    {
      "account": "account",
      "accountId": "71f1ae9f-8c4e-40e6-90e7-322636160b02",
      "amount": 1,
      "class": "class",
      "classId": "e40c31c9-be01-4f58-b076-2afd93a69c72",
      "isDebit": true,
      "isParent": true,
      "project": "project",
      "projectId": "b9ecbe8a-d7de-4e10-9338-df9f5b9c1223",
      "transactionType": null
    }
  ],
  "fixedFee": 1,
  "id": "f4826b29-6460-4bad-8368-69b1733aff9e",
  "integrationSourceId": "integrationSourceId",
  "invoiceDetails": [
    {
      "clientId": "0ba6557b-9470-4760-ad43-96665c5fb2a6",
      "invoiceId": "880db617-ccd7-4637-904b-97370a273316",
      "projectId": "33cd80c0-2dc5-4e3c-b450-07174f8c6a0d",
      "amount": 1,
      "class": "class",
      "classId": "d552e648-b68a-41e2-9697-f82c8b7cc10b",
      "client": "client",
      "createdById": "1c6c2b94-c4b0-44df-9b7f-5492a48ed869",
      "createdOn": "2024-12-12T05:27:04Z",
      "discount": 1,
      "expenseAmount": 1,
      "expenseTaxAmount": 1,
      "fixedFee": 1,
      "id": "0c4f9046-da72-49c8-b1bd-ea313625bb68",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "3602c6a4-4a03-476f-8ea0-9cf2bfc6e101",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "b82af94c-4622-4113-acba-28edb134959e",
      "liabilityAccount": "liabilityAccount",
      "liabilityAccountId": "6ad88fcf-811c-4db4-b7da-25b0d9c8dea7",
      "mainExpenseTax": 1,
      "mainServiceTax": 1,
      "memo1": "memo1",
      "memo2": "memo2",
      "objectState": null,
      "project": "project",
      "receivableAccount": "receivableAccount",
      "receivableAccountId": "7e703ceb-258f-4f67-a986-8e943d38d294",
      "retainageAmount": 1,
      "rootProjectId": "6ae3ab46-9572-48a1-ae8c-ea5b19b5913d",
      "serviceAmount": 1,
      "serviceTaxAmount": 1,
      "term": "term",
      "termId": "fd6b6d9a-4193-4787-a0b7-31d71186148b",
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "invoiceFrom": "2024-12-12T05:27:04Z",
  "invoiceTo": "2024-12-12T05:27:04Z",
  "isDraft": true,
  "isJointInvoice": true,
  "isLateFeeInvoice": true,
  "isManualInvoice": true,
  "isVoid": true,
  "lastUpdated": "2024-12-12T05:27:04Z",
  "lastUpdatedById": "13b0bb86-f4d1-4994-ae46-4ff46c3e55bf",
  "lineItems": [
    {
      "description": "InvoiceLineItem Description",
      "invoiceId": "2f5f43a1-9fc3-4d44-9e09-f6932d932ec2",
      "rate": 1,
      "units": 1,
      "amount": 1,
      "chargeAmount": 1,
      "class": "class",
      "classId": "6fe55bb1-76d4-4743-b520-5094f8de0156",
      "createdById": "622890e1-20d6-45a7-8923-02d7d0a9dafd",
      "createdOn": "2024-12-12T05:27:04Z",
      "expenseAccount": "expenseAccount",
      "expenseAccountId": "b7ad4086-1449-4242-811e-c43a838d6427",
      "id": "6efcfce5-d822-4747-82d0-17792df938d7",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "a3d290b3-fa43-4ae4-a76e-19d3490ceb73",
      "integrationSourceId": "integrationSourceId",
      "isExpense": true,
      "item": "item",
      "itemId": "e9e6dfb2-744f-4752-ac59-c37010727e92",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "fb1469b2-30bc-421d-9602-839829df8096",
      "objectState": null,
      "tax": 1,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "mainExpenseTax": 1,
  "mainServiceTax": 1,
  "messageOnInvoice": "messageOnInvoice",
  "miscellaneousAmount": 1,
  "objectState": null,
  "purchaseOrderNumber": "purchaseOrderNumber",
  "referenceNumber": "referenceNumber",
  "rfNumber": "rfNumber",
  "serviceAmount": 1,
  "serviceTaxAmount": 1,
  "status": null,
  "token": 0,
  "type": {},
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "9017ac4c-8c4e-478b-88b6-d78eb58c7d20",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "cbfb2947-6524-45b3-8bed-0e4f5342f05d",
      "createdOn": "2024-12-12T05:27:04Z",
      "date": "2024-12-12T05:27:04Z",
      "id": "02c151c1-5b7f-40be-8296-92de634c4b7b",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "eb9608cd-f165-41fe-85a8-1f59f6fcafc2",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "817ea656-c08b-44cb-b339-bff436811b71",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ]
}

Update an Invoice

Use this method to update an invoice. Pass id and invoice as the parameters.

Request URL

base_url/invoice/{id}

/invoice/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Invoice

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Invoice identifier	string
body	Body	Invoice object	Invoice

Response Body

Name	Description	Format
date	Date on which an invoice was created (mm/dd/yyy). Aging begins from this invoice date	date-time
invoiceAmount	Total amount on an invoice	double
invoiceNumber	Invoice number of a created invoice. By default, CORE supports invoice numbers in a prefix-last number-suffix format	string
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.
balance	The outstanding amount or balance on an invoice [Balance = Invoice Amount - Paid Amount]	double
billingContactId	Identifier of a billing contact of the project	uuid
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	Date when an invoice is due for payment in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
expenseAmount	Amount incurred on the expenses that contribute towards the contract amount of a project	double
expenseTaxAmount	Tax charged on the expenses incurred on a project	double
extendedAccountSplit []Array: Parent object can have multiple instances of this nested object under it.	List of extended accrual account splits	AccountSplitExtended Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
fixedFee	Fixed Fee is the amount charged to a project with Cost Plus contract type. It is added to the bill amount	double
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
invoiceDetails []Array: Parent object can have multiple instances of this nested object under it.	Represents a detailed view of the invoice	InvoiceDetail Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
invoiceFrom	Start date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
invoiceTo	End date of a billing period in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
isDraft	Indicates whether an invoice is processed as draft or not	boolean
isJointInvoice	Indicates whether this is a joint invoice or not	boolean
isLateFeeInvoice	Indicates whether an invoice has late fee or not	boolean
isManualInvoice	Indicates whether an invoice is a manual invoice or not	boolean
isVoid	Indicates whether the invoice is void or not	boolean
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.	Service and expense line items on a manual invoice	InvoiceLineItem Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
mainExpenseTax	Main tax charged on invoiced expenses, like MET	double
mainServiceTax	Main tax charged on invoiced services or labor, like MST	double
messageOnInvoice	Message you want to display on an invoice	string
miscellaneousAmount	Any miscellaneous charges added to the invoice. It increases the bill amount	double
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
purchaseOrderNumber	Records a purchase order number associated with a project	string
referenceNumber	It is used to identify an invoice. It is similar to the invoice number property	string
rfNumber	Denotes a reference number used for electronic invoices	string
serviceAmount	Amount spent on the labor or services that contribute toward the contract amount of a project	double
serviceTaxAmount	Tax charged on the services rendered on a project	double
status	Processing status of an invoice, e.g., posted or un-posted	SendBillFlagEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Gets or sets the invoice type.	ModuleNames Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
version	Implements concurrency on this object	byte
workflow []Array: Parent object can have multiple instances of this nested object under it.	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": "2024-12-12T05:27:04Z",
  "invoiceAmount": 1,
  "invoiceNumber": "invoiceNumber",
  "accountSplits": {
    "accrual": [
      {
        "account": "account",
        "accountId": "6637c4d3-3a03-419f-a265-942837e151aa",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ],
    "cash": [
      {
        "account": "account",
        "accountId": "50b6b20f-31cb-4902-b5fb-5780d8b71a60",
        "amount": 1,
        "isDebit": true,
        "isParent": true,
        "transactionType": null
      }
    ]
  },
  "balance": 1,
  "billingContactId": "9206d7e7-b6f6-4b55-9e50-fc6a20776eda",
  "createdById": "17c9fe26-8dfb-4b68-9540-a46f3a52b8cc",
  "createdOn": "2024-12-12T05:27:04Z",
  "customFields": [
    {
      "definitionId": "4d769c44-3287-416e-9926-11cad9fad4eb",
      "createdById": "51b1e5b6-70f5-4a34-a519-1fc25d462fa1",
      "createdOn": "2024-12-12T05:27:04Z",
      "description": "CustomFieldData Description",
      "id": "80de58c7-7a05-4aa3-89b6-682a5e315e74",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "f88d3cb2-b349-44c5-ac12-cdc4197f1e6f",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "dueDate": "2024-12-12T05:27:04Z",
  "expenseAmount": 1,
  "expenseTaxAmount": 1,
  "extendedAccountSplit": [
    {
      "account": "account",
      "accountId": "caa87b11-ba1c-418c-8099-75a92c1f6b7d",
      "amount": 1,
      "class": "class",
      "classId": "35644606-56e1-4c41-9949-c7ad51529ec4",
      "isDebit": true,
      "isParent": true,
      "project": "project",
      "projectId": "cb1deae3-459b-4f5a-8be2-b4c8b94a2b94",
      "transactionType": null
    }
  ],
  "fixedFee": 1,
  "id": "9858ed91-c5ab-46a0-8127-0b0ddd98ab55",
  "integrationSourceId": "integrationSourceId",
  "invoiceDetails": [
    {
      "clientId": "e35e5bea-6e62-4b8d-b622-22b3b079740f",
      "invoiceId": "6d9c7bd0-e615-4e30-abc4-8eb9a62fc755",
      "projectId": "399b46fa-ad16-4f8c-b40c-40ed2c03df90",
      "amount": 1,
      "class": "class",
      "classId": "ccb0ffd0-1090-477e-8ced-cdfdbb2ef589",
      "client": "client",
      "createdById": "426448e5-0089-4b16-8749-e2591380e042",
      "createdOn": "2024-12-12T05:27:04Z",
      "discount": 1,
      "expenseAmount": 1,
      "expenseTaxAmount": 1,
      "fixedFee": 1,
      "id": "c7071fb3-e75b-4128-ad58-721b39c77783",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "f4fb2dae-2b89-4861-ad5b-ee576251dda5",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "f9f00122-105f-4e2d-97fa-9a7130fec487",
      "liabilityAccount": "liabilityAccount",
      "liabilityAccountId": "b804a03c-738b-4b92-8501-cc03f4006561",
      "mainExpenseTax": 1,
      "mainServiceTax": 1,
      "memo1": "memo1",
      "memo2": "memo2",
      "objectState": null,
      "project": "project",
      "receivableAccount": "receivableAccount",
      "receivableAccountId": "13556b68-efa9-4be9-b25a-ca340267e3de",
      "retainageAmount": 1,
      "rootProjectId": "f0fd9185-1e75-4306-881e-765181ae9950",
      "serviceAmount": 1,
      "serviceTaxAmount": 1,
      "term": "term",
      "termId": "4dd97e3f-a4eb-4009-9deb-81b0dff2fedf",
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "invoiceFrom": "2024-12-12T05:27:04Z",
  "invoiceTo": "2024-12-12T05:27:04Z",
  "isDraft": true,
  "isJointInvoice": true,
  "isLateFeeInvoice": true,
  "isManualInvoice": true,
  "isVoid": true,
  "lastUpdated": "2024-12-12T05:27:04Z",
  "lastUpdatedById": "cacb9997-3cfc-461f-a505-20ec45157b7a",
  "lineItems": [
    {
      "description": "InvoiceLineItem Description",
      "invoiceId": "7ae5dbd5-2b15-4c48-a96f-78a3e4b969c0",
      "rate": 1,
      "units": 1,
      "amount": 1,
      "chargeAmount": 1,
      "class": "class",
      "classId": "6c51c778-bee8-4e51-806c-33040d49de12",
      "createdById": "bb20584c-9509-4912-9c25-0ad70ff453a5",
      "createdOn": "2024-12-12T05:27:04Z",
      "expenseAccount": "expenseAccount",
      "expenseAccountId": "e9709c11-c9dd-4894-9a52-45c3d8bc1236",
      "id": "e397d764-301c-47b6-bc79-3d8ae7db443d",
      "incomeAccount": "incomeAccount",
      "incomeAccountId": "f4385da1-b442-42a5-9b7b-87d50ae758f6",
      "integrationSourceId": "integrationSourceId",
      "isExpense": true,
      "item": "item",
      "itemId": "7a80328a-f511-4a81-841d-063ca43419c2",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "06c269f9-b72f-4a2c-9286-ec7f74e11b82",
      "objectState": null,
      "tax": 1,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "mainExpenseTax": 1,
  "mainServiceTax": 1,
  "messageOnInvoice": "messageOnInvoice",
  "miscellaneousAmount": 1,
  "objectState": null,
  "purchaseOrderNumber": "purchaseOrderNumber",
  "referenceNumber": "referenceNumber",
  "rfNumber": "rfNumber",
  "serviceAmount": 1,
  "serviceTaxAmount": 1,
  "status": null,
  "token": 0,
  "type": {},
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "5d330cda-2b7e-4124-a7f9-7f255c4a360b",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "d16e1a7e-df98-4396-817f-addfa9caf7d8",
      "createdOn": "2024-12-12T05:27:04Z",
      "date": "2024-12-12T05:27:04Z",
      "id": "2e8e5ae5-1ca3-45ea-a19c-d91f829b3770",
      "integrationSourceId": "integrationSourceId",
      "lastUpdated": "2024-12-12T05:27:04Z",
      "lastUpdatedById": "e03f6881-05e1-4e36-9ff5-400098f27d99",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "ba9dfbaf-4f88-4fcc-90b7-56a416e19cfe",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ]
}

Update an Invoice Attach

Use this method to attach time and expense entries to an invoice. Pass id and attachTimeExpense as the parameters.

Request URL

base_url/invoice/{id}/attach

/invoice/{id}/attach

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Invoice

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Invoice identifier	string
body	Body	AttachTimeExpense object	AttachTimeExpense

Delete an Invoice

Use this method to delete an invoice. Pass id as the parameter.

Request URL

base_url/invoice/{id}

/invoice/{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	Invoice identifier	string

Invoice

The Invoice 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

Request URL

Method Overview

Request Parameters asterisk denotes required