Body Required

• firstName string Required

  First name

• middleName string

  Middle name

• lastName string Required

  Last name

• nationalityCountryId integer(int64)

  Nationality country ID

• birthday string

  Birthday (format dd/MM/yyyy)

• gender string

  Gender

  Values are MALE, FEMALE, or OTHER.

• defaultLanguage string

  Default language

  Values are EN, FR, DE, IT, or UNDEFINED.

• phone string

  Phone number

• fax string

  Fax number

• mobile string

  Mobile number

• email string Required

  Email address

• webSite string

  Website URL

• addresses array[object]
  Hide addresses attributes Show addresses attributes object

  • id integer

    Entity ID. If negative value, a new entity will be created

  • name string

    Address label / name

  • line1 string

    Address line 1

  • line2 string

    Address line 2

  • city string

    City

  • region object

    Region

    Hide region attribute Show region attribute object

    • id integer

      Region ID

  • countryCode2 string

    ISO 3166-1 alpha-2 country code

  • countryId integer

    Country ID

  • postCode string

    Postal code

  • houseNumber string

    House number

  • toTheAttentionOf string

    To the attention of

  • position integer(int32)

    Position order

  • service string

    Service label

• banks array[object]

  Bank account for a contact

  Hide banks attributes Show banks attributes object

  Bank account for a contact

  • id integer

    Entity ID. If negative value, a new entity will be created

  • name string

    Bank account name / label

  • accountNumber string

    Account number / IBAN

  • swiftBic string

    SWIFT / BIC code

  • bankName string

    Bank name

  • remark string

    Remark or note

  • position integer(int32)

    Position order

  • chartOfAccounts integer

    Chart of accounts ID linked to this bank account

  • accountHolderAddress object

    Custom account holder address. Should be specified only if customHolder is set to true.

    Hide accountHolderAddress attributes Show accountHolderAddress attributes object

    • id integer

      Entity ID. If negative value, a new entity will be created

    • name string

      Address label / name

    • line1 string

      Address line 1

    • line2 string

      Address line 2

    • city string

      City

    • region object

      Region

      Hide region attribute Show region attribute object

      • id integer

        Region ID

    • countryCode2 string

      ISO 3166-1 alpha-2 country code

    • countryId integer

      Country ID

    • postCode string

      Postal code

    • houseNumber string

      House number

    • toTheAttentionOf string

      To the attention of

    • position integer(int32)

      Position order

    • service string

      Service label

  • customHolder boolean

    Whether a custom account holder address is used

• avatarId integer(int64)

  Avatar document ID

• defaultModule string

  Default module shown after login

  Values are ALL, NONE, CONTACTS, CONTACTS_DETAILS, CONTACTS_SUPPLIER, CONTACTS_CLIENT, CONTACTS_BALANCE, CONTACTS_STAFF, CONTACTS_STAFF_DOCUMENTS, CONTACTS_USER, CONTACTS_MAIN_USER, CONTACTS_USER_SECURITY, CONTACTS_USER_PERMISSIONS, CONTACTS_SYSTEM, CONTACTS_DOCUMENTS, CONTACTS_ROLES, CONTACTS_ROLES_SUPPLIER, CONTACTS_ROLES_CLIENT, CONTACTS_ROLES_STAFF, CONTACTS_ROLES_USER, CONTACTS_COMMUNICATIONS, ORGANIZATIONS_USERS_MANAGER, ORGANIZATIONS, ORGANIZATIONS_DETAILS, ORGANIZATIONS_TEMPLATES, ORGANIZATIONS_ACCOUNTING, ORGANIZATIONS_INVOICES, ORGANIZATIONS_SYSTEM, ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS, ORGANIZATIONS_SYSTEM_CODES, ORGANIZATIONS_SYSTEM_EBICS, ORGANIZATIONS_SYSTEM_INVENTORY, ORGANIZATIONS_DOCUMENTS, ORGANIZATIONS_DETAILS_INVOICING, PERMISSION_ROLES, PERMISSION_ROLES_DETAILS, BUSINESS_UNITS, ARTICLE_CATEGORIES, CHART_OF_ACCOUNTS, CHART_OF_ACCOUNTS_DETAILS, ACTIVITY_LOG, CURRENCIES, CURRENCIES_DETAILS, JOURNAL, JOURNAL_DETAILS, JOURNAL_DOCUMENTS, DOCUMENTS, DOCUMENTS_DETAILS, RECONCILIATION, PURCHASE_INVOICES, PURCHASE_INVOICES_DETAILS, PURCHASE_INVOICES_VALIDATION, PURCHASE_INVOICES_ACCOUNTING, PURCHASE_INVOICES_SHIPMENTS, PURCHASE_INVOICES_DOCUMENTS, PURCHASE_INVOICES_ALLOCATION_RULES, PURCHASE_INVOICES_WORKFLOW, SALES_INVOICES, SALES_INVOICES_DETAILS, SALES_INVOICES_VALIDATION, SALES_INVOICES_ACCOUNTING, SALES_INVOICES_DOCUMENTS, SALES_INVOICES_SHIPMENTS, SALES_INVOICES_REPORT, SALES_INVOICES_ALLOCATION_RULES, SALES_INVOICES_WORKFLOW, SALARIES, STOCK_REPORT, STOCK_MOVEMENTS, STOCK_MOVEMENTS_DETAILS, ORDERS, ORDERS_DETAILS, ORDERS_VALIDATION, ORDERS_SHIPMENT, ORDERS_INVOICES, ORDERS_EXPENSES, ORDERS_DOCUMENTS, ORDERS_WORKFLOW, ADVANCED_INVOICING, ADVANCED_INVOICING_GENERATE, ACCOUNTING_PERIODS, ACCOUNTING_PERIODS_DETAILS, ACCOUNTING_PERIODS_LOCK, ACCOUNTING_PERIODS_OPEN_CLOSE, GENERAL_LEDGER, GENERAL_LEDGER_STAFF, REPORT_TEMPLATE, ARTICLES, ARTICLES_DETAILS, PURCHASE_INVOICES_SCAN, PURCHASE_INVOICES_SCAN_DETAILS, RECOGNIZER, BALANCE, BALANCE_SHEET, BALANCE_SHEET_STAFF, PL_REPORT, PL_REPORT_STAFF, CASH_FLOW_REPORT, MY_TIMESHEETS, MY_ACCOUNT, TIME_DETAILS, TIME_DETAILS_DETAILS, TIME_DETAILS_WORKFLOW, TEAM_REVIEW, BUDGETING, BUDGETING_DETAILS, SALARY_CONFIG, SALARY_CONFIG_DETAILS, RECEIVABLES, PAYABLES, PAYABLES_PAYMENT_FILE, PDF_TEMPLATES, PDF_TEMPLATES_DETAILS, DASHBOARD, LATE_NOTICES, MY_DOCUMENTS, MY_DOCUMENTS_PAYROLL, MY_DOCUMENTS_OTHER, MY_DOCUMENTS_EXPORT_FILES, PAYROLL, PAYROLL_DETAILS, PAYROLL_ACCOUNTING, PAYROLL_SWISSDEC, VAT_REPORT, ORDER_REPORTS, ORDER_REPORTS_DETAILS, RATIOS_REPORT, VACATIONS, TRASH_CAN, USER_GROUPS, USER_GROUPS_DETAILS, WORKFLOW, WORKFLOW_DETAILS, MY_WORKFLOW_NOTIFICATIONS, FIXED_ASSETS, UNASSIGNED, EXPENSES, EXPENSES_DETAILS, EXPENSES_DRAFT, EXPENSES_DRAFT_DETAILS, CONTACT_BALANCE_REPORT, ORGANIZATION_CURRENCIES, ORGANIZATION_CURRENCIES_DETAILS, FINANCIAL_STATEMENTS, ALLOCATIONS, or ALLOCATIONS_DETAILS.

• licenceType string

  Licence type

  Values are FREE or PREMIUM.

• archived boolean

  Whether the account is archived

• pdfPassword string

  Password used to protect generated PDF payslips

• ecorrespondence boolean