Invoices: Bouw7 Invoices
popular read only REST
- Catalog:
Bouw7 - Schema:
Invoicing - Label: Invoices
Returns a list of invoices associated with the organization. Returns a list of invoices associated with the organization.
Can only retrieve data.
Summary
Returns a list of invoices associated with the organization.
API Source
- Endpoint:
/list/invoices - Operation:
get /list/invoices
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 90 |
| Full scan rows per minute | 359,000 |
| Point query rows per minute | 666 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
q |
`` | A Heimdall Query Language string. |
Table Columns
The columns of the table Invoices are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
branch_ |
int64 |
Branch ID | filters on the platform, writable, branch. |
The ID of the branch. | |
branch_ |
varchar2 |
Branch Name | filters on the platform, writable, branch. |
The name of the branch. | |
contact |
varchar2 |
Contact Person Name | filters on the platform, writable, contact |
The contact person for this invoice. Value can be NULL if undefined. | |
contact_ |
varchar2 |
Contact Email Address | filters on the platform, writable, contact. |
The email address of the contact. | |
contact_ |
int64 |
Contact ID | filters on the platform, writable, contact. |
The ID of the contact. | |
contact_ |
varchar2 |
Contact Name | filters on the platform, writable, contact. |
The name of this contact. | |
contact_ |
varchar2 |
Contact Type | filters on the platform, writable, contact. |
The type of this contact. | |
contact_ |
int64 |
Contact Type ID | filters on the platform, writable, contact. |
The type ID of this contact. | |
created |
datetime |
Created at | filters on the platform, writable, created |
The creation date of the object in ATOM/ISO-8601 format | |
created |
int64 |
Created by ID | filters on the platform, writable, created |
The ID of the user. | |
created |
varchar2 |
Created by User Name | filters on the platform, writable, created |
The username of the user. | |
date |
datetime |
Date | filters on the platform, writable, date |
The invoice date in YYYY-MM-DD format, or NULL if the invoice date has not been set. | |
date |
varchar2 |
Date Paid | filters on the platform, writable, date |
The date when the invoice was paid in YYYY-MM-DD format, or NULL if the invoice is unpaid. | |
debtor |
varchar2 |
Debtor Number | filters on the platform, writable, debtor |
The debtor number of the contact associated with this invoice. | |
division_ |
varchar2 |
Division Description | filters on the platform, writable, division. |
The description of the division. | |
division_ |
varchar2 |
Division Exact Division ID | filters on the platform, writable, division. |
The division ID of an Exact Online environment. | |
division_ |
varchar2 |
Division General Ledger Account Code | filters on the platform, writable, division. |
A default general ledger account code to use for sales related items. | |
division_ |
varchar2 |
Division General Ledger Account Code Purchase | filters on the platform, writable, division. |
A default general ledger account code to use for purchase related items. | |
division_ |
int64 |
Division ID | filters on the platform, writable, division. |
The ID of the division. | |
division_ |
varchar2 |
Division Journal Code | filters on the platform, writable, division. |
A default journal code to use for sales related items. | |
division_ |
varchar2 |
Division Journal Code Purchase | filters on the platform, writable, division. |
A default journal code to use for purchase related items. | |
due |
datetime |
Due Date | filters on the platform, writable, due |
The invoice date in YYYY-MM-DD format, or NULL if the invoice due date has not been set. | |
id |
int64 |
ID | filters on the platform, writable, id |
The ID of invoice. | |
invoice |
varchar2 |
Invoice Number | filters on the platform, writable, invoice |
The number of invoice. | |
is |
char |
Is Booked in AFAS | filters on the platform, writable, is |
Whether this invoice has been booked into your AFAS administration. | |
is |
char |
Is Booked in Exact | filters on the platform, writable, is |
Whether this invoice has been booked into your Exact administration. | |
is |
char |
Is Booked in Mareon | filters on the platform, writable, is |
Whether this invoice has been booked into your Mareon administration. | |
is |
char |
Is Booked in Twinfield | filters on the platform, writable, is |
Whether this invoice has been booked into your Twinfield administration. | |
is |
char |
Is Collective | filters on the platform, writable, is |
Whether this is a collective invoice, containing lines associated with different projects. | |
is |
char |
Is Credit | filters on the platform, writable, is |
Whether this is a credit invoice. | |
is |
char |
Is Mailed | filters on the platform, writable, is |
Whether this invoice has been mailed. | |
mail |
datetime |
Mail Date | filters on the platform, writable, mail |
The date and time the invoice was mailed. | |
note |
varchar2 |
Note | filters on the platform, writable, note |
The note of this invoice. | |
project_ |
int64 |
Project Branch ID | filters on the platform, writable, project. |
The ID of the branch of this project. | |
project_ |
int64 |
Project Category ID | filters on the platform, writable, project. |
The ID of the category of this project. | |
project_ |
int64 |
Project Division ID | filters on the platform, writable, project. |
The ID of the division of this project. | |
project_ |
int64 |
Project ID | filters on the platform, writable, project. |
The ID of the project. | |
project_ |
varchar2 |
Project Name | filters on the platform, writable, project. |
The name of the project. | |
project_ |
varchar2 |
Project Number | filters on the platform, writable, project. |
The number of the project. | |
project_ |
varchar2 |
Project Status | filters on the platform, writable, project. |
The name of the current status of this project. | |
project_ |
int64 |
Project Status ID | filters on the platform, writable, project. |
The ID of the status of this project. | |
status |
int64 |
Status | filters on the platform, writable, status |
The status of the invoice. (0 = Open, 1 = Expired, 2 = Paid, 3 = Draft) | |
sub |
varchar2 |
This field is dynamically hydrated by the 'addPricingInformation'-method in the schema factory. | filters on the platform, writable, sub |
The sum of all invoice line subtotals, excluding VAT. | |
total |
varchar2 |
This field is dynamically hydrated by the 'addPricingInformation'-method in the schema factory. | filters on the platform, writable, total |
The sum of all invoice line subtotals, including VAT. | |
updated |
datetime |
Updated At | filters on the platform, writable, updated |
The creation date of the object in ATOM/ISO-8601 format | |
updated |
int64 |
Updated by ID | filters on the platform, writable, updated |
The ID of the user. | |
updated |
varchar2 |
Updated by User Name | filters on the platform, writable, updated |
The username of the user. | |
vat |
varchar2 |
This field is dynamically hydrated by the 'addPricingInformation'-method in the schema factory. | filters on the platform, writable, vat |
The sum of all invoice line VAT totals. | |
work |
varchar2 |
Work Address | filters on the platform, writable, work |
The work address of this invoice. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: