For more details on how to work with custom fields please refer to Working with custom fields guide.
The invoice object represents the main building block of the invoicing module.
You can find out more about invoicing in our Help documentation: Creating and Managing Invoices
Following diagram shows invoices in our data hierarchy:
On September 3, 2024, we've released new Tax rates system. That means that tax1_name, tax1_value, tax2_name and tax2_value attributes on Invoice object are no longer in use. You should, however, use tax_rate_id attribute on Line item objects to achieve the same goal. You can read more about this in LineItems endpoint documentation.
Invoice amount excluding tax, in the invoice currency.
Amount credited via credit notes, excluding tax, in the invoice currency.
Amount credited via credit notes, excluding tax, in the organization default currency.
Amount credited via credit notes, excluding tax, normalized to the organization default currency.
Amount credited including tax, in the invoice currency.
Amount credited including tax, in the organization default currency.
Amount credited including tax, normalized to the organization default currency.
Invoice amount excluding tax, in the organization default currency.
Invoice amount excluding tax, normalized to the organization default currency.
Amount already paid, in the invoice currency.
Amount already paid, in the organization default currency.
Amount already paid, normalized to the organization default currency.
Total tax amount, in the invoice currency.
Total tax amount, in the organization default currency.
Total tax amount, normalized to the organization default currency.
Outstanding balance, in the invoice currency.
Outstanding balance, in the organization default currency.
Outstanding balance, normalized to the organization default currency.
Invoice total including tax, in the invoice currency.
Invoice total including tax, in the organization default currency.
Invoice total including tax, normalized to the organization default currency.
Amount written off as uncollectible, in the invoice currency.
Amount written off as uncollectible, in the organization default currency.
Amount written off as uncollectible, normalized to the organization default currency.
The generated PDF document attached to this invoice.
ID of the generated PDF attachment for this invoice.
Whether this invoice was automatically generated from a template.
The bank account for payment.
Bank account details shown on the invoice.
ID of the bank account for payment.
The subsidiary contact issuing the invoice.
The client contact receiving the invoice.
The client company being billed.
ID of the client company being billed.
Name of the client company at the time of invoicing.
Company reference ID in the external accounting system.
Timestamp when the invoice was created.
Configuration options used when creating the invoice.
The person who created the invoice.
ID of the person who created the invoice.
Whether this invoice has been credited via a credit note.
Currency code of the invoice.
Organization default currency code.
Normalized currency code for cross-currency comparisons.
Files in file-type custom fields on this invoice.
People in person-type custom fields on this invoice.
Custom field values on this invoice.
ID of the budget (deal) this invoice is linked to.
Soft-deletion timestamp; present if the invoice has been deleted.
Date when the goods or services were delivered.
Discount percentage applied to the invoice total.
The PDF template used for rendering this invoice.
ID of the PDF template used for rendering this invoice.
Unique key for email-based interactions with this invoice.
Date used for currency exchange rate lookup.
Exchange rate from the invoice currency to the organization default currency.
Whether this invoice has been exported to external accounting software.
Timestamp when this invoice was exported to accounting software.
ID of this invoice in the external accounting system.
Type of accounting integration used for export.
1
2
3
4
5
6
7
8
9
10
11
URL to view this invoice in the external accounting system.
Export status to external accounting software.
1
2
Timestamp when the invoice was finalized.
Date when the invoice was finalized (locked for editing).
Footer text on the invoice document.
Footer text with template variables resolved.
Full-text search index value for this invoice.
Fuzzy date representation for flexible date-based display.
Fuzzy people representation for flexible person-based display.
Unique identifier for this invoice.
Number of days since the invoice was issued (aging).
0
1
2
3
4
Links between this invoice and the budgets it bills.
Date when the invoice was issued.
Current lifecycle state of the invoice (draft, finalized, sent, or paid).
1
2
Combined payment and lifecycle status for display purposes.
0
1
2
3
4
ID of the invoice template used for auto-generation.
Display label for the invoice type (standard invoice or credit note).
1
2
Whether this is a standard invoice or a credit note.
1
2
Method used to generate line items on this invoice.
1
2
3
The person issuing or finalizing this invoice.
ID of the person issuing or finalizing this invoice.
Quick search index value for this invoice.
Date of the last activity recorded on this invoice.
Whether tax is applied per line item rather than at the invoice level.
Internal notes on the invoice.
Invoice note with template variables resolved.
Unique invoice number.
The organization this invoice belongs to.
Overdue status indicating whether the invoice is past its due date.
1
2
Date when the invoice was paid by the client.
ID of the parent company of the client linked to this invoice, used for hierarchical company filtering.
The original invoice this credit note credits.
ID of the original invoice if this is a credit note.
Payment status of the invoice.
1
2
3
Number of days between the invoice issue date and the due date.
Due date for payment.
Payment due as relative days from the invoice issue date.
ID of the project associated with this invoice.
Client-provided purchase order number for reference.
Search index representation of this invoice.
ID of the person responsible for this invoice.
Whether this record is demo data.
Date when the invoice was sent to the client.
Sent status of the invoice.
1
2
Combined status for display purposes.
1
2
Short description of what is being invoiced.
ID of the subscriber person for this invoice.
IDs of people subscribed to notifications for this invoice.
The subsidiary issuing this invoice.
ID of the subsidiary issuing this invoice.
Tags applied to this invoice.
Tags applied to this invoice.
Name of the primary tax (e.g. VAT).
Primary tax rate percentage.
Name of the secondary tax, if applicable.
Secondary tax rate percentage.
Timestamp of the last modification to this invoice.