invantive documentation
Invantive Support ForumsLog In / Sign Up

ApprovalRequests: Robaws Approval Requests

read only REST

  • Catalog: Robaws
  • Schema: ApprovalRequests
  • Label: Approval Requests

Search

Can only retrieve data.

API Source

  • Endpoint: /api/v2/approval-requests
  • Operation: get /api/v2/approval-requests

Performance Characteristics

Characteristic Value
Average access latency (ms) 61
Full scan rows per minute 16,530
Point query rows per minute 1,114
Write rows per minute 539

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
open `` Filter by open/closed status. True returns open approval requests, false returns closed approval requests, null returns all approval requests.
searchText ``
sort ``
updatedFrom ``
userId `` Ignored: the list always holds the approval requests of the user making the call.
withArchived ``

Table Columns

The columns of the table ApprovalRequests 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
archivedAt datetime Archived at filters on the platform, writable, archivedAt
companyId varchar2 Company ID filters on the platform, writable, companyId
createdAt datetime Created at filters on the platform, writable, createdAt
date datetime Date filters on the platform, writable, date
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
expireDate datetime Expiry Date filters on the platform, writable, expireDate
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
id varchar2 ID filters on the platform, writable, id
invoiceNumber varchar2 Invoice Number filters on the platform, writable, invoiceNumber
lockedAt datetime Locked at filters on the platform, writable, lockedAt
logicId varchar2 Logical ID filters on the platform, writable, logicId
projectInfo varchar2 Project Information filters on the platform, writable, projectInfo
resourceUnderApprovalRef varchar2 Resource Under Approval Reference filters on the platform, writable, resourceUnderApprovalRef
resourceUnderApproval_archivedAt datetime Resource Under Approval Archived At filters on the platform, writable, resourceUnderApproval.archivedAt
resourceUnderApproval_assignedUserId varchar2 Resource Under Approval Assigned User ID filters on the platform, writable, resourceUnderApproval.assignedUserId
resourceUnderApproval_companyId varchar2 Resource Under Approval Company ID filters on the platform, writable, resourceUnderApproval.companyId
resourceUnderApproval_completed char Resource Under Approval Completed filters on the platform, writable, resourceUnderApproval.completed
resourceUnderApproval_completionPercentage decimal Resource Under Approval Completion Percentage filters on the platform, writable, resourceUnderApproval.completionPercentage
resourceUnderApproval_createdAt datetime Resource Under Approval Created At filters on the platform, writable, resourceUnderApproval.createdAt
resourceUnderApproval_date datetime Resource Under Approval Date filters on the platform, writable, resourceUnderApproval.date
resourceUnderApproval_deletedAt datetime Resource Under Approval Deleted At filters on the platform, writable, resourceUnderApproval.deletedAt
resourceUnderApproval_deliveryAddress varchar2 Resource Under Approval Delivery Address filters on the platform, writable, resourceUnderApproval.deliveryAddress
resourceUnderApproval_expectedDeliveryDate datetime Resource Under Approval Expected Delivery Date filters on the platform, writable, resourceUnderApproval.expectedDeliveryDate
resourceUnderApproval_extraFields varchar2 Resource Under Approval Extra Fields writable The JSON text of the nested object.
resourceUnderApproval_footerText varchar2 Resource Under Approval Footer Text filters on the platform, writable, resourceUnderApproval.footerText When reading, only present if requested via 'include' query parameter, otherwise null. HTML content. Embedded images are resolved to URLs based on the 'x-robaws-html-image-mode' request header: TEMPORARY_URL (default) returns time-limited presigned URLs that require no authentication; PERMANENT_URL returns stable URLs that require an authenticated session; NONE returns the stored HTML, where each image is an with a data-robaws-id and an empty src — keep that tag and its data-robaws-id when writing the HTML back, or the image is lost. Any other value (e.g. BASE64_INLINE) returns 400 Bad Request. When writing, omit it or send null to keep the current text; send an empty string to clear it.
resourceUnderApproval_id varchar2 Resource Under Approval ID filters on the platform, writable, resourceUnderApproval.id
resourceUnderApproval_introText varchar2 Resource Under Approval Intro Text filters on the platform, writable, resourceUnderApproval.introText When reading, only present if requested via 'include' query parameter, otherwise null. HTML content. Embedded images are resolved to URLs based on the 'x-robaws-html-image-mode' request header: TEMPORARY_URL (default) returns time-limited presigned URLs that require no authentication; PERMANENT_URL returns stable URLs that require an authenticated session; NONE returns the stored HTML, where each image is an with a data-robaws-id and an empty src — keep that tag and its data-robaws-id when writing the HTML back, or the image is lost. Any other value (e.g. BASE64_INLINE) returns 400 Bad Request. When writing, omit it or send null to keep the current text; send an empty string to clear it.
resourceUnderApproval_latestDeliveryDate datetime Resource Under Approval Latest Delivery Date filters on the platform, writable, resourceUnderApproval.latestDeliveryDate
resourceUnderApproval_lockedAt datetime Resource Under Approval Locked At filters on the platform, writable, resourceUnderApproval.lockedAt
resourceUnderApproval_logicId varchar2 Resource Under Approval Logic ID filters on the platform, writable, resourceUnderApproval.logicId
resourceUnderApproval_openInvoiceAmount decimal Resource Under Approval Open Invoice Amount filters on the platform, writable, resourceUnderApproval.openInvoiceAmount
resourceUnderApproval_reference varchar2 Resource Under Approval Reference filters on the platform, writable, resourceUnderApproval.reference
resourceUnderApproval_remark varchar2 Resource Under Approval Remark filters on the platform, writable, resourceUnderApproval.remark
resourceUnderApproval_sentViaWebshop datetime Resource Under Approval Sent via Webshop filters on the platform, writable, resourceUnderApproval.sentViaWebshop
resourceUnderApproval_status varchar2 Resource Under Approval Status filters on the platform, writable, resourceUnderApproval.status
resourceUnderApproval_supplierContactId varchar2 Resource Under Approval Supplier Contact ID filters on the platform, writable, resourceUnderApproval.supplierContactId
resourceUnderApproval_supplierId varchar2 Resource Under Approval Supplier ID filters on the platform, writable, resourceUnderApproval.supplierId
resourceUnderApproval_toLocationId varchar2 Resource Under Approval to Location ID filters on the platform, writable, resourceUnderApproval.toLocationId
resourceUnderApproval_totalAmountInvoiced decimal Resource Under Approval Total Amount Invoiced filters on the platform, writable, resourceUnderApproval.totalAmountInvoiced
resourceUnderApproval_totalExclVat decimal Resource Under Approval Total Excluding VAT filters on the platform, writable, resourceUnderApproval.totalExclVat
resourceUnderApproval_totalInclVat decimal Resource Under Approval Total Including VAT filters on the platform, writable, resourceUnderApproval.totalInclVat
resourceUnderApproval_type varchar2 Resource Under Approval Type filters on the platform, writable, resourceUnderApproval.type
resourceUnderApproval_updatedAt datetime Resource Under Approval Updated At filters on the platform, writable, resourceUnderApproval.updatedAt
supplierId varchar2 Supplier ID filters on the platform, writable, supplierId
totalVatExcl decimal Total Excluding VAT filters on the platform, writable, totalVatExcl
totalVatIncl decimal Total Including VAT filters on the platform, writable, totalVatIncl
updatedAt datetime Updated at filters on the platform, writable, updatedAt

Release Notes

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