invantive documentation
Invantive Support ForumsLog In / Sign Up

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_id int64 Branch ID filters on the platform, writable, branch.id The ID of the branch.
branch_name varchar2 Branch Name filters on the platform, writable, branch.name The name of the branch.
contactPersonName varchar2 Contact Person Name filters on the platform, writable, contactPersonName The contact person for this invoice. Value can be NULL if undefined.
contact_emailAddress varchar2 Contact Email Address filters on the platform, writable, contact.emailAddress The email address of the contact.
contact_id int64 Contact ID filters on the platform, writable, contact.id The ID of the contact.
contact_name varchar2 Contact Name filters on the platform, writable, contact.name The name of this contact.
contact_type varchar2 Contact Type filters on the platform, writable, contact.type The type of this contact.
contact_typeId int64 Contact Type ID filters on the platform, writable, contact.typeId The type ID of this contact.
createdAt datetime Created at filters on the platform, writable, createdAt The creation date of the object in ATOM/ISO-8601 format
createdBy_id int64 Created by ID filters on the platform, writable, createdBy.id The ID of the user.
createdBy_username varchar2 Created by User Name filters on the platform, writable, createdBy.username 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.
datePaid varchar2 Date Paid filters on the platform, writable, datePaid The date when the invoice was paid in YYYY-MM-DD format, or NULL if the invoice is unpaid.
debtorNumber varchar2 Debtor Number filters on the platform, writable, debtorNumber The debtor number of the contact associated with this invoice.
division_description varchar2 Division Description filters on the platform, writable, division.description The description of the division.
division_exactDivisionId varchar2 Division Exact Division ID filters on the platform, writable, division.exactDivisionId The division ID of an Exact Online environment.
division_glAccountCode varchar2 Division General Ledger Account Code filters on the platform, writable, division.glAccountCode A default general ledger account code to use for sales related items.
division_glAccountCodePurchase varchar2 Division General Ledger Account Code Purchase filters on the platform, writable, division.glAccountCodePurchase A default general ledger account code to use for purchase related items.
division_id int64 Division ID filters on the platform, writable, division.id The ID of the division.
division_journalCode varchar2 Division Journal Code filters on the platform, writable, division.journalCode A default journal code to use for sales related items.
division_journalCodePurchase varchar2 Division Journal Code Purchase filters on the platform, writable, division.journalCodePurchase A default journal code to use for purchase related items.
dueDate datetime Due Date filters on the platform, writable, dueDate 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.
invoiceNumber varchar2 Invoice Number filters on the platform, writable, invoiceNumber The number of invoice.
isBookedInAfas char Is Booked in AFAS filters on the platform, writable, isBookedInAfas Whether this invoice has been booked into your AFAS administration.
isBookedInExact char Is Booked in Exact filters on the platform, writable, isBookedInExact Whether this invoice has been booked into your Exact administration.
isBookedInMareon char Is Booked in Mareon filters on the platform, writable, isBookedInMareon Whether this invoice has been booked into your Mareon administration.
isBookedInTwinfield char Is Booked in Twinfield filters on the platform, writable, isBookedInTwinfield Whether this invoice has been booked into your Twinfield administration.
isCollective char Is Collective filters on the platform, writable, isCollective Whether this is a collective invoice, containing lines associated with different projects.
isCredit char Is Credit filters on the platform, writable, isCredit Whether this is a credit invoice.
isMailed char Is Mailed filters on the platform, writable, isMailed Whether this invoice has been mailed.
mailDate datetime Mail Date filters on the platform, writable, mailDate The date and time the invoice was mailed.
note varchar2 Note filters on the platform, writable, note The note of this invoice.
project_branchId int64 Project Branch ID filters on the platform, writable, project.branchId The ID of the branch of this project.
project_categoryId int64 Project Category ID filters on the platform, writable, project.categoryId The ID of the category of this project.
project_divisionId int64 Project Division ID filters on the platform, writable, project.divisionId The ID of the division of this project.
project_id int64 Project ID filters on the platform, writable, project.id The ID of the project.
project_name varchar2 Project Name filters on the platform, writable, project.name The name of the project.
project_number varchar2 Project Number filters on the platform, writable, project.number The number of the project.
project_status varchar2 Project Status filters on the platform, writable, project.status The name of the current status of this project.
project_statusId int64 Project Status ID filters on the platform, writable, project.statusId 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)
subTotal varchar2 This field is dynamically hydrated by the 'addPricingInformation'-method in the schema factory. filters on the platform, writable, subTotal 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.
updatedAt datetime Updated At filters on the platform, writable, updatedAt The creation date of the object in ATOM/ISO-8601 format
updatedBy_id int64 Updated by ID filters on the platform, writable, updatedBy.id The ID of the user.
updatedBy_username varchar2 Updated by User Name filters on the platform, writable, updatedBy.username The username of the user.
vatTotal varchar2 This field is dynamically hydrated by the 'addPricingInformation'-method in the schema factory. filters on the platform, writable, vatTotal The sum of all invoice line VAT totals.
workAddress varchar2 Work Address filters on the platform, writable, workAddress The work address of this invoice.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: