invantive documentation
Invantive Support ForumsLog In / Sign Up

ClaimStates: Robaws Claim States

delete REST

  • Catalog: Robaws
  • Schema: ClaimStates
  • Primary Keys: id
  • Label: Claim States

Search

Can retrieve data and change data using delete.

API Source

  • Endpoint: /api/v2/claim-states
  • Operation: get /api/v2/claim-states

Performance Characteristics

Characteristic Value
Average access latency (ms) 104
Full scan rows per minute 47,105
Point query rows per minute 1,166
Write rows per minute 539

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
clientId ``
projectId ``
salesInvoiceId ``
searchText ``
sort ``
updatedFrom ``
withArchived ``

Table Columns

The columns of the table ClaimStates 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
assignedUserId varchar2 Assigned User ID filters on the platform, writable, assignedUserId
claimStateNumber int32 Claim State Number filters on the platform, writable, claimStateNumber
completedPercentage decimal Completed Percentage filters on the platform, writable, completedPercentage
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
endDate datetime End Date filters on the platform, writable, endDate
executionPeriod int32 Execution Period filters on the platform, writable, executionPeriod
executionPeriodType varchar2 Execution Period Type filters on the platform, writable, executionPeriodType
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
id varchar2 ID filters on the platform, writable, id
invoicingStrategy varchar2 Invoicing Strategy filters on the platform, writable, invoicingStrategy
lockedAt datetime Locked at filters on the platform, writable, lockedAt
logicId varchar2 Logical ID filters on the platform, writable, logicId
projectId varchar2 Project ID filters on the platform, writable, projectId
startDate datetime Start Date filters on the platform, writable, startDate
status varchar2 Status filters on the platform, writable, status
title varchar2 Title filters on the platform, writable, title
totalExclVat decimal Total excluding VAT filters on the platform, writable, totalExclVat
totalInclVat decimal Total including VAT filters on the platform, writable, totalInclVat
totalRevision decimal Total Revision filters on the platform, writable, totalRevision
updatedAt datetime Updated at filters on the platform, writable, updatedAt

Keys

Key Column Refers to Kind Description
ClaimStates_assignedUserId_txt assignedUserId Users.id Textual The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it.

Referenced By

Release Notes

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