Connector API
Search
K

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
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"AccountMergeParameters" : [
{
"AccountType" : "Company",
"SourceAccountIds" :
[
"b0c10ced-34eb-44b4-92e8-af5b008f3fb4",
"5176d000-bf17-40be-b140-9041d2b70eee"
],
"TargetAccountId" : "51262225-8130-4320-8210-af5b008f64e5"
},
{
"AccountType" : "Customer",
"SourceAccountIds" :
[
"7799f19a-c9c9-42bf-968f-a759e3ea1ea6",
"bb926ffe-5310-48bc-8202-6165fa3bdcad"
],
"TargetAccountId" : "49b2abd4-df58-4f1d-bead-0fa6342f8a78"
}
]
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
AccountMergeParameters
required, max 1000 items
Accounts to be merged.

Account merge parameters

Property
Type
Contract
Description
AccountType
string Account type
required
Specifying types of accounts provided (Customer, Company).
SourceAccountIds
array of string
required, max 1000 items
Unique identifiers of the source accounts (Customer or Company).
TargetAccountId
string
required
Unique identifier of the target account (Customer or Company).

Account type

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
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"AccountUpdates" : [
{
"Id": "3ff104e6-3ba8-4dfc-8d35-b0ec00c5fd4c",
"Discriminator": "Company",
"Customer": null,
"Company":
{
"Email": { "Value": "[email protected]" },
"TaxIdentifier": { "Value": "CZ8810310963" },
"BillingCode": { "Value": null },
"AccountingCode": { "Value": null },
"Notes": { "Value": "Example notes" },
"Name": { "Value": "Example company" },
"MotherCompanyId": { "Value": "839e9d92-aa8b-48bf-8384-b0ec0081bb34" },
"WebsiteUrl": { "Value": "https://www.example.com" },
"InvoiceDueInterval": { "Value": null },
"CreditRatingBasic": { "Value": "CreditOk" },
"Department": { "Value": "Accounting" },
"DunsNumber": { "Value": "987654321" },
"ReferenceId": { "Value": null },
"ExternalIdentifier": { "Value": "COM-123" },
"AdditionalTaxIdentifier": { "Value": "XY00112233445" },
"Contact": { "Value": "Sample contact" },
"ContactPerson": { "Value": "Sample person" },
"FiscalIdentifier": { "Value": "FiscalIdentifier" },
"Iata": { "Value": "PAO" },
"Telephone": { "Value": "111-222-333" },
"SourceId": { "Value": "F42098A0-8507-4963-ACC9-B0EC00821949" },
"Classifications":
{
"Corporate": { "Value": true },
"Internal": { "Value": true },
"Private": { "Value": true },
"OnlineTravelAgency": { "Value": true },
"GlobalDistributionSystem": { "Value": true },
"Marketing": { "Value": true },
"Inactive": { "Value": true }
},
"Options": {
"Invoiceable": { "Value": "true" },
"AddFeesToInvoices": { "Value": "true" }
}
}
},
{
"Id": "71db411f-c1d6-4e1c-9cd7-44e8bf45f936",
"Discriminator": "Customer",
"Company": null,
"Customer":
{
"Email": { "Value": "[email protected]" },
"TaxIdentifier": { "Value": "CZ8810310963" },
"BillingCode": { "Value": null },
"AccountingCode": { "Value": null },
"Notes": { "Value": "Example notes" },
"LastName": { "Value": "Sample" },
"FirstName": { "Value": "Sample" },
"SecondLastName": { "Value": null },
"BirthPlace": { "Value": "Sample place" },
"Telephone": { "Value": "111-222-333" },
"Occupation": { "Value": null },
"CarRegistrationNumber": { "Value": null },
"LoyaltyCode": { "Value": null },
"NationalityCode": { "Value": "US" },
"CompanyId": { "Value": "839e9d92-aa8b-48bf-8384-b0ec0081bb34" },
"BirthDate": { "Value": "2000-01-01" },
"Sex": { "Value": "Male" },
"Title": { "Value": "Mister" },
"PreferredLanguageCode": { "Value": null },
"Options":
{
"SendMarketingEmails": { "Value": true },
"Invoiceable": { "Value": true },
"BillAddressObjection": { "Value": true }
},
"Classifications":
{
"PaymasterAccount": { "Value": true },
"Blacklist": { "Value": true },
"Media": { "Value": true },
"LoyaltyProgram": { "Value": true },
"PreviousComplaint": { "Value": true },
"Returning": { "Value": true },
"Staff": { "Value": true },
"FriendOrFamily": { "Value": true },
"TopManagement": { "Value": true },
"Important": { "Value": true },
"VeryImportant": { "Value": true },
"Problematic": { "Value": true },
"Cashlist": { "Value": true },
"DisabledPerson": { "Value": true },
"Military": { "Value": true },
"Airline": { "Value": true },
"HealthCompliant": { "Value": true },
"InRoom": { "Value": true },
"WaitingForRoom": { "Value": true },
"Student": { "Value": true }
},
"LegalEntityIdentifiers":
{
"ItDestinationCode": { "Value": null },
"ItFiscalCode": { "Value": null }
}
}
}
]
}
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
AccountUpdates
required, max 1000 items
Accounts to be updated.

Account update parameters

Property
Type
Contract
Description
Id
string
required
Unique identifier of the account.
ChainId
string
optional
Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise.
Discriminator
required
Type of the account.
Customer
optional
Customer data to be updated. Required when Discriminator is Customer.
Company
optional
Company data to be updated. Required when Discriminator is Company.

Customer update parameters

Property
Type
Contract
Description
Email
optional
Email address (or null if the email should not be updated).
TaxIdentifier
optional
Tax identification number (or null if the tax identification number should not be updated).
BillingCode
optional
Billing code (or null if the billing code should not be updated).
AccountingCode
optional
Accounting code (or null if the accounting code should not be updated).
Notes
optional
Notes (or null if the notes should not be updated).
LastName
optional
Last name (or null if the last name should not be updated).
FirstName
optional
First name (or null if the first name should not be updated).
SecondLastName
optional
Second name (or null if the second last name should not be updated).
BirthPlace
optional
Birth place (or null if the birth place should not be updated).
Telephone
optional
Telephone number (or null if the telephone should not be updated).
Occupation
optional
Occupation (or null if the occupation should not be updated).
CarRegistrationNumber
optional
Car registration number (or null if the car registration number should not be updated).
LoyaltyCode
optional
Loyalty code (or null if the loyalty code should not be updated).
NationalityCode
optional
Nationality code (or null if the nationality code should not be updated).
CompanyId
optional
Unique identifier of the company (or null if the company should not be updated).
BirthDate
optional
Birth date (or null if the birth date should not be updated).
Sex
optional
Sex (or null if the sex should not be updated).
Title
optional
Title (or null if the title should not be updated).
PreferredLanguageCode
optional
Preferred language code (or null if the preferred language code should not be updated).
Options
optional
Options of the customer.
Classifications
optional
Classifications of the customer.
LegalEntityIdentifiers
optional
Legal entity identifiers of the customer.

Customer update options

Property
Type
Contract
Description
SendMarketingEmails
optional
Send marketing email (or null if the value should not be updated).
Invoiceable
optional
Invoiceable (or null if the value should not be updated).
BillAddressObjection
optional
Bill address objection (or null if the value should not be updated).

Customer update classifications

Property
Type
Contract
Description
PaymasterAccount
optional
Paymaster account (or null if the value should not be updated).
Blacklist
optional
Blacklist (or null if the value should not be updated).
Media
optional
Media (or null if the value should not be updated).
LoyaltyProgram
optional
Loyalty program (or null if the value should not be updated).
PreviousComplaint
optional
Previous complaint (or null if the value should not be updated).
Returning
optional
Returning (or null if the value should not be updated).
Staff
optional
Staff (or null if the value should not be updated).
FriendOrFamily
optional
Friend or family (or null if the value should not be updated).
TopManagement
optional
Top management (or null if the value should not be updated).
Important
optional
Important (or null if the value should not be updated).
VeryImportant
optional
Very important (or null if the value should not be updated).
Problematic
optional
Problematic (or null if the value should not be updated).
Cashlist
optional
Cashlist (or null if the value should not be updated).
DisabledPerson
optional
Disabled person (or null if the value should not be updated).
Military
optional
Military (or null if the value should not be updated).
Airline
optional
Airline (or null if the value should not be updated).
HealthCompliant
optional
Health compliant (or null if the value should not be updated).
InRoom
optional
In room (or null if the value should not be updated).
WaitingForRoom
optional
Waiting for room (or null if the value should not be updated).
Student
optional
Student (or null if the value should not be updated).
Property
Type
Contract
Description
ItDestinationCode
optional
Italian destination code (or null if the Italian destination code should not be updated).
ItFiscalCode
optional
Italian fiscal code (or null if the Italian fiscal code should not be updated).

Company update parameters

Property
Type
Contract
Description
Email
optional
Email address (or null if the email should not be updated).
TaxIdentifier
optional
Tax identification number (or null if the tax identification number should not be updated).
BillingCode
optional
Billing code (or null if the billing code should not be updated).
AccountingCode
optional
Accounting code (or null if the accounting code should not be updated).
Notes
optional
Notes (or null if the notes should not be updated).
Name
optional
Name (or null if the name should not be updated).
MotherCompanyId
optional
Mother company (or null if the mother company should not be updated).
WebsiteUrl
optional
Website url (or null if the website url should not be updated).
InvoiceDueInterval
optional
Invoice due interval (or null if the invoice due interval should not be updated).
CreditRatingBasic
optional
Basic credit rating (or null if the basic credit rating should not be updated).
Department
optional
Department (or null if the department should not be updated).
DunsNumber
optional
Duns number (or null if the duns number should not be updated).
ReferenceId
optional
Reference identifier (or null if the reference identifier should not be updated).
ExternalIdentifier
optional
External identifier (or null if the external identifier should not be updated).
AdditionalTaxIdentifier
optional
Additional tax identifier (or null if the additional tax identifier should not be updated).
Contact
optional
Contact (or null if the contact should not be updated).
ContactPerson
optional
Contact person (or null if the contact person should not be updated).
FiscalIdentifier
optional
Fiscal identifier (or null if the firscal identifier should not be updated).
Iata
optional
Iata (or null if the iata should not be updated).
Telephone
optional
Telephone (or null if the telephone should not be updated).
SourceId
optional
Source (or null if the source should not be updated).
Options
optional
Options of the company.
Classifications
optional
Classifications of the company.

Company update options

Property
Type
Contract
Description
Invoiceable
optional
Invoiceable (or null if the value should not be updated).
AddFeesToInvoices
optional
Add fees to invoices (or null if the value should not be updated).

Company update classifications

Property
Type
Contract
Description
Corporate
optional
Corporate (or null if the value should not be updated).
Internal
optional
Internal (or null if the value should not be updated).
Private
optional
Private (or null if the value should not be updated).
OnlineTravelAgency
optional
Online travel agency (or null if the value should not be updated).
GlobalDistributionSystem
optional
Global distribution system (or null if the value should not be updated).
Marketing
optional
Marketing (or null if the value should not be updated).
Inactive
optional
Inactive (or null if the value should not be updated).

Response