invantive documentation
Invantive Support ForumsLog In / Sign Up

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
acceptedAt varchar2 Accepted at filters on the platform, writable, acceptedAt The date when contract was accepted in ATOM-format.
attachmentCount int64 Attachment Count filters on the platform, writable, attachmentCount The attachment count for this contract.
calledReceiptCount int64 Called Receipt Count filters on the platform, writable, calledReceiptCount The called receipt count for this contract.
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.
currentApprover varchar2 This field is dynamically hydrated by the 'addCurrentApprover'-method in the schema factory. filters on the platform, writable, currentApprover The full name of the current approver.
deliveryAddress varchar2 Delivery Address filters on the platform, writable, deliveryAddress Delivery address of the purchase order contract.
deliveryDate datetime Delivery Date filters on the platform, writable, deliveryDate Delivery date of the purchase order in ATOM-format.
deliveryDateText varchar2 Delivery Date Text filters on the platform, writable, deliveryDateText Delivery date of the purchase order as free-form text.
deniedAt varchar2 Denied at filters on the platform, writable, deniedAt 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.
emailSentAt varchar2 Email Sent at filters on the platform, writable, emailSentAt The date the email was sent in ATOM-format.
emailSentBy varchar2 Email Sent by filters on the platform, writable, emailSentBy The username of the user that sent the email.
id int64 ID filters on the platform, writable, id The ID of the Contract.
internalNote varchar2 Internal Note filters on the platform, writable, internalNote Internal note about the contract. May contain HTML content.
isEmailSent char Is Email Sent filters on the platform, writable, isEmailSent 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.
linkedDeliveryTicket_bookingStatus int64 Linked Delivery Ticket Booking Status filters on the platform, writable, linkedDeliveryTicket.bookingStatus The current booking status. 0 = Registered, 1 = Invoiced, 2 = Not billable, 3 = Credited.
linkedDeliveryTicket_date datetime Linked Delivery Ticket Date filters on the platform, writable, linkedDeliveryTicket.date The date of the delivery ticket, represented in ATOM-format.
linkedDeliveryTicket_description varchar2 Linked Delivery Ticket Description filters on the platform, writable, linkedDeliveryTicket.description The description of this delivery ticket. May contain HTML content.
linkedDeliveryTicket_id int64 Linked Delivery Ticket ID filters on the platform, writable, linkedDeliveryTicket.id The ID of this delivery ticket.
linkedDeliveryTicket_isProcessed char Linked Delivery Ticket Is Processed filters on the platform, writable, linkedDeliveryTicket.isProcessed Whether this delivery ticket has been processed.
linkedDeliveryTicket_number varchar2 Linked Delivery Ticket Number filters on the platform, writable, linkedDeliveryTicket.number The ticket number of this delivery ticket.
linkedDeliveryTicket_price varchar2 Linked Delivery Ticket Price filters on the platform, writable, linkedDeliveryTicket.price The price of this delivery ticket.
linkedDeliveryTicket_purchaseTypeId int64 Linked Delivery Ticket Purchase Type ID filters on the platform, writable, linkedDeliveryTicket.purchaseTypeId The ID of the purchase type of this delivery ticket.
linkedDeliveryTicket_purchaseTypeName varchar2 Linked Delivery Ticket Purchase Type Name filters on the platform, writable, linkedDeliveryTicket.purchaseTypeName The name of the purchase type of this delivery ticket.
name varchar2(255) 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.
outstandingCosts varchar2 Outstanding Costs filters on the platform, writable, outstandingCosts Outstanding costs for the purchase order.
paymentAgreement varchar2 Payment Agreement filters on the platform, writable, paymentAgreement The payment agreement of the contract. May contain HTML content.
price varchar2 Price filters on the platform, writable, price The price of the contract.
projectSecurityLink_code varchar2 Project Security Link Code filters on the platform, writable, projectSecurityLink.code The security code.
projectSecurityLink_costType int64 itgen_bouw7_projectsecuritylink_costtype filters on the platform, writable, projectSecurityLink.costType The name of the cost type.
projectSecurityLink_id int64 Project Security Link ID filters on the platform, writable, projectSecurityLink.id The ID of the project security link.
projectSecurityLink_name varchar2 Project Security Link Name filters on the platform, writable, projectSecurityLink.name The name of the project security link.
projectSecurityLink_parentName varchar2 itgen_bouw7_projectsecuritylink_parentname filters on the platform, writable, projectSecurityLink.parentName The name of the security code.
projectSecurityLink_projectId int64 Project Security Link Project ID filters on the platform, writable, projectSecurityLink.projectId The ID of the project associated with this security code.
projectSecurityLink_status int64 Project Security Link Status filters on the platform, writable, projectSecurityLink.status The status of the project security link.
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.
purchaseType int64 Purchase Type filters on the platform, writable, purchaseType 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
statusName varchar2 Status Name filters on the platform, writable, statusName The name of the current status.
supplier_emailAddress varchar2 Supplier Email Address filters on the platform, writable, supplier.emailAddress The email address of the contact.
supplier_id int64 Supplier ID filters on the platform, writable, supplier.id The ID of the contact.
supplier_name varchar2 Supplier Name filters on the platform, writable, supplier.name The name of this contact.
supplier_type varchar2 Supplier Type filters on the platform, writable, supplier.type The type of this contact.
supplier_typeId int64 Supplier Type ID filters on the platform, writable, supplier.typeId The type ID of this contact.
type int64 Type filters on the platform, writable, type Type of the contract. (0 = Permanent, 1 = Directing)
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: