invantive documentation
Invantive Support ForumsLog In / Sign Up

AddressesRead: Exact Online Addresses (Read-only)

read only per partition REST

  • Catalog: ExactOnlineREST
  • Schema: CRM
  • Primary Keys: ID
  • Label: Addresses (Read-only)

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/Addresses
  • 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 AddressesRead 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 Account linked to the address.
AccountIsSupplier char Account Is Supplier filters on the platform, writable Indicates if the account is a supplier.
AccountName varchar2(50) Account Name filters on the platform, writable Name of the account.
AddressLine1 varchar2(80) Address Line 1 filters on the platform, writable First address line.
AddressLine2 varchar2(80) Address Line 2 filters on the platform, writable Second address line.
AddressLine3 varchar2(80) Address Line 3 filters on the platform, writable Third address line.
City varchar2(30) City filters on the platform, writable City.
Contact guid Contact filters on the platform, writable Contact linked to Address.
ContactName varchar2 Contact Name filters on the platform, writable Contact name.
Country varchar2(30) Country filters on the platform, writable Country code.
CountryName varchar2 Country Name filters on the platform, writable Country name.
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 filters on the platform, writable Name of creator.
CustomField varchar2 Custom Field writable
Division int32 Division 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.
Fax varchar2(25) Fax filters on the platform, writable Fax number.
FreeBoolField_01 char Free Boolean Field #1 filters on the platform, writable Free boolean field 1.
FreeBoolField_02 char Free Boolean Field #2 filters on the platform, writable Free boolean field 2.
FreeBoolField_03 char Free Boolean Field #3 filters on the platform, writable Free boolean field 3.
FreeBoolField_04 char Free Boolean Field #4 filters on the platform, writable Free boolean field 4.
FreeBoolField_05 char Free Boolean Field #5 filters on the platform, writable Free boolean field 5.
FreeDateField_01 datetime Free Date Field #1 filters on the platform, writable Free date field 1.
FreeDateField_02 datetime Free Date Field #2 filters on the platform, writable Free date field 2.
FreeDateField_03 datetime Free Date Field #3 filters on the platform, writable Free date field 3.
FreeDateField_04 datetime Free Date Field #4 filters on the platform, writable Free date field 4.
FreeDateField_05 datetime Free Date Field #5 filters on the platform, writable Free date field 5.
FreeNumberField_01 double Free Number Field #1 filters on the platform, writable Free number field 1.
FreeNumberField_02 double Free Number Field #2 filters on the platform, writable Free number field 2.
FreeNumberField_03 double Free Number Field #3 filters on the platform, writable Free number field 3.
FreeNumberField_04 double Free Number Field #4 filters on the platform, writable Free number field 4.
FreeNumberField_05 double Free Number Field #5 filters on the platform, writable Free number field 5.
FreeTextField_01 varchar2 Free Text Field #1 filters on the platform, writable Free text field 1.
FreeTextField_02 varchar2 Free Text Field #2 filters on the platform, writable Free text field 2.
FreeTextField_03 varchar2 Free Text Field #3 filters on the platform, writable Free text field 3.
FreeTextField_04 varchar2 Free Text Field #4 filters on the platform, writable Free text field 4.
FreeTextField_05 varchar2 Free Text Field #5 filters on the platform, writable Free text field 5.
ID guid ID filters on the platform, writable Primary key.
Mailbox varchar2(60) Mailbox filters on the platform, writable Mailbox.
Main char Main filters on the platform, writable Indicates if the address is the main address for this type.
Modified datetime Modified filters on the platform, writable Last modified date.
ModifiedUtc datetime Modified (UTC) writable Last modified date in UTC.
Modifier guid Modifier filters on the platform, writable User ID of modifier.
ModifierFullName varchar2(240) Modified Full Name filters on the platform, writable Name of modifier.
NicNumber varchar2 NIC Number filters on the platform, writable Last 5 digits of SIRET number which is an intern sequential number of 4 digits representing the identification of the localization of the office.
Notes varchar2 Notes filters on the platform, writable Notes for an address.
Phone varchar2(25) Phone filters on the platform, writable Phone number.
PhoneExtension varchar2(15) Phone Extension filters on the platform, writable Phone number extension.
Postcode varchar2(20) Postal Code filters on the platform, writable Postcode.
Source int16 Source filters on the platform, writable
State varchar2(30) State filters on the platform, writable State/Province code.
StateDescription varchar2 State Description filters on the platform, writable Name of the State.
Type int16 Type filters on the platform, writable The type of address. Visit=1, Postal=2, Invoice=3, Delivery=4.
Warehouse guid Warehouse filters on the platform, writable The warehouse linked to the address, if a warehouse is linked the account will be empty. Can only be filled for type=Delivery.
WarehouseCode varchar2 Warehouse Code filters on the platform, writable Code of the warehoude.
WarehouseDescription varchar2 Warehouse Description filters on the platform, writable Description of the warehouse.

Keys

Key Column Refers to Kind Description
AddressesRead_Account_Accounts_fk Account Accounts.ID Key
AddressesRead_Contact_Contacts_fk Contact Contacts.ID Key
AddressesRead_Creator_Users_fk Creator Users.UserID Key
AddressesRead_Modifier_Users_fk Modifier Users.UserID Key
AddressesRead_Warehouse_Warehouses_fk Warehouse Warehouses.ID Key

Release Notes

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