PurchaseOrderContracts: Bouw7 Purchase Order Contracts
popular read only REST
- Catalog:
Bouw7 - Schema:
Contract - Label: Purchase Order Contracts
Returns a list of purchase order contracts. Returns a list of purchase order contracts.
Can only retrieve data.
Summary
Returns a list of purchase order contracts.
API Source
- Endpoint:
/list/purchase-order-contracts - Operation:
get /list/purchase-order-contracts
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 168 |
| Full scan rows per minute | 104,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 PurchaseOrderContracts 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 |
|---|---|---|---|---|---|
accepted |
varchar2 |
Accepted at | filters on the platform, writable, accepted |
The date when contract was accepted in ATOM-format. | |
attachment |
int64 |
Attachment Count | filters on the platform, writable, attachment |
The attachment count for this contract. | |
called |
int64 |
Called Receipt Count | filters on the platform, writable, called |
The called receipt count for this contract. | |
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. | |
current |
varchar2 |
This field is dynamically hydrated by the 'addCurrentApprover'-method in the schema factory. | filters on the platform, writable, current |
The full name of the current approver. | |
delivery |
varchar2 |
Delivery Address | filters on the platform, writable, delivery |
Delivery address of the purchase order contract. | |
delivery |
datetime |
Delivery Date | filters on the platform, writable, delivery |
Delivery date of the purchase order in ATOM-format. | |
delivery |
varchar2 |
Delivery Date Text | filters on the platform, writable, delivery |
Delivery date of the purchase order as free-form text. | |
denied |
varchar2 |
Denied at | filters on the platform, writable, denied |
The date the contract was denied in ATOM-format. | |
description |
varchar2 |
Description | filters on the platform, writable, description |
The description of the contract. May contain HTML content. | |
email |
varchar2 |
Email Sent at | filters on the platform, writable, email |
The date the email was sent in ATOM-format. | |
email |
varchar2 |
Email Sent by | filters on the platform, writable, email |
The username of the user that sent the email. | |
id |
int64 |
ID | filters on the platform, writable, id |
The ID of the Contract. | |
internal |
varchar2 |
Internal Note | filters on the platform, writable, internal |
Internal note about the contract. May contain HTML content. | |
is |
char |
Is Email Sent | filters on the platform, writable, is |
True if an email was already sent. | |
language |
varchar2 |
Language | filters on the platform, writable, language |
The locale used by this contract, e.g.: nl-NL. | |
linked |
int64 |
Linked Delivery Ticket Booking Status | filters on the platform, writable, linked |
The current booking status. 0 = Registered, 1 = Invoiced, 2 = Not billable, 3 = Credited. | |
linked |
datetime |
Linked Delivery Ticket Date | filters on the platform, writable, linked |
The date of the delivery ticket, represented in ATOM-format. | |
linked |
varchar2 |
Linked Delivery Ticket Description | filters on the platform, writable, linked |
The description of this delivery ticket. May contain HTML content. | |
linked |
int64 |
Linked Delivery Ticket ID | filters on the platform, writable, linked |
The ID of this delivery ticket. | |
linked |
char |
Linked Delivery Ticket Is Processed | filters on the platform, writable, linked |
Whether this delivery ticket has been processed. | |
linked |
varchar2 |
Linked Delivery Ticket Number | filters on the platform, writable, linked |
The ticket number of this delivery ticket. | |
linked |
varchar2 |
Linked Delivery Ticket Price | filters on the platform, writable, linked |
The price of this delivery ticket. | |
linked |
int64 |
Linked Delivery Ticket Purchase Type ID | filters on the platform, writable, linked |
The ID of the purchase type of this delivery ticket. | |
linked |
varchar2 |
Linked Delivery Ticket Purchase Type Name | filters on the platform, writable, linked |
The name of the purchase type of this delivery ticket. | |
name |
varchar2 |
Name | filters on the platform, writable, name |
The display name of the contract. Can be NULL. | |
number |
varchar2 |
Number | filters on the platform, writable, number |
The identification number of the contract. | |
outstanding |
varchar2 |
Outstanding Costs | filters on the platform, writable, outstanding |
Outstanding costs for the purchase order. | |
payment |
varchar2 |
Payment Agreement | filters on the platform, writable, payment |
The payment agreement of the contract. May contain HTML content. | |
price |
varchar2 |
Price | filters on the platform, writable, price |
The price of the contract. | |
project |
varchar2 |
Project Security Link Code | filters on the platform, writable, project |
The security code. | |
project |
int64 |
itgen_bouw7_projectsecuritylink_costtype | filters on the platform, writable, project |
The name of the cost type. | |
project |
int64 |
Project Security Link ID | filters on the platform, writable, project |
The ID of the project security link. | |
project |
varchar2 |
Project Security Link Name | filters on the platform, writable, project |
The name of the project security link. | |
project |
varchar2 |
itgen_bouw7_projectsecuritylink_parentname | filters on the platform, writable, project |
The name of the security code. | |
project |
int64 |
Project Security Link Project ID | filters on the platform, writable, project |
The ID of the project associated with this security code. | |
project |
int64 |
Project Security Link Status | filters on the platform, writable, project |
The status of the project security link. | |
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. | |
purchase |
int64 |
Purchase Type | filters on the platform, writable, purchase |
The type of purchase. (2 = Purchase Order, 4 = Equipment, 5 = Material, 6 = Miscelaneous) | |
status |
int64 |
Status | filters on the platform, writable, status |
Status of the contract | |
status |
varchar2 |
Status Name | filters on the platform, writable, status |
The name of the current status. | |
supplier_ |
varchar2 |
Supplier Email Address | filters on the platform, writable, supplier. |
The email address of the contact. | |
supplier_ |
int64 |
Supplier ID | filters on the platform, writable, supplier. |
The ID of the contact. | |
supplier_ |
varchar2 |
Supplier Name | filters on the platform, writable, supplier. |
The name of this contact. | |
supplier_ |
varchar2 |
Supplier Type | filters on the platform, writable, supplier. |
The type of this contact. | |
supplier_ |
int64 |
Supplier Type ID | filters on the platform, writable, supplier. |
The type ID of this contact. | |
type |
int64 |
Type | filters on the platform, writable, type |
Type of the contract. (0 = Permanent, 1 = Directing) | |
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: