invantive documentation
Invantive Support ForumsLog In / Sign Up

Subscriptions: Robaws Subscriptions

insert update delete REST

  • Catalog: Robaws
  • Schema: Subscriptions
  • Primary Keys: id
  • Label: Subscriptions

Search

Can retrieve data and change data using insert, update and delete.

API Source

  • Endpoint: /api/v2/subscriptions
  • Operation: get /api/v2/subscriptions

Performance Characteristics

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

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
active ``
clientId ``
clientReference ``
materialId ``
projectId ``
searchText ``
sort ``
updatedFrom ``
withArchived ``

Table Columns

The columns of the table Subscriptions 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
active char Active filters on the platform, writable, active
archivedAt datetime Archived at filters on the platform, writable, archivedAt
assignedUserId varchar2 Assigned User ID filters on the platform, writable, assignedUserId
clientContactId varchar2 Client Contact ID filters on the platform, writable, clientContactId
clientId varchar2 Client ID filters on the platform, writable, clientId
clientReference varchar2 Customer Reference filters on the platform, writable, clientReference
companyId varchar2 Company ID filters on the platform, writable, companyId
createdAt datetime Created at filters on the platform, writable, createdAt
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
endClientContactId varchar2 End Client Contact ID filters on the platform, writable, endClientContactId
endClientId varchar2 End Client ID filters on the platform, writable, endClientId
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
id varchar2 ID filters on the platform, writable, id
interval varchar2 Interval filters on the platform, writable, interval Deprecated, use recurrenceRule instead.
journalId varchar2 Journal ID filters on the platform, writable, journalId
journalName varchar2 Journal Name filters on the platform, writable, journalName Deprecated. Use companyId and journalId instead.
lockedAt datetime Locked at filters on the platform, writable, lockedAt
logicId varchar2 Logical ID filters on the platform, writable, logicId
nextExecutionDate datetime Next Execution Date filters on the platform, writable, nextExecutionDate
recurrenceRule varchar2 Recurrence Rule filters on the platform, writable, recurrenceRule
remark varchar2 Remark filters on the platform, writable, remark
startDate datetime Start Date filters on the platform, writable, startDate
status varchar2 Status filters on the platform, writable, status
statusDetails_color varchar2 Status Details Color filters on the platform, writable, statusDetails.color
statusDetails_name varchar2 Status Details Name filters on the platform, writable, statusDetails.name
totalAnnual decimal Total Annual Amount filters on the platform, writable, totalAnnual
totalExclVat decimal Total excluding VAT filters on the platform, writable, totalExclVat
totalInclVat decimal Total including VAT filters on the platform, writable, totalInclVat
type varchar2 Type filters on the platform, writable, type
updatedAt datetime Updated at filters on the platform, writable, updatedAt
validUntil datetime Valid until filters on the platform, writable, validUntil
withRespectTo varchar2 With Respect To filters on the platform, writable, withRespectTo

Keys

Key Column Refers to Kind Description
Subscriptions_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.
Subscriptions_clientContactId_fk clientContactId Contacts.id Key
Subscriptions_clientId_txt clientId Clients.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.
Subscriptions_companyId_fk companyId Companies.id Key
Subscriptions_endClientContactId_fk endClientContactId Contacts.id Key
Subscriptions_endClientId_fk endClientId Clients.id Key

Referenced By

Release Notes

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