Headers

• WEAL-TOKEN string Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID integer

  ID of organization, for which the operation must be performed

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer
  • organizationId integer
  • firstName string Required
  • middleName string
  • lastName string Required
  • nationalityCountryId integer
  • birthday string
  • gender string

    Values are MALE, FEMALE, or OTHER.

  • defaultLanguage string

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

  • phone string
  • fax string
  • mobile string
  • email string Required
  • webSite string
  • warnings string
  • addresses array[object]
    Hide addresses attributes Show addresses attributes object

    • id integer
    • name string Required
    • line1 string
    • line2 string
    • city string
    • region object
      Hide region attributes Show region attributes object

      • id integer
      • name string
      • code string
      • taxMode string

        Values are ANNUALLY or MONTHLY.

    • countryCode2 string
    • postCode string
    • toTheAttentionOf string
    • position integer(int32)
    • houseNumber string
    • countryId integer Required
    • service string
    • readOnly boolean
  • banks array[object]
    Hide banks attributes Show banks attributes object

    • id integer
    • name string Required
    • accountNumber string
    • qrIban string
    • isrCustomerNumber string
    • bankCustomerNumber string

      Format should match the following pattern: ^([1-9][0-9]*)*$.

    • swiftBic string
    • bankName string
    • remark string
    • position integer(int32)
    • useForReconciliation boolean
    • chartOfAccounts integer Required
    • accountHolderAddress object
      Hide accountHolderAddress attributes Show accountHolderAddress attributes object

      • id integer
      • name string Required
      • line1 string
      • line2 string
      • city string
      • region object
        Hide region attributes Show region attributes object

        • id integer
        • name string
        • code string
        • taxMode string

          Values are ANNUALLY or MONTHLY.

      • countryCode2 string
      • postCode string
      • toTheAttentionOf string
      • position integer(int32)
      • houseNumber string
      • countryId integer Required
      • service string
      • readOnly boolean
    • customHolder boolean
  • avatarId integer
  • defaultModule string

    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, 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, or FINANCIAL_STATEMENTS.

  • licenceType string

    Values are FREE or PREMIUM.

  • archived boolean
  • isFreeTier boolean
  • pdfPassword string
  • ecorrespondence boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error