Even geduld a.u.b...

Exact Online REST API - CRM/Accounts

Endpoint

CRM/Accounts

Good to know

The sync api's have the goal to keep the data between Exact Online and a 3rd party application the same.

The sync api's are all based on row versioning and because of that it is guaranteed to be unique. Every time an existing record is changed or a new record is inserted, the row versioning value is higher than the highest available value at that time. When retrieving records via these api's also a timestamp value is returned. The highest timestamp value of the records returned should be stored on client side. Next time records are retrieved, the timestamp value stored on client side should be provided as parameter. The api will then return only the new and changed records. Using this method is more reliable than using modified date, since it can happen that multiple records have the same modified date and therefore same record can be returned more than once. This will not happen when using timestamp.

The sync api's are also developed to give best performance when retrieving records. Because of performance and the intended purpose of the api's, only the timestamp field is allowed as parameter.

The single and bulk api’s are designed for a different purpose. They provide ability to retrieve specific record or a set of records which meet certain conditions.

In case the division is moved to another database in Exact Online the timestamp values will be reset. Therefore, after a division is moved all data needs to be synchronized again in order to get the new timestamp values. To see if a division was moved, the /api/v1/{division}/system/Divisions can be used. The property DivisionMoveDate indicated at which date a division was moved and this date can be used to determine if it is needed to synchronize all data again.

The API has two important key fields, the Timestamp and the ID. The ID should be used to uniquely identify the record and will never change. The Timestamp is used to get new or changed records in an efficient way and will change for every change made to the record.

The timestamp value returned has no relation with actual date or time. As such it cannot be converted to a date\time value. The timestamp is a rowversion value.

When you use the sync or delete api for the first time for a particular division, filter on timestamp greater than 1.

Scope

Crm accounts

URI

/api/v1/{division}/sync/CRM/Accounts


GET

Example usage

/api/v1/{division}/sync/CRM/Accounts

/api/v1/{division}/sync/CRM/Accounts

/api/v1/{division}/sync/CRM/Accounts

/api/v1/{division}/sync/CRM/Accounts


Properties

Name Mandatory Value Value Type Webhook Description
Timestamp False Edm.Int64 Timestamp
Accountant False Edm.Guid Supports webhook Reference to the accountant of the customer. Conditions: The referred accountant must have value > 0 in the field IsAccountant
AccountManager False Edm.Guid Supports webhook ID of the account manager
AccountManagerFullName False Edm.String Name of the account manager
AccountManagerHID False Edm.Int32 Number of the account manager
ActivitySector False Edm.Guid Supports webhook Reference to Activity sector of the account
ActivitySubSector False Edm.Guid Supports webhook Reference to Activity sub-sector of the account
AddressLine1 False Edm.String Supports webhook Visit address first line
AddressLine2 False Edm.String Supports webhook Visit address second line
AddressLine3 False Edm.String Supports webhook Visit address third line
BankAccounts False Collection of Bank accounts
Blocked False Edm.Boolean Supports webhook Indicates if the account is blocked
BRIN False Edm.Guid Supports webhook Obsolete
BSN False Edm.String Citizen Service Number for the Netherlands
BusinessType False Edm.Guid Supports webhook Reference to the business type of the account
CanDropShip False Edm.Boolean Supports webhook Indicates the default for the possibility to drop ship when an item is linked to a supplier
ChamberOfCommerce False Edm.String Supports webhook Chamber of commerce number
City False Edm.String Supports webhook Visit address City
Classification False Edm.String Obsolete
Classification1 False Edm.Guid Account classification 1
Classification2 False Edm.Guid Account classification 2
Classification3 False Edm.Guid Account classification 3
Classification4 False Edm.Guid Account classification 4
Classification5 False Edm.Guid Account classification 5
Classification6 False Edm.Guid Account classification 6
Classification7 False Edm.Guid Account classification 7
Classification8 False Edm.Guid Account classification 8
ClassificationDescription False Edm.String Obsolete
Code False Edm.String Supports webhook Unique key, fixed length numeric string with leading spaces, length 18. IMPORTANT: When you use OData $filter on this field you have to make sure the filter parameter contains the leading spaces
CodeAtSupplier False Edm.String Supports webhook Code under which your own company is known at the account
CompanySize False Edm.Guid Supports webhook Reference to Company size of the account
ConsolidationScenario False Edm.Byte Supports webhook Consolidation scenario (Time & Billing). Values: 0 = No consolidation, 1 = Item, 2 = Item + Project, 3 = Item + Employee, 4 = Item + Employee + Project, 5 = Project + WBS + Item, 6 = Project + WBS + Item + Employee. Item means in this case including Unit and Price, these also have to be the same to consolidate
ControlledDate False Edm.DateTime Supports webhook Date of the latest control of account data with external web service
Costcenter False Edm.String Supports webhook Obsolete
CostcenterDescription False Edm.String Obsolete
CostPaid False Edm.Byte Supports webhook Obsolete
Country False Edm.String Supports webhook Country code
CountryName False Edm.String Country name
Created False Edm.DateTime Creation date
Creator False Edm.Guid User ID of creator
CreatorFullName False Edm.String Name of creator
CreditLinePurchase False Edm.Double Supports webhook Maximum amount of credit for Purchase. If no value has been defined, there is no credit limit
CreditLineSales False Edm.Double Supports webhook Maximum amount of credit for sales. If no value has been defined, there is no credit limit
Currency False Edm.String Supports webhook Obsolete
CustomerSince False Edm.DateTime Supports webhook Obsolete
CustomField False Edm.String Custom field endpoint. Provided only for the Exact Online Premium users.
DatevCreditorCode False Edm.String DATEV creditor code for Germany legislation
DatevDebtorCode False Edm.String DATEV debtor code for Germany legislation
DeliveryAdvice False Edm.Byte Allows a customer to do goods delivery based on setting complete, partial or partial no back order. Values: 0 = Partial, 1 = Complete, 2 = PartialNoBackOrder
DiscountPurchase False Edm.Double Supports webhook Default discount percentage for purchase. This is stored as a fraction. ie 5.5% is stored as .055
DiscountSales False Edm.Double Supports webhook Default discount percentage for sales. This is stored as a fraction. ie 5.5% is stored as .055
Division False Edm.Int32 Supports webhook Division code
Document False Edm.Guid Supports webhook Obsolete
DunsNumber False Edm.String Supports webhook Obsolete
Email False Edm.String Supports webhook E-Mail address of the account
EndDate False Edm.DateTime Supports webhook Determines in combination with the start date if the account is active. If the current date is > end date the account is inactive
EORINumber False Edm.String EORI number
EstablishedDate False Edm.DateTime Supports webhook RegistrationDate
Fax False Edm.String Supports webhook Fax number
GLAccountPurchase False Edm.Guid Supports webhook Default (corporate) GL offset account for purchase (cost)
GLAccountSales False Edm.Guid Supports webhook Default (corporate) GL offset account for sales (revenue)
GLAP False Edm.Guid Supports webhook Default GL account for Accounts Payable
GLAR False Edm.Guid Supports webhook Default GL account for Accounts Receivable
GlnNumber False Edm.String Supports webhook Global Location Number can be used by companies to identify their locations, giving them complete flexibility to identify any type or level of location required
HasWithholdingTaxSales False Edm.Boolean Indicates whether a customer has withholding tax on sales
ID False Edm.Guid Primary key
IgnoreDatevWarningMessage False Edm.Boolean Suppressed warning message when there is duplication on the DATEV code
IncotermAddressPurchase False Edm.String Address of Incoterm for Purchase
IncotermAddressSales False Edm.String Address of Incoterm for Sales
IncotermCodePurchase False Edm.String Code of Incoterm for Purchase
IncotermCodeSales False Edm.String Code of Incoterm for Sales
IncotermVersionPurchase False Edm.Int16 Version of Incoterm for Purchase
Supported version for Incoterms : 2010, 2020
IncotermVersionSales False Edm.Int16 Version of Incoterm for Sales
Supported version for Incoterms : 2010, 2020
IntraStatArea False Edm.String Supports webhook Intrastat Area
IntraStatDeliveryTerm False Edm.String Supports webhook Intrastat delivery method
IntraStatSystem False Edm.String Supports webhook System for Intrastat
IntraStatTransactionA False Edm.String Supports webhook Transaction type A for Intrastat
IntraStatTransactionB False Edm.String Supports webhook Transaction type B for Intrastat
IntraStatTransportMethod False Edm.String Supports webhook Transport method for Intrastat
InvoiceAccount False Edm.Guid Supports webhook ID of account to be invoiced instead of this account
InvoiceAccountCode False Edm.String Code of InvoiceAccount
InvoiceAccountName False Edm.String Name of InvoiceAccount
InvoiceAttachmentType False Edm.Int32 Supports webhook Indicates which attachment types should be sent when a sales invoice is printed. Only values in related table with Invoice=1 are allowed
InvoicingMethod False Edm.Int32 Supports webhook Method of sending for sales invoices. Values: 1: Paper, 2: EMail, 4: Mailbox (electronic exchange), 8: Send and track
IsAccountant False Edm.Byte Supports webhook Indicates whether the account is an accountant. Values: 0 = No accountant, 1 = True, but accountant doesn't want his name to be published in the list of accountants, 2 = True, and accountant is published in the list of accountants
IsAgency False Edm.Byte Supports webhook Indicates whether the accounti is an agency
IsAnonymised False Edm.Byte Indicates whtether the account is anonymised.
IsBank False Edm.Boolean Supports webhook Obsolete
IsCompetitor False Edm.Byte Supports webhook Indicates whether the account is a competitor
IsExtraDuty False Edm.Boolean Indicates whether a customer is eligible for extra duty
IsMailing False Edm.Byte Supports webhook Indicates if the account is excluded from mailing marketing information
IsMember False Edm.Boolean Supports webhook Obsolete
IsPilot False Edm.Boolean Supports webhook Indicates whether the account is a pilot account
IsPurchase False Edm.Boolean Supports webhook Obsolete
IsReseller False Edm.Boolean Supports webhook Indicates whether the account is a reseller
IsSales False Edm.Boolean Supports webhook Indicates whether the account is allowed for sales
IsSupplier False Edm.Boolean Supports webhook Indicates whether the account is a supplier
Language False Edm.String Supports webhook Language code
LanguageDescription False Edm.String Language description
Latitude False Edm.Double Supports webhook Latitude (used by Google maps)
LeadPurpose False Edm.Guid Supports webhook Reference to Lead purpose of an account
LeadSource False Edm.Guid Supports webhook Reference to Lead source of an account
Logo False Edm.Binary Supports webhook Bytes of the logo image
LogoFileName False Edm.String Supports webhook The file name (without path, but with extension) of the image
LogoThumbnailUrl False Edm.String Thumbnail url of the logo
LogoUrl False Edm.String Url to retrieve the logo
Longitude False Edm.Double Supports webhook Longitude (used by Google maps)
MainContact False Edm.Guid Supports webhook Reference to main contact person
Modified False Edm.DateTime Supports webhook Last modified date
Modifier False Edm.Guid User ID of modifier
ModifierFullName False Edm.String Name of modifier
Name True Edm.String Supports webhook Account name
OINNumber False Edm.String Dutch government identification number
Parent False Edm.Guid Supports webhook ID of the parent account
PayAsYouEarn False Edm.String Indicates the loan repayment plan for UK legislation
PaymentConditionPurchase False Edm.String Supports webhook Code of default payment condition for purchase
PaymentConditionPurchaseDescription False Edm.String Description of PaymentConditionPurchase
PaymentConditionSales False Edm.String Supports webhook Code of default payment condition for sales
PaymentConditionSalesDescription False Edm.String Description of PaymentConditionSales
Phone False Edm.String Supports webhook Phone number
PhoneExtension False Edm.String Supports webhook Phone number extention
Postcode False Edm.String Supports webhook Visit address postcode
PriceList False Edm.Guid Supports webhook Default sales price list for account
PurchaseCurrency False Edm.String Supports webhook Currency of purchase
PurchaseCurrencyDescription False Edm.String Description of PurchaseCurrency
PurchaseLeadDays False Edm.Int32 Supports webhook Indicates number of days required to receive a purchase. Acts as a default
PurchaseVATCode False Edm.String Supports webhook Default VAT code used for purchase entries
PurchaseVATCodeDescription False Edm.String Description of PurchaseVATCode
RecepientOfCommissions False Edm.Boolean Supports webhook Define the relation that should be taken in the official document of the rewarding fiscal fiches Belcotax
Remarks False Edm.String Remarks
Reseller False Edm.Guid Supports webhook ID of the reseller account. Conditions: the target account must have the property IsReseller turned on
ResellerCode False Edm.String Code of Reseller
ResellerName False Edm.String Name of Reseller
RSIN False Edm.String Supports webhook Fiscal number for NL legislation
SalesCurrency False Edm.String Supports webhook Currency of Sales used for Time & Billing
SalesCurrencyDescription False Edm.String Description of SalesCurrency
SalesTaxSchedule False Edm.Guid Obsolete
SalesTaxScheduleCode False Edm.String Obsolete
SalesTaxScheduleDescription False Edm.String Obsolete
SalesVATCode False Edm.String Supports webhook Default VAT code for a sales entry
SalesVATCodeDescription False Edm.String Description of SalesVATCode
SearchCode False Edm.String Supports webhook Search code
SecurityLevel False Edm.Int32 Supports webhook Security level (0 - 100)
SeparateInvPerProject False Edm.Byte Supports webhook Separate invoice per project (Time & Billing)
SeparateInvPerSubscription False Edm.Byte Supports webhook Indicates how invoices are generated from subscriptions. 0 = subscriptions belonging to the same customer are combined in a single invoice. 1 = each subscription results in one invoice. In both cases, each individual subscription line results in one invoice line
ShippingLeadDays False Edm.Int32 Supports webhook Indicates the number of days it takes to send goods to the customer. Acts as a default
ShippingMethod False Edm.Guid Supports webhook Default shipping method
ShowRemarkForSales False Edm.Boolean Indicates whether to display Ordered by account's remarks when creating a new sales order
StartDate False Edm.DateTime Supports webhook Indicates in combination with the end date if the account is active
State False Edm.String Supports webhook State/Province/County code When changing the Country and the State is filled, the State must be assigned with a valid value from the selected country or set to empty
StateName False Edm.String Name of State
Status False Edm.String Supports webhook If the status field is filled this means the account is a customer. The value indicates the customer status. Possible values: A=None, S=Suspect, P=Prospect, C=Customer
StatusSince False Edm.DateTime Supports webhook Obsolete
TradeName False Edm.String Supports webhook Trade name can be registered and shown with the client (for all legislations)
Type False Edm.String Supports webhook Account type: Values: A = Relation, D = Division
UniqueTaxpayerReference False Edm.String Unique taxpayer reference for UK legislation
VATLiability False Edm.String Supports webhook Indicates the VAT status of an account to be able to identify the relation that should be selected in the VAT debtor listing in Belgium
VATNumber False Edm.String Supports webhook The number under which the account is known at the Value Added Tax collection agency
Website False Edm.String Supports webhook Website of the account

Returns