invantive documentation
Invantive Support ForumsLog In / Sign Up

DocumentsBulk: Exact Online Documents

read only per partition webhook REST

  • Catalog: ExactOnlineREST
  • Schema: Documents
  • Primary Keys: ID
  • Label: Documents

The data in this table is partitioned per value of the Division column.

Can only retrieve data.

Changes arrive through the webhook topic Documents.

API Source

  • Endpoint: /api/v1/{division}/bulk/Documents/Documents
  • Metadata: /api/v1/{division}/bulk/Documents/$metadata

Performance Characteristics

Characteristic Value
Average access latency (ms) 5
Full scan rows per minute 20,000
Point query rows per minute 300
Write rows per minute 300

The result can be cached on the client.

Table Columns

The columns of the table DocumentsBulk 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
Account guid Account filters on the platform, writable ID of the related account of this document.
AccountCode varchar2(18) Account Code writable Code of Account.
AccountName varchar2(50) Account Name writable Name of account.
AmountFC double Amount Foreign Currency writable Amount in the currency of the transaction.
Body varchar2 Body writable Body of this document.
Category guid Category filters on the platform, writable ID of the category of this document.
CategoryDescription varchar2 Category Description writable Description of Category.
Contact guid Contact filters on the platform, writable ID of the related contact of this document.
ContactFullName varchar2(240) Contact Full Name writable Contact full name.
ContractID guid itgen_eol_contractid writable Contract ID.
ContractNumber varchar2 itgen_eol_contractnumber writable Contract number.
Created datetime Created filters on the platform, writable Creation date.
CreatedUtc datetime Created (UTC) writable Creation date in UTC.
Creator guid Creator filters on the platform, writable User ID of creator.
CreatorFullName varchar2(240) Creator Full Name writable Name of creator.
Currency varchar2(30) Currency writable Currency code.
Division int32 Division filters on the platform Division code.
DivisionCompanyCoCNumber varchar2(60) Division Chamber of Commerce Number writable Chamber of commerce number of the Exact Online division.
DivisionCompanyIBANNumber varchar2(50) Division IBAN Number writable IBAN number of the Exact Online division.
DivisionCompanyName varchar2(50) Division Company Name writable Company name of the Exact Online division.
DivisionCompanyRSINNumber varchar2(9) Division RSIN Number writable RSIN number of the Exact Online division.
DivisionCompanyVATNumber varchar2(35) Division VAT Number writable VAT number of the Exact Online division.
DivisionCompanyWageTaxNumber varchar2(60) Division Wage Tax Number writable Wage tax number of the Exact Online division.
DivisionLabel varchar2(128) Division Label writable Label of the Exact Online division.
DivisionName varchar2(50) Administration Name writable Name of the Exact Online division.
DivisionOwnerCompanyName varchar2(50) Subscription Holder Name writable Name of the customer account in division 1 owning the Exact Online subscription to which this division belongs.
DivisionOwnerCompanyNumber varchar2(18) Subscription Holder Number writable Number of the customer account in division 1 owning the Exact Online subscription to which this division belongs.
DivisionShortName int64 Division Short Name writable Short name of the Exact Online division.
DocumentDate datetime Document Date filters on the platform, writable Entry date of the incoming document.
DocumentFolder guid Document Folder filters on the platform, writable The Id of document folder.
DocumentFolderCode varchar2 itgen_eol_documentfoldercode writable The Code of document folder.
DocumentFolderDescription varchar2 itgen_eol_documentfolderdescription writable The Decsription of document folder.
DocumentViewUrl varchar2 Document View URL writable Url to view the document.
ExpiryDate datetime Expiry Date Expiry date of this document.
FinancialTransactionEntryID guid itgen_eol_financialtransactionentryid filters on the platform, writable Reference to the transaction lines that make up the financial entry.
HID int32 HID filters on the platform, writable Human-readable ID, formatted as xx.xxx.xxx. Unique. May not be equal to zero.
HasEmptyBody char Has Empty Body writable Indicates that the document body is empty.
ID guid ID filters on the platform, writable Primary key.
InheritShare char Inherit Share
Item guid Item filters on the platform, writable
ItemCode varchar2 Item Code filters on the platform
ItemDescription varchar2 Item Description filters on the platform
Language varchar2(30) Language writable The language code of the document.
Modified datetime Modified filters on the platform, writable Last modified date.
ModifiedUtc datetime Modified (UTC) writable Last modified date in UTC.
Modifier guid Modifier writable User ID of modifier.
ModifierFullName varchar2(240) Modified Full Name writable Name of modifier.
Opportunity guid Opportunity filters on the platform, writable The opportunity linked to the document.
Project guid Project writable The project linked to the document.
ProjectCode varchar2(20) Project Code writable Code of project.
ProjectDescription varchar2(60) Project Description writable Description of project.
ProposedEntryStatus int16 Proposed Entry Status
SalesInvoiceNumber int32 Sales Invoice Number filters on the platform, writable 'Our reference' of the transaction that belongs to this document.
SalesOrderNumber int32 Sales Order Number writable Number of the sales order.
ScanServiceStatus int16 itgen_eol_scanservicestatus filters on the platform
SendMethod int32 Send Method writable Send method.
ShopOrderNumber int32 Shop Order Number writable Number of the shop order.
Subject varchar2(256) Subject filters on the platform, writable Subject of this document.
TeamsMeetingId varchar2 itgen_eol_teamsmeetingid
Type int32 Type filters on the platform, writable ID of the type of this document.
TypeDescription varchar2(240) Type Description writable Description of Type.

Keys

Key Column Refers to Kind Description
DocumentsBulk_Account_Accounts_fk Account Accounts.ID Key
DocumentsBulk_Contact_Contacts_fk Contact Contacts.ID Key
DocumentsBulk_ContractID_EmploymentContracts_fk ContractID EmploymentContracts.ID Key
DocumentsBulk_Creator_Users_fk Creator Users.UserID Key
DocumentsBulk_Currency_Currencies_fk Currency Currencies.Code Key
DocumentsBulk_DocumentFolder_DocumentFolders_fk DocumentFolder DocumentFolders.ID Key
DocumentsBulk_Modifier_Users_fk Modifier Users.UserID Key
DocumentsBulk_Opportunity_Opportunities_fk Opportunity Opportunities.ID Key
DocumentsBulk_Project_Projects_fk Project Projects.ID Key

Release Notes

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