CrmDocuments: Exact Online CRM Documents
read only per partition REST
- Catalog:
ExactOnlineREST - Schema:
CRM - Primary Keys:
ID - Label: CRM Documents
The data in this table is partitioned per value of the Division column.
Can only retrieve data.
API Source
- Endpoint:
/api/v1/{division}/read/crm/Documents - Metadata:
/api/v1/{division}/read/crm/$metadata
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 5 |
| Full scan rows per minute | 7,200 |
| 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 CrmDocuments 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. | |
Contact |
guid |
Contact | filters on the platform, writable | ID of the related contact of this document. | |
Created |
datetime |
Created | filters on the platform, writable | Creation date. | |
Created |
datetime |
Created (UTC) | writable | Creation date in UTC. | |
Creator |
guid |
Creator | filters on the platform, writable | User ID of creator. | |
Creator |
varchar2 |
Creator Full Name | filters on the platform, writable | Name of creator. | |
Division |
int32 |
Division | Division code. | ||
Division |
varchar2 |
Division Chamber of Commerce Number | writable | Chamber of commerce number of the Exact Online division. | |
Division |
varchar2 |
Division IBAN Number | writable | IBAN number of the Exact Online division. | |
Division |
varchar2 |
Division Company Name | writable | Company name of the Exact Online division. | |
Division |
varchar2 |
Division RSIN Number | writable | RSIN number of the Exact Online division. | |
Division |
varchar2 |
Division VAT Number | writable | VAT number of the Exact Online division. | |
Division |
varchar2 |
Division Wage Tax Number | writable | Wage tax number of the Exact Online division. | |
Division |
varchar2 |
Division Label | writable | Label of the Exact Online division. | |
Division |
varchar2 |
Administration Name | writable | Name of the Exact Online division. | |
Division |
varchar2 |
Subscription Holder Name | writable | Name of the customer account in division 1 owning the Exact Online subscription to which this division belongs. | |
Division |
varchar2 |
Subscription Holder Number | writable | Number of the customer account in division 1 owning the Exact Online subscription to which this division belongs. | |
Division |
int64 |
Division Short Name | writable | Short name of the Exact Online division. | |
Document |
datetime |
Document Date | filters on the platform, writable | Entry date of the incoming document. | |
Document |
guid |
Document Folder | filters on the platform, writable | Id of document folder. | |
Document |
varchar2 |
Document View URL | writable | Url to view the document. | |
HID |
int32 |
HID | filters on the platform, writable | Human-readable ID, formatted as xx.xxx.xxx. Unique. May not be equal to zero. | |
Has |
char |
Has Empty Body | writable | Indicates that the document body is empty. | |
ID |
guid |
ID | filters on the platform, writable | Primary key. | |
Modified |
datetime |
Modified | filters on the platform, writable | Last modified date. | |
Modified |
datetime |
Modified (UTC) | writable | Last modified date in UTC. | |
Modifier |
guid |
Modifier | filters on the platform, writable | User ID of modifier. | |
Opportunity |
guid |
Opportunity | filters on the platform, writable | The opportunity linked to the document. | |
Purchase |
int32 |
Purchase Invoice Number | filters on the platform, writable | Purchase invoice number. | |
Purchase |
int32 |
Purchase Order Number | filters on the platform, writable | Purchase order number. | |
Sales |
int32 |
Sales Invoice Number | filters on the platform, writable | 'Our reference' of the transaction that belongs to this document. | |
Sales |
int32 |
Sales Order Number | filters on the platform, writable | Number of the sales order. | |
Send |
int32 |
Send Method | filters on the platform, writable | Send Method. | |
Share |
int32 |
Share | filters on the platform, writable | ||
Share |
int16 |
itgen_eol_sharepointconnectionstatus | filters on the platform | Status of the SharePoint connection. | |
Share |
varchar2 |
SharePoint ID | filters on the platform | ||
Source |
int32 |
Source | filters on the platform | ||
Source |
varchar2 |
Source Description | filters on the platform | ||
Subject |
varchar2 |
Subject | filters on the platform, writable | Subject of this document. | |
Type |
int32 |
Type | filters on the platform, writable | The document type. | |
Type |
varchar2 |
Type Description | writable | Translated description of the document type. $filter and $orderby are not supported for this property. |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Crm |
Account |
Accounts.ID |
Key | |
Crm |
Contact |
Contacts.ID |
Key | |
Crm |
Creator |
Users. |
Key | |
Crm |
Document |
DocumentFolders.ID |
Key | |
Crm |
Modifier |
Users. |
Key | |
Crm |
Opportunity |
Opportunities.ID |
Key |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: