invantive documentation
Invantive Support ForumsLog In / Sign Up

SettlementPhases: Robaws Settlement Phases

read only REST

  • Catalog: Robaws
  • Schema: SettlementPhases
  • Label: Settlement Phases

Search

Can only retrieve data.

API Source

  • Endpoint: /api/v2/settlement-phases
  • Operation: get /api/v2/settlement-phases

Performance Characteristics

Characteristic Value
Average access latency (ms) 125
Full scan rows per minute 16,500
Point query rows per minute 1,044
Write rows per minute 539

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
searchText ``
settlementId ``
sort ``
updatedFrom ``
withArchived ``

Table Columns

The columns of the table SettlementPhases 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
createdAt datetime Created at filters on the platform, writable, createdAt
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
endDate datetime End Date filters on the platform, writable, endDate
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
fixedAmount decimal Fixed Amount filters on the platform, writable, fixedAmount
id varchar2 ID filters on the platform, writable, id
lockedAt datetime Locked at filters on the platform, writable, lockedAt
name varchar2 Name filters on the platform, writable, name
percentage decimal Percentage filters on the platform, writable, percentage
phaseInvoiceStrategy varchar2 Phase Invoice Strategy filters on the platform, writable, phaseInvoiceStrategy
settlementId varchar2 Settlement ID filters on the platform, writable, settlementId The settlement the phase belongs to
startDate datetime Start Date filters on the platform, writable, startDate
updatedAt datetime Updated at filters on the platform, writable, updatedAt
workingDays int32 Working Days filters on the platform, writable, workingDays

Release Notes

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