SalesInvoices: Robaws Sales Invoices
insert update delete REST
- Catalog:
Robaws - Schema:
SalesInvoices - Primary Keys:
id - Label: Sales Invoices
Search
Can retrieve data and change data using insert, update and delete.
API Source
- Endpoint:
/api/v2/sales-invoices - Operation:
get /api/v2/sales-invoices
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 134 |
| Full scan rows per minute | 26,819 |
| Point query rows per minute | 933 |
| Write rows per minute | 539 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
article |
`` | |||
client |
`` | |||
delivery |
`` | |||
from |
`` | |||
journal |
`` | |||
journal |
`` | |||
material |
`` | |||
project |
`` | |||
sales |
`` | |||
search |
`` | |||
sort |
`` | |||
subscription |
`` | |||
toDate |
`` | |||
type |
`` | Values: INVOICE, CREDIT_NOTE. | ||
updated |
`` | |||
with |
`` | |||
work |
`` |
Table Columns
The columns of the table SalesInvoices 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 |
|---|---|---|---|---|---|
accountancy |
varchar2 |
Accountancy Status | filters on the platform, writable, accountancy |
||
advance |
char |
Advance Invoice | filters on the platform, writable, advance |
||
advance |
decimal |
Advance (%) | filters on the platform, writable, advance |
The advance percentage, represented on a scale from 0 to 100. | |
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
assigned |
varchar2 |
Assigned User ID | filters on the platform, writable, assigned |
||
booked |
char |
Booked | filters on the platform, writable, booked |
||
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 |
||
contact |
varchar2 |
Contact Person ID | filters on the platform, writable, contact |
||
created |
datetime |
Created at | filters on the platform, writable, created |
||
credited |
varchar2 |
Credited Invoice ID | filters on the platform, writable, credited |
Only present for invoices of type CREDIT_NOTE. This is the id of the invoice that has been credited by this credit note. | |
credited |
decimal |
Credited Total | filters on the platform, writable, credited |
Only present for invoices of type INVOICE | |
currency |
varchar2 |
Currency | filters on the platform, writable, currency |
||
date |
datetime |
Date | filters on the platform, writable, date |
||
deleted |
datetime |
Deleted at | filters on the platform, writable, deleted |
||
delivery |
varchar2 |
Delivery Client ID | filters on the platform, writable, delivery |
||
delivery |
varchar2 |
Delivery Note ID | filters on the platform, writable, delivery |
||
document |
varchar2 |
Document ID | filters on the platform, writable, document |
||
exchange |
decimal |
Exchange Rate | filters on the platform, writable, exchange |
||
expire |
datetime |
Expiry Date | filters on the platform, writable, expire |
||
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
final |
char |
Final Invoice | filters on the platform, writable, final |
||
holdback |
decimal |
Holdback Item Calculated Amount | filters on the platform, writable, holdback |
||
holdback |
datetime |
Holdback Item Deadline | filters on the platform, writable, holdback |
||
holdback |
decimal |
Holdback Item Fixed Amount | filters on the platform, writable, holdback |
||
holdback |
int32 |
Holdback Item Number of Days | filters on the platform, writable, holdback |
||
holdback |
decimal |
Holdback Item Percentage | filters on the platform, writable, holdback |
||
holdback |
varchar2 |
Holdback Item Type | filters on the platform, writable, holdback |
||
id |
varchar2 |
ID | filters on the platform, writable, id |
||
intro |
varchar2 |
Intro Text | filters on the platform, writable, intro |
When reading, only present if requested via 'include' query parameter, otherwise null. HTML content. Embedded images are resolved to URLs based on the 'x-robaws-html-image-mode' request header: TEMPORARY_URL (default) returns time-limited presigned URLs that require no authentication; PERMANENT_URL returns stable URLs that require an authenticated session; NONE returns the stored HTML, where each image is an |
|
invoice |
datetime |
Invoice Period End | filters on the platform, writable, invoice |
||
invoice |
datetime |
Invoice Period Start | filters on the platform, writable, invoice |
||
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 to create invoices. | |
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
logic |
varchar2 |
Logical ID | filters on the platform, writable, logic |
||
open |
decimal |
Open Total | filters on the platform, writable, open |
||
origin |
varchar2 |
Origin Type | filters on the platform, writable, origin |
||
paid |
decimal |
Paid Total | filters on the platform, writable, paid |
||
payment |
varchar2 |
Payment Condition ID | filters on the platform, writable, payment |
||
payment |
varchar2 |
Payment Instruction | filters on the platform, writable, payment |
||
peppol |
varchar2 |
Peppol Response Status | filters on the platform, writable, peppol |
||
peppol |
datetime |
Peppol Sent Date | filters on the platform, writable, peppol |
||
peppol |
varchar2 |
Peppol Status | filters on the platform, writable, peppol |
||
po |
varchar2 |
PO Number | filters on the platform, writable, po |
||
rechnung |
varchar2 |
German Invoice Type | filters on the platform, writable, rechnung |
||
remark |
varchar2 |
Remark | filters on the platform, writable, remark |
||
rental |
varchar2 |
Rental Invoicing Period ID | filters on the platform, writable, rental |
||
self |
char |
Self Billing | filters on the platform, writable, self |
||
self |
varchar2 |
Self Billing Number | filters on the platform, writable, self |
||
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 |
||
subscription |
varchar2 |
Subscription ID | filters on the platform, writable, subscription |
||
total |
decimal |
Total excluding VAT | filters on the platform, writable, total |
Total of the line items excluding VAT, in the document currency (attributes.currency); the exchange rate is not applied. In /aggregate, SUM, AVG, MIN and MAX count a credit note negative; /query returns the value as stored. | |
total |
decimal |
Total including VAT | filters on the platform, writable, total |
Total including VAT, in the document currency (attributes.currency); the exchange rate is not applied. In /aggregate, SUM, AVG, MIN and MAX count a credit note negative; /query returns the value as stored. | |
type |
varchar2 |
Type | filters on the platform, writable, type |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
||
with |
varchar2 |
With Respect To | filters on the platform, writable, with |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Sales |
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. |
Sales |
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. |
Sales |
company |
Companies.id |
Key | |
Sales |
credited |
SalesInvoices.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. |
Sales |
delivery |
DeliveryNotes.id |
Key | |
Sales |
subscription |
Subscriptions.id |
Key |
Referenced By
- SalesInvoices
creditedInvoiceId(Textual)
Sample Queries
select inv.logicId
, inv.date
, inv.expireDate
, inv.openTotal
, cnt.name client_name
from Robaws.SalesInvoices.SalesInvoices inv
join Robaws.Clients.Clients cnt
on cnt.id = inv.clientId
where inv.openTotal > 0
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: