Accounts
Merge accounts
Merges two or more accounts of the same account type together. The given source accounts will be merged into the given target account and the merged account will keep the target account ID.
Request
[PlatformAddress]/api/connector/v1/accounts/merge
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of Account merge parameters | required, max 1000 items | Accounts to be merged. |
Account merge parameters
Property | Type | Contract | Description |
---|---|---|---|
| string Account type | required | |
| array of string | required, max 1000 items | |
| string | required |
Account type
Company
Customer
...
Response
Update accounts
Updates one or more existing accounts in the system. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/accounts/update
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of Account update parameters | required, max 1000 items | Accounts to be updated. |
Account update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the account. |
| string | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| string Account type discriminator | required | Type of the account. |
| optional | Customer data to be updated. Required when | |
| optional | Company data to be updated. Required when |
Customer update parameters
Property | Type | Contract | Description |
---|---|---|---|
| optional | Email address (or | |
| optional | Tax identification number (or | |
| optional | Billing code (or | |
| optional | Accounting code (or | |
| optional | Notes (or | |
| optional | Last name (or | |
| optional | First name (or | |
| optional | Second name (or | |
| optional | Birth place (or | |
| optional | Telephone number (or | |
| optional | Occupation (or | |
| optional | Car registration number (or | |
| optional | Loyalty code (or | |
| optional | Nationality code (or | |
| optional | Unique identifier of the company (or | |
| optional | Birth date (or | |
| optional | Sex (or | |
| optional | Title (or | |
| optional | Preferred language code (or | |
| optional | Options of the customer. | |
| optional | Classifications of the customer. | |
| optional | Legal entity identifiers of the customer. |
Customer update options
Property | Type | Contract | Description |
---|---|---|---|
| optional | Send marketing email (or | |
| optional | Invoiceable (or | |
| optional | Bill address objection (or |
Customer update classifications
Property | Type | Contract | Description |
---|---|---|---|
| optional | Paymaster account (or | |
| optional | Blacklist (or | |
| optional | Media (or | |
| optional | Loyalty program (or | |
| optional | Previous complaint (or | |
| optional | Returning (or | |
| optional | Staff (or | |
| optional | Friend or family (or | |
| optional | Top management (or | |
| optional | Important (or | |
| optional | Very important (or | |
| optional | Problematic (or | |
| optional | Cashlist (or | |
| optional | Disabled person (or | |
| optional | Military (or | |
| optional | Airline (or | |
| optional | Health compliant (or | |
| optional | In room (or | |
| optional | Waiting for room (or | |
| optional | Student (or |
Customer update legal entity identifiers
Property | Type | Contract | Description |
---|---|---|---|
| optional | Italian destination code (or | |
| optional | Italian fiscal code (or |
Company update parameters
Property | Type | Contract | Description |
---|---|---|---|
| optional | Email address (or | |
| optional | Tax identification number (or | |
| optional | Billing code (or | |
| optional | Accounting code (or | |
| optional | Notes (or | |
| optional | Name (or | |
| optional | Mother company (or | |
| optional | Website url (or | |
| optional | Invoice due interval (or | |
| optional | Basic credit rating (or | |
| optional | Department (or | |
| optional | Duns number (or | |
| optional | Reference identifier (or | |
| optional | External identifier (or | |
| optional | Additional tax identifier (or | |
| optional | Contact (or | |
| optional | Contact person (or | |
| optional | Fiscal identifier (or | |
| optional | Iata (or | |
| optional | Telephone (or | |
| optional | Source (or | |
| optional | Options of the company. | |
| optional | Classifications of the company. |
Company update options
Property | Type | Contract | Description |
---|---|---|---|
| optional | Invoiceable (or | |
| optional | Add fees to invoices (or |
Company update classifications
Property | Type | Contract | Description |
---|---|---|---|
| optional | Corporate (or | |
| optional | Internal (or | |
| optional | Private (or | |
| optional | Online travel agency (or | |
| optional | Global distribution system (or | |
| optional | Marketing (or | |
| optional | Inactive (or |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Account | optional | Updated accounts. |
Account
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the account. |
| string Account type discriminator | required | Type of the account. |
| required | Updated customer data. | |
| required | Updated company data. |
Customer
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the chain. |
| string | required | Creation date and time of the customer in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the customer in UTC timezone in ISO 8601 format. |
| string | required | Unique identifier of the user who updated the customer. |
| string | optional | Email address of the customer. |
| string | optional | Tax identification number of the customer. |
| string | optional | Billing code of the customer. |
| string | optional | Accounting code of the customer. |
| string | optional | Internal notes about the customer. |
| string | required | Last name of the customer. |
| string | optional | First name of the customer. |
| string | optional | Second last name of the customer. |
| string | optional | Place of birth. |
| string | optional | Telephone number of the customer (possibly mobile). |
| string | optional | Occupation of the customer. |
| string | optional | Registration number of the customer's car. |
| string | optional | Loyalty code of the customer. |
| string | optional | ISO 3166-1 code of the Country. |
| string | optional | Unique identifier of Company the customer is associated with. |
| string | optional | Date of birth in ISO 8601 format. |
| string Sex | optional | Sex of the customer. |
| string Title | optional | Title prefix of the customer. |
| string | optional | Language and culture code of the customers preferred language. E.g. |
| required | Options of the customer. | |
| required | Classifications of the customer. | |
| required | Legal entity identifiers of the customer. |
Company
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the chain. |
| string | optional | Date of Company creation date and time. |
| string | optional | Date of Company last update date and time. |
| string | required | Unique identifier of the user who updated the company. |
| string | optional | Email address of the company. |
| string | optional | Tax identification number of the company. |
| string | optional | Billing code of the company. |
| string | optional | Accounting code of the company. |
| string | optional | Additional notes. |
| string | required | Name of the company. |
| guid | optional | Unique identifier of mother company. |
| string | optional | The website url of the company. |
| string | optional | The maximum time, when the invoice has to be be paid in ISO 8601 duration format. |
| optional | Credit rating to define credit worthiness of the company. | |
| string | optional | The internal segmentation of a company, e.g. sales department. |
| string | optional | The Dun & Bradstreet unique 9-digit DUNS number. |
| string | optional | External system identifier - custom identifier used by an external system such as an external database. |
| string | optional, max 255 characters | Identifier of company from external system. |
| string | optional | Additional tax identifier of the company. |
| string | optional | Other contact details, such as telephone, email or similar. |
| string | optional | Contact person of the company. |
| string | optional | Fiscal identifier of the company. |
| string | optional | Iata of the company. |
| string | optional | Contact telephone number. |
| string | optional | Unique identifier of the Source. |
| required | Classifications of the company. | |
| required | Options of the company. |
Customer options
Property | Type | Contract | Description |
---|---|---|---|
| bool | required | Send marketing emails. |
| bool | required | Invoiceable. |
| bool | required | Bill address objection. |
| bool | required | Send marketing postal mail. |
| bool | required | Send partner marketing emails. |
| bool | required | Send partner marketing postal mail. |
Customer classifications
Property | Type | Contract | Description |
---|---|---|---|
| bool | required | Paymaster account. |
| bool | required | Blacklist. |
| bool | required | Media. |
| bool | required | Loyalty program. |
| bool | required | Previous complaint. |
| bool | required | Returning. |
| bool | required | Staff. |
| bool | required | Friend or family. |
| bool | required | Top management. |
| bool | required | Important. |
| bool | required | Very important. |
| bool | required | Problematic. |
| bool | required | Cash list. |
| bool | required | Disabled person. |
| bool | required | Military. |
| bool | required | Airline. |
| bool | required | Health compliant. |
| bool | required | In room. |
| bool | required | Waiting for room. |
| bool | required | Student. |
Customer legal identifiers
Property | Type | Contract | Description |
---|---|---|---|
| bool | required | Italian destination code. |
| bool | required | Italian fiscal code. |
Company classifications
Property | Type | Contract | Description |
---|---|---|---|
| bool | required | Corporate. |
| bool | required | Internal. |
| bool | required | Private. |
| bool | required | Online travel agency. |
| bool | required | Global distribution system. |
| bool | required | Marketing. |
| bool | required | Inactive. |
Last updated