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": "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": "example@example.com"
        },
        "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": "example@example.com"
        },
        "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.

ChainId

string

optional

AccountUpdates

required, max 1000 items

Accounts to be updated.

Account update parameters

Property
Type
Contract
Description

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

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 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

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 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

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).

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": [
    {
      "Id": "3ff104e6-3ba8-4dfc-8d35-b0ec00c5fd4c",
      "Discriminator": "Company",
      "Customer": null,
      "Company": {
        "ChainId": "79fa3c17-bec6-454f-b3be-b0ec00818acd",
        "CreatedUtc": "2024-01-03T07:52:20Z",
        "UpdatedUtc": "2024-01-18T10:20:31Z",
        "UpdaterProfileId": "93f03906-ed13-4a26-b8dc-b0ec0082194f",
        "Email": "example@example.com",
        "TaxIdentifier": "CZ8810310963",
        "BillingCode": null,
        "AccountingCode": null,
        "Notes": "Example notes",
        "Name": "Example company",
        "MotherCompanyId": "839e9d92-aa8b-48bf-8384-b0ec0081bb34",
        "WebsiteUrl": "https://www.example.com",
        "InvoiceDueInterval": null,
        "CreditRatingBasic": "CreditOk",
        "Department": "Accounting",
        "DunsNumber": "987654321",
        "ReferenceId": null,
        "ExternalIdentifier": "COM-123",
        "AdditionalTaxIdentifier": "XY00112233445",
        "Contact": "Sample contact",
        "ContactPerson": "Sample person",
        "FiscalIdentifier": "FiscalIdentifier",
        "Iata": "PAO",
        "Telephone": "111-222-333",
        "SourceId": "F42098A0-8507-4963-ACC9-B0EC00821949",
        "Classifications": {
          "Corporate": true,
          "Internal": true,
          "Private": true,
          "OnlineTravelAgency": true,
          "GlobalDistributionSystem": true,
          "Marketing": true,
          "Inactive": true
        },
        "Options": {
          "Invoiceable": true,
          "AddFeesToInvoices": true
        }
      }
    },
    {
      "Id": "71db411f-c1d6-4e1c-9cd7-44e8bf45f936",
      "Discriminator": "Customer",
      "Customer": {
        "ChainId": "79fa3c17-bec6-454f-b3be-b0ec00818acd",
        "CreatedUtc": "2024-01-03T07:52:19Z",
        "UpdatedUtc": "2024-01-18T10:25:41Z",
        "UpdaterProfileId": "93f03906-ed13-4a26-b8dc-b0ec0082194f",
        "Email": "example@example.com",
        "TaxIdentifier": "CZ8810310963",
        "BillingCode": null,
        "AccountingCode": null,
        "Notes": "Example notes",
        "LastName": "Sample",
        "FirstName": "Sample",
        "SecondLastName": null,
        "BirthPlace": "Sample place",
        "Telephone": "111-222-333",
        "Occupation": null,
        "CarRegistrationNumber": null,
        "LoyaltyCode": null,
        "NationalityCode": "US",
        "CompanyId": "839e9d92-aa8b-48bf-8384-b0ec0081bb34",
        "BirthDate": "2000-01-01T00:00:00Z",
        "Sex": "Male",
        "Title": "Mister",
        "PreferredLanguageCode": null,
        "Options": {
          "SendMarketingEmails": true,
          "Invoiceable": true,
          "BillAddressObjection": true
        },
        "Classifications": {
          "PaymasterAccount": true,
          "Blacklist": true,
          "Media": true,
          "LoyaltyProgram": true,
          "PreviousComplaint": true,
          "Returning": true,
          "Staff": true,
          "FriendOrFamily": true,
          "TopManagement": true,
          "Important": true,
          "VeryImportant": true,
          "Problematic": true,
          "Cashlist": true,
          "DisabledPerson": true,
          "Military": true,
          "Airline": true,
          "HealthCompliant": true,
          "InRoom": true,
          "WaitingForRoom": true,
          "Student": true
        },
        "LegalEntityIdentifiers": {
          "ItDestinationCode": null,
          "ItFiscalCode": null
        }
      },
      "Company": null
    }
  ]
}
Property
Type
Contract
Description

Accounts

required, max 1000 items

Updated accounts.

Account

Property
Type
Contract
Description

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.

Property
Type
Contract
Description

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

Property
Type
Contract
Description

SendMarketingEmails

boolean

required

Send marketing emails.

Invoiceable

boolean

required

Invoiceable.

BillAddressObjection

boolean

required

Bill address objection.

Customer classifications

Property
Type
Contract
Description

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.

Property
Type
Contract
Description

ItDestinationCode

string

optional

Italian destination code.

ItFiscalCode

string

optional

Italian fiscal code.

Company

Property
Type
Contract
Description

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

Property
Type
Contract
Description

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

Property
Type
Contract
Description

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.

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": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "AccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "Name": "document.pdf",
  "Type": "application/pdf",
  "ChainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
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.

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": "f039f5b4-ff18-4510-9086-92b14a68ed78"
}
Property
Type
Contract
Description

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": "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 10 items

Accounts to be merged.

Account merge parameters

Property
Type
Contract
Description

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