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 |
|---|---|---|---|---|---|
contact |
varchar2 |
Contact Person Text | filters on the platform, writable, contact |
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. | |
contact |
varchar2 |
Contact Person Email Address | filters on the platform, writable, contact |
The email address of the contact person. | |
contact |
varchar2 |
Contact Person First Name | filters on the platform, writable, contact |
The first name of this contact person. | |
contact |
int64 |
Contact Person ID | filters on the platform, writable, contact |
The ID of the contact person. | |
contact |
varchar2 |
Contact Person Last Name | filters on the platform, writable, contact |
The surname of the contact person. | |
contact |
varchar2 |
Contact Person Phone Number | filters on the platform, writable, contact |
The phone number of the contact person. | |
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 date of the checkout document. | |
id |
int64 |
ID | filters on the platform, writable, id |
The ID of the checkout document. | |
invoice |
int64 |
itgen_bouw7_invoiceid | filters on the platform, writable, invoice |
The invoice ID of the checkout document. | |
number |
varchar2 |
Number | filters on the platform, writable, number |
The number of the checkout document. | |
project |
varchar2 |
itgen_bouw7_projectfile_description | filters on the platform, writable, project |
The description of the project file. | |
project |
int64 |
Project File ID | filters on the platform, writable, project |
The ID of the project file. | |
project |
varchar2 |
Project File Name | filters on the platform, writable, project |
The name of the project file. | |
project |
int64 |
itgen_bouw7_projectfile_projectid | filters on the platform, writable, project |
The ID of the project associated with the project file. | |
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 checkout document. | |
subtotal |
varchar2 |
Subtotal | filters on the platform, writable, subtotal |
The subtotal of the checkout document. | |
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. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: