Accounts
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
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.
ChainId
string
optional
AccountUpdates
required, max 1000 items
Accounts to be updated.
Account update parameters
Id
string
required
Unique identifier of the account.
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
.
Account type discriminator
Customer
Company
Customer update parameters
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 last 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, max length 255 characters
Car registration number (or null
if the car registration number should not be updated).
DietaryRequirements
optional, max length 255 characters
Dietary requirements (or null
if the dietary requirements 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
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
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).
Customer update legal entity identifiers
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
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 identifier (or null
if the mother company identifier 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).
Classifications
optional
Classifications of the company.
Options
optional
Options of the company.
CreditRatingBasic
required
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, max length 255 characters
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 fiscal identifier should not be updated).
Iata
optional
IATA of the company (or null
if the iata should not be updated).
Telephone
optional
Telephone number (or null
if the telephone number should not be updated).
SourceId
optional
Source identifier (or null
if the source identifier should not be updated).
Company update classifications
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).
GovernmentEntity
optional
Government Entity (or null
if the value should not be updated).
Credit rating basic
CreditOk
- Company can book services.PaymentRequiredUpfront
- Company must pay upfront.LocalDecisionRequired
- Requires local approval.
Response
Accounts
required, max 1000 items
Updated accounts.
Account
Id
string
required
Unique identifier of the account.
Discriminator
required
Type of the account.
Customer
optional
Updated customer data.
Company
optional
Updated company data.
Account type
Company
Customer
Customer
Updated customer data.
ChainId
string
required
Unique identifier of the chain.
CreatedUtc
string
required
Creation date and time of the customer in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the customer in UTC timezone in ISO 8601 format.
UpdaterProfileId
string
required
Unique identifier of the user who updated the customer.
Email
string
optional
Email address of the customer.
TaxIdentifier
string
optional
Tax identification number of the customer.
BillingCode
string
optional
Billing code of the customer.
AccountingCode
string
optional
Accounting code of the customer.
Notes
string
optional
Internal notes about the customer.
LastName
string
required
Last name of the customer.
FirstName
string
optional
First name of the customer.
SecondLastName
string
optional
Second last name of the customer.
BirthPlace
string
optional
Place of birth.
Telephone
string
optional
Telephone number of the customer (possibly mobile).
Occupation
string
optional
Occupation of the customer.
CarRegistrationNumber
string
optional, max length 255 characters
Registration number of the customer's car.
DietaryRequirements
string
optional, max length 255 characters
Dietary requirements of the customer.
LoyaltyCode
string
optional
Loyalty code of the customer.
NationalityCode
string
optional
ISO 3166-1 code of the Country
.
CompanyId
string
optional
Unique identifier of Company
the customer is associated with.
BirthDate
string
optional
Date of birth in ISO 8601 format.
Sex
string
optional
Sex of the customer.
Title
optional
Title prefix of the customer.
PreferredLanguageCode
string
optional
Language and culture code of the customer's preferred language. E.g. en-US
or fr-FR
.
Options
required
Options of the customer.
Classifications
required
Classifications of the customer.
LegalEntityIdentifiers
required
Legal entity identifiers of the customer.
Customer options
SendMarketingEmails
boolean
required
Send marketing emails.
Invoiceable
boolean
required
Invoiceable.
BillAddressObjection
boolean
required
Bill address objection.
Customer classifications
PaymasterAccount
boolean
required
Paymaster account.
Blacklist
boolean
required
Blacklist.
Media
boolean
required
Media.
LoyaltyProgram
boolean
required
Loyalty program.
PreviousComplaint
boolean
required
Previous complaint.
Returning
boolean
required
Returning.
Staff
boolean
required
Staff.
FriendOrFamily
boolean
required
Friend or family.
TopManagement
boolean
required
Top management.
Important
boolean
required
Important.
VeryImportant
boolean
required
Very important.
Problematic
boolean
required
Problematic.
Cashlist
boolean
required
Cash list.
DisabledPerson
boolean
required
Disabled person.
Military
boolean
required
Military.
Airline
boolean
required
Airline.
HealthCompliant
boolean
required
Health compliant.
InRoom
boolean
required
In room.
WaitingForRoom
boolean
required
Waiting for room.
Student
boolean
required
Student.
Customer legal identifiers
ItDestinationCode
string
optional
Italian destination code.
ItFiscalCode
string
optional
Italian fiscal code.
Company
ChainId
string
required
Unique identifier of the chain.
CreatedUtc
string
required
Creation date and time of the Company
in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the Company
in UTC timezone in ISO 8601 format.
UpdaterProfileId
string
required
Unique identifier of the user who updated the company.
Email
string
optional
Email address of the company.
TaxIdentifier
string
optional
Tax identification number of the company.
BillingCode
string
optional
Billing code of the company.
AccountingCode
string
optional
Accounting code of the company.
Notes
string
optional
Additional notes.
Name
string
required
Name of the company.
MotherCompanyId
string
optional
Unique identifier of mother company.
WebsiteUrl
string
optional
The website url of the company.
InvoiceDueInterval
string
optional
The maximum time (in ISO 8601 duration format), when the invoice has to be be paid.
CreditRatingBasic
optional
Credit rating to define credit worthiness of the company.
Department
string
optional
The internal segmentation of a company, e.g. sales department.
DunsNumber
string
optional
The Dun & Bradstreet unique 9-digit DUNS number.
ReferenceId
string
optional
External system identifier - custom identifier used by an external system such as an external database.
ExternalIdentifier
string
optional
Identifier of company from external system.
AdditionalTaxIdentifier
string
optional
Additional tax identifier of the company.
Contact
string
optional
Other contact details, such as telephone, email or similar.
ContactPerson
string
optional
Contact person of the company.
FiscalIdentifier
string
optional
Fiscal identifier of the company.
Iata
string
optional
Iata of the company.
Telephone
string
optional
Contact telephone number.
SourceId
string
optional
Unique identifier of the Source
.
Classifications
required
Classifications of the company.
Options
required
Options of the company.
Company classifications
Corporate
boolean
required
Corporate.
Internal
boolean
required
Internal.
Private
boolean
required
Private.
OnlineTravelAgency
boolean
required
Online travel agency.
GlobalDistributionSystem
boolean
required
Global distribution system.
Marketing
boolean
required
Marketing.
Inactive
boolean
required
Inactive.
GovernmentEntity
boolean
required
Government Entity
Company options
Invoiceable
boolean
required
Whether the company is invoiceable or not.
AddFeesToInvoices
boolean
required
Whether the company has an additional fee applied for invoicing or not.
AddTaxDeductedPaymentToInvoices
boolean
required
Whether tax-deducted payments should be automatically added to invoices.
Upload and link file to account
Attaches the specified file to the account.
Allowed MIME types: application/pdf
, image/bmp
, image/gif
, image/jpeg
, image/png
, image/tiff
.
Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/accounts/addFile
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.
ChainId
string
optional
AccountId
string
required
Unique identifier of the account to which the file will be uploaded to.
Name
string
required, max length 1000 characters
Uploaded file name.
Type
string
required, max length 1000 characters
Content type of the uploaded file following defined by its MIME type.
Data
string
required
Uploaded file data serialized in base64 format.
Response
FileId
string
required
Unique identifier of the uploaded file.
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
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 10 items
Accounts to be merged.
Account merge parameters
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
).
AccountType
required
Specifying types of the accounts provided (Customer
or Company
).
Account merge type
Customer
Company
Response
Last updated