invantive documentation
Invantive Support ForumsLog In / Sign Up

CheckoutDocuments: Bouw7 itgen_bouw7_checkoutdocuments_plural

read only REST

  • Catalog: Bouw7
  • Schema: CheckoutDocument
  • Label: itgen_bouw7_checkoutdocuments_plural

Returns a list of all checkout documents associated with the organization. Returns a list of all checkout documents associated with the organization.

Can only retrieve data.

Summary

Returns a list of all checkout documents associated with the organization.

API Source

  • Endpoint: /list/checkout-documents
  • Operation: get /list/checkout-documents

Performance Characteristics

Characteristic Value
Average access latency (ms) 97
Full scan rows per minute 241,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 CheckoutDocuments 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
contactPersonText varchar2 Contact Person Text filters on the platform, writable, contactPersonText The contact person text associated with the checkout document. This value is only used when * contactPerson is empty, and it does not necessarily represent an actual contact person as it is just a text field.
contactPerson_emailAddress varchar2 Contact Person Email Address filters on the platform, writable, contactPerson.emailAddress The email address of the contact person.
contactPerson_firstName varchar2 Contact Person First Name filters on the platform, writable, contactPerson.firstName The first name of this contact person.
contactPerson_id int64 Contact Person ID filters on the platform, writable, contactPerson.id The ID of the contact person.
contactPerson_lastName varchar2(256) Contact Person Last Name filters on the platform, writable, contactPerson.lastName The surname of the contact person.
contactPerson_phoneNumber varchar2(255) Contact Person Phone Number filters on the platform, writable, contactPerson.phoneNumber The phone number of the contact person.
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 date of the checkout document.
id int64 ID filters on the platform, writable, id The ID of the checkout document.
invoiceId int64 itgen_bouw7_invoiceid filters on the platform, writable, invoiceId The invoice ID of the checkout document.
number varchar2 Number filters on the platform, writable, number The number of the checkout document.
projectFile_description varchar2 itgen_bouw7_projectfile_description filters on the platform, writable, projectFile.description The description of the project file.
projectFile_id int64 Project File ID filters on the platform, writable, projectFile.id The ID of the project file.
projectFile_name varchar2 Project File Name filters on the platform, writable, projectFile.name The name of the project file.
projectFile_projectId int64 itgen_bouw7_projectfile_projectid filters on the platform, writable, projectFile.projectId The ID of the project associated with the project file.
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 checkout document.
subtotal varchar2 Subtotal filters on the platform, writable, subtotal The subtotal of the checkout document.
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.

Release Notes

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