invantive documentation
Invantive Support ForumsLog In / Sign Up

SettlementLineItemParameters: Robaws Settlement Line Item Parameters

read only REST

  • Catalog: Robaws
  • Schema: SettlementLineItemParameters
  • Label: Settlement Line Item Parameters

Search

Can only retrieve data.

API Source

  • Endpoint: /api/v2/settlement-line-item-parameters
  • Operation: get /api/v2/settlement-line-item-parameters

Performance Characteristics

Characteristic Value
Average access latency (ms) 152
Full scan rows per minute 9,898
Point query rows per minute 710
Write rows per minute 539

The result can be cached on the client.

Parameters

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

Table Columns

The columns of the table SettlementLineItemParameters 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
calculation char Calculation filters on the platform, writable, calculation true: an intermediate calculation step. The parameter is evaluated like any other and other formulas can use it, but the UI hides it by default, behind the show details switch. false: a parameter shown to the user.
createdAt datetime Created at filters on the platform, writable, createdAt
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
description varchar2 Description filters on the platform, writable, description
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
formula varchar2 Formula filters on the platform, writable, formula
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
settlementId varchar2 Settlement ID filters on the platform, writable, settlementId The settlement of that line
settlementLineItemId varchar2 Settlement Line Item ID filters on the platform, writable, settlementLineItemId The settlement line the parameter belongs to
textValue varchar2 Text Value filters on the platform, writable, textValue The formula's result as text, always calculated after the save (a number too, as text). Read-only: write the formula instead.
updatedAt datetime Updated at filters on the platform, writable, updatedAt
value decimal Value filters on the platform, writable, value The formula's result as a number, always calculated after the save; 0 when the result is a text that is not a number (see textValue). Read-only: write the formula instead.

Release Notes

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