invoices_v1
An invoice is a financial document issued by a seller to a buyer, detailing the products or services provided, their quantities, and the agreed-upon prices.
| Column | Data type | Description |
|---|---|---|
| id | NUMBER(38,0) | The unique identifier of the invoice. |
| reference | VARCHAR(80) | The reference of the invoice that is auto populated or inputted as free text. |
| status | VARCHAR(7) | The status of the invoice. Possible values: 'Sent', 'Created', 'Paid'. |
| cancellation_state | VARCHAR(13) | The cancellation state of the invoice. Possible values: 'Cancelled', 'Not Cancelled'. |
| created_at | TIMESTAMP_TZ(9) | The timestamp with time zone offset of the invoice creation. |
| created_at_date | DATE | The date of the invoice creation. |
| created_at_time | TIME(9) | The time of the invoice creation. |
| sent_at | TIMESTAMP_TZ(9) | The timestamp with time zone offset when the invoice is sent. |
| sent_at_date | DATE | The date when the invoice is sent. |
| sent_at_time | TIME(9) | The time when the invoice is sent. |
| cancelled_at | TIMESTAMP_TZ(9) | The timestamp with time zone offset of the invoice cancellation. |
| cancelled_at_date | DATE | The date of the invoice cancellation. |
| cancelled_at_time | TIME(9) | The time of the invoice cancellation. |
| paid_at | TIMESTAMP_TZ(9) | The timestamp with time zone offset of the invoice payment. |
| paid_at_date | DATE | The date of the invoice payment. |
| paid_at_time | TIME(9) | The time of the invoice payment. |
| due_at | TIMESTAMP_TZ(9) | The timestamp with time zone offset when the invoice is due. |
| due_at_date | DATE | The date when the invoice is due. |
| due_at_time | TIME(9) | The time when the invoice is due. |
| deleted_at | TIMESTAMP_TZ(9) | The timestamp with time zone offset of invoice deletion. |
| days_to_overdue | NUMBER(9,0) | The number of days for an invoice to be overdue. |
| days_overdue | NUMBER(9,0) | The number of days an invoice is overdue by. |
| notes | VARCHAR(6000) | Notes associated with the invoice. |
| internal_notes | VARCHAR(6000) | Internal notes associated with the invoice. |
| flag | VARCHAR(100) | The current flag applied to the invoice. The flag is a marker or label used to categorise, prioritise, or highlight specific invoices. |
| flag_colour | VARCHAR(40) | The textual representation of the current flag colour set in the flag definition settings. |
| flag_comment | VARCHAR(2000) | Additional comments or notes associated with the current flag. |
| flag_date | TIMESTAMP_TZ(9) | The timestamp with the timezone offset of when the current flag was set to take effect. |
| flag_owner | VARCHAR(100) | The person responsible for setting or managing a flag. It is used to assign ownership and accountability for flagged items. |
| total_net_amount | NUMBER(9,2) | The total net amount of the invoice in the currency defined in the 'currency' column. |
| total_net_amount_gbp | NUMBER(10,2) | The total net amount of the invoice converted into GBP based on the exchange rate on the day that the invoice is created. |
| total_tax_amount | NUMBER(10,2) | The total tax (VAT) amount of the invoice in the currency defined in the 'currency' column. |
| total_tax_amount_gbp | NUMBER(10,2) | The total tax (VAT) amount of the invoice converted into GBP based on the exchange rate on the day that the invoice is created. |
| total_gross_amount | NUMBER(9,2) | The total gross (net + tax) amount of the invoice in the currency defined in the 'currency' column. |
| total_gross_amount_gbp | NUMBER(10,2) | The total gross (net + tax) amount of the invoice converted into GBP based on the exchange rate on the day that the invoice is created. |
| amount_paid | NUMBER(9,2) | The total gross amount of the invoice which has been paid already in the currency defined in the 'currency' column. |
| amount_paid_gbp | NUMBER(10,2) | The total gross amount of the invoice which has been paid already, converted into GBP based on the exchange rate on the day that the invoice is created. |
| amount_unpaid | NUMBER(10,2) | The total gross amount of the invoice remaining to be paid in the currency defined in the 'currency' column. |
| amount_unpaid_gbp | NUMBER(10,2) | The total gross amount of the invoice remaining to be paid, converted into GBP based on the exchange rate on the day that the invoice is created. |
| amount_part_paid | NUMBER(9,2) | The total gross amount paid already of the invoice when that amount is not equal total gross amount in the currency defined in the 'currency' column. |
| amount_part_paid_gbp | NUMBER(10,2) | The total gross amount paid already of the invoice when that amount is not equal total gross amount, converted into GBP based on the exchange rate on the day that the invoice is created. |
| currency | VARCHAR(3) | The ISO 4217 currency code of the invoice currency. |
| contact_name | VARCHAR(256) | The contact name responsible for the invoice. |
| contact_group | VARCHAR(100) | The contact group of the contact responsible for the invoice. |
| parent_contact | VARCHAR(256) | The parent contact of the contact responsible for the invoice. |
| web_user_name | VARCHAR(100) | The web user responsible for the invoice. |
| web_user_group | VARCHAR(400) | The group of the web user responsible for the invoice. |
| job_type | VARCHAR(200) | The job type of the job connected to the invoice. |
| job_reference | VARCHAR(88) | The job reference connected to the invoice. |
| job_group_reference | VARCHAR(80) | The job group reference connected to the invoice. |
| sales_opportunity_reference | VARCHAR(80) | The sales opportunity reference connected to the invoice. |
| contract_reference | VARCHAR(80) | The contract reference connected to the invoice. |
| nominal_code | VARCHAR(100) | A code that represents a specific nominal account or general ledger account used for accounting purposes, project tracking, cost allocation, or analysis in relation to the invoice. |
| nominal_code_description | VARCHAR(200) | A description or name that provides additional information about the nominal code used in the invoice. |
| department_code | VARCHAR(16) | A code that identifies the specific department or cost center within an organisation that is associated with the invoice. |
| department_code_description | VARCHAR(200) | A description or name that provides additional information about the department code used in the invoice. |
| delivery_site_name | VARCHAR(256) | The location or site where the products or services specified in the invoice are to be delivered. |
| tracking_code_1 | NUMBER(38,0) | A code or identifier used to track or categorise specific information related to the invoice when financial integration is set to Xero. This could be used for various purposes such as project tracking, cost allocation, or analysis. |
| tracking_code_2 | NUMBER(38,0) | Another code or identifier used to track or categorise additional information related to the invoice when financial integration is set to Xero. Similar to tracking_code_1, it can be used for various purposes based on the organisation's needs. |
| first_line_of_correspondence | VARCHAR(512) | First line of correspondence - This is the initial line of information used to address the recipient of the invoice. This field serves as the starting point for any communication related to the transaction and ensures that the document reaches the intended recipient. |
| _job_id | NUMBER(38,0) | The identifier of the job associated with the invoice. |
| _job_group_id | NUMBER(38,0) | The identifier of the job group associated with the invoice. |
| _contact_id | NUMBER(38,0) | The identifier of the contact associated with the invoice. |
| _delivery_site_contact_id | NUMBER(38,0) | The identifier of the delivery site (contact) associated with the invoice. |
| _contract_id | NUMBER(38,0) | The identifier of the contract associated with the invoice. |
| _sales_opportunity_id | NUMBER(38,0) | The identifier of the sales opportunity associated with the invoice. |
| _last_sync_at | TIMESTAMP_TZ(9) | The timestamp with time zone offset of when the invoice record was last refreshed. |