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 |
`` | |||
client |
`` | |||
client |
`` | |||
material |
`` | |||
project |
`` | |||
search |
`` | |||
sort |
`` | |||
updated |
`` | |||
with |
`` |
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 |
||
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
assigned |
varchar2 |
Assigned User ID | filters on the platform, writable, assigned |
||
client |
varchar2 |
Client Contact ID | filters on the platform, writable, client |
||
client |
varchar2 |
Client ID | filters on the platform, writable, client |
||
client |
varchar2 |
Customer Reference | filters on the platform, writable, client |
||
company |
varchar2 |
Company ID | filters on the platform, writable, company |
||
created |
datetime |
Created at | filters on the platform, writable, created |
||
deleted |
datetime |
Deleted at | filters on the platform, writable, deleted |
||
end |
varchar2 |
End Client Contact ID | filters on the platform, writable, end |
||
end |
varchar2 |
End Client ID | filters on the platform, writable, end |
||
extra |
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. | |
journal |
varchar2 |
Journal ID | filters on the platform, writable, journal |
||
journal |
varchar2 |
Journal Name | filters on the platform, writable, journal |
Deprecated. Use companyId and journalId instead. | |
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
logic |
varchar2 |
Logical ID | filters on the platform, writable, logic |
||
next |
datetime |
Next Execution Date | filters on the platform, writable, next |
||
recurrence |
varchar2 |
Recurrence Rule | filters on the platform, writable, recurrence |
||
remark |
varchar2 |
Remark | filters on the platform, writable, remark |
||
start |
datetime |
Start Date | filters on the platform, writable, start |
||
status |
varchar2 |
Status | filters on the platform, writable, status |
||
status |
varchar2 |
Status Details Color | filters on the platform, writable, status |
||
status |
varchar2 |
Status Details Name | filters on the platform, writable, status |
||
total |
decimal |
Total Annual Amount | filters on the platform, writable, total |
||
total |
decimal |
Total excluding VAT | filters on the platform, writable, total |
||
total |
decimal |
Total including VAT | filters on the platform, writable, total |
||
type |
varchar2 |
Type | filters on the platform, writable, type |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
||
valid |
datetime |
Valid until | filters on the platform, writable, valid |
||
with |
varchar2 |
With Respect To | filters on the platform, writable, with |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Subscriptions_ |
assigned |
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_ |
client |
Contacts.id |
Key | |
Subscriptions_ |
client |
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_ |
company |
Companies.id |
Key | |
Subscriptions_ |
end |
Contacts.id |
Key | |
Subscriptions_ |
end |
Clients.id |
Key |
Referenced By
- Installations
subscriptionId(Textual) - SalesInvoices
subscriptionId(Key) - SalesOrders
subscriptionId(Key) - SubscriptionLineItems
subscriptionId(Key)
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: