invantive documentation
Invantive Support ForumsLog In / Sign Up

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
articleId ``
clientId ``
deliveryNoteId ``
fromDate ``
journalId ``
journalName ``
materialId ``
projectId ``
salesOrderId ``
searchText ``
sort ``
subscriptionId ``
toDate ``
type `` Values: INVOICE, CREDIT_NOTE.
updatedFrom ``
withArchived ``
workOrderId ``

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
accountancyStatus varchar2 Accountancy Status filters on the platform, writable, accountancyStatus
advanceInvoice char Advance Invoice filters on the platform, writable, advanceInvoice
advancePercentage decimal Advance (%) filters on the platform, writable, advancePercentage The advance percentage, represented on a scale from 0 to 100.
archivedAt datetime Archived at filters on the platform, writable, archivedAt
assignedUserId varchar2 Assigned User ID filters on the platform, writable, assignedUserId
booked char Booked filters on the platform, writable, booked
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
contactPersonId varchar2 Contact Person ID filters on the platform, writable, contactPersonId
createdAt datetime Created at filters on the platform, writable, createdAt
creditedInvoiceId varchar2 Credited Invoice ID filters on the platform, writable, creditedInvoiceId Only present for invoices of type CREDIT_NOTE. This is the id of the invoice that has been credited by this credit note.
creditedTotal decimal Credited Total filters on the platform, writable, creditedTotal 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
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
deliveryClientId varchar2 Delivery Client ID filters on the platform, writable, deliveryClientId
deliveryNoteId varchar2 Delivery Note ID filters on the platform, writable, deliveryNoteId
documentId varchar2 Document ID filters on the platform, writable, documentId
exchangeRate decimal Exchange Rate filters on the platform, writable, exchangeRate
expireDate datetime Expiry Date filters on the platform, writable, expireDate
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
finalInvoice char Final Invoice filters on the platform, writable, finalInvoice
holdbackItem_calculatedAmount decimal Holdback Item Calculated Amount filters on the platform, writable, holdbackItem.calculatedAmount
holdbackItem_deadline datetime Holdback Item Deadline filters on the platform, writable, holdbackItem.deadline
holdbackItem_fixedAmount decimal Holdback Item Fixed Amount filters on the platform, writable, holdbackItem.fixedAmount
holdbackItem_numberOfDays int32 Holdback Item Number of Days filters on the platform, writable, holdbackItem.numberOfDays
holdbackItem_percentage decimal Holdback Item Percentage filters on the platform, writable, holdbackItem.percentage
holdbackItem_type varchar2 Holdback Item Type filters on the platform, writable, holdbackItem.type
id varchar2 ID filters on the platform, writable, id
introText varchar2 Intro Text filters on the platform, writable, introText 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 with a data-robaws-id and an empty src — keep that tag and its data-robaws-id when writing the HTML back, or the image is lost. Any other value (e.g. BASE64_INLINE) returns 400 Bad Request. When writing, omit it or send null to keep the current text; send an empty string to clear it.
invoicePeriod_end datetime Invoice Period End filters on the platform, writable, invoicePeriod.end
invoicePeriod_start datetime Invoice Period Start filters on the platform, writable, invoicePeriod.start
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 to create invoices.
lockedAt datetime Locked at filters on the platform, writable, lockedAt
logicId varchar2 Logical ID filters on the platform, writable, logicId
openTotal decimal Open Total filters on the platform, writable, openTotal
originType varchar2 Origin Type filters on the platform, writable, originType
paidTotal decimal Paid Total filters on the platform, writable, paidTotal
paymentConditionId varchar2 Payment Condition ID filters on the platform, writable, paymentConditionId
paymentInstruction varchar2 Payment Instruction filters on the platform, writable, paymentInstruction
peppolResponseStatus varchar2 Peppol Response Status filters on the platform, writable, peppolResponseStatus
peppolSentDate datetime Peppol Sent Date filters on the platform, writable, peppolSentDate
peppolStatus varchar2 Peppol Status filters on the platform, writable, peppolStatus
poNumber varchar2 PO Number filters on the platform, writable, poNumber
rechnungType varchar2 German Invoice Type filters on the platform, writable, rechnungType
remark varchar2 Remark filters on the platform, writable, remark
rentalInvoicingPeriodId varchar2 Rental Invoicing Period ID filters on the platform, writable, rentalInvoicingPeriodId
selfBilling char Self Billing filters on the platform, writable, selfBilling
selfBillingNumber varchar2 Self Billing Number filters on the platform, writable, selfBillingNumber
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
subscriptionId varchar2 Subscription ID filters on the platform, writable, subscriptionId
totalExclVat decimal Total excluding VAT filters on the platform, writable, totalExclVat 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.
totalInclVat decimal Total including VAT filters on the platform, writable, totalInclVat 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
updatedAt datetime Updated at filters on the platform, writable, updatedAt
withRespectTo varchar2 With Respect To filters on the platform, writable, withRespectTo

Keys

Key Column Refers to Kind Description
SalesInvoices_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.
SalesInvoices_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.
SalesInvoices_companyId_fk companyId Companies.id Key
SalesInvoices_creditedInvoiceId_txt creditedInvoiceId 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.
SalesInvoices_deliveryNoteId_fk deliveryNoteId DeliveryNotes.id Key
SalesInvoices_subscriptionId_fk subscriptionId Subscriptions.id Key

Referenced By

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: