Headers

• TARGET-ORGANIZATION-ID integer(int32)

  ID of organization, for which the operation must be performed

• WEAL-TOKEN string Required

  API token (can be retrieved from account settings)

Path parameters

• id integer Required

  id

Responses

• 200 */*

  OK

  Hide response attributes Show response attributes object

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

    • id integer
    • note string
    • tag object
      Hide tag attributes Show tag attributes object

      • id integer
      • name string
  • addresses array[object]
    Hide addresses attributes Show addresses attributes object

    • city string
    • countryCode2 string
    • countryId integer
    • houseNumber string
    • id integer
    • line1 string
    • line2 string
    • name string
    • position integer(int32)
    • postCode string
    • readOnly boolean
    • region object
      Hide region attributes Show region attributes object

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

        Values are ANNUALLY or MONTHLY.

    • service string
    • toTheAttentionOf string
  • archived boolean
  • banks array[object]
    Hide banks attributes Show banks attributes object

    • accountHolderAddress object
      Hide accountHolderAddress attributes Show accountHolderAddress attributes object

      • city string
      • countryCode2 string
      • countryId integer
      • houseNumber string
      • id integer
      • line1 string
      • line2 string
      • name string
      • position integer(int32)
      • postCode string
      • readOnly boolean
      • region object
        Hide region attributes Show region attributes object

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

          Values are ANNUALLY or MONTHLY.

      • service string
      • toTheAttentionOf string
    • accountNumber string
    • bankCustomerNumber string
    • bankName string
    • chartOfAccounts integer
    • customHolder boolean
    • id integer
    • isrCustomerNumber string
    • name string
    • position integer(int32)
    • qrIban string
    • remark string
    • swiftBic string
    • useForReconciliation boolean
  • client object
    Hide client attributes Show client attributes object

    • PLAccountName object
      Hide PLAccountName attributes Show PLAccountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • advancedInvoicingNote string
    • articleDiscounts array[object]
      Hide articleDiscounts attributes Show articleDiscounts attributes object

      • articleId integer
      • articleIdName object
        Hide articleIdName attributes Show articleIdName attributes object

        • de string
        • en string
        • fr string
        • it string
      • discount number
      • id integer
    • balanceSheetAccountId integer
    • balanceSheetAccountName object
      Hide balanceSheetAccountName attributes Show balanceSheetAccountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • billingEmail string
    • businessUnitId integer
    • businessUnitName string
    • clientDiscountRate string
    • contactId integer
    • creditLimit string
    • currencyId integer
    • id integer
    • invoiceAddressId integer
    • invoiceAddressName string
    • lateNoticeEmail string
    • lateNoticeMargin string
    • officeId integer
    • orderAddressId integer
    • orderAddressName string
    • orderEmail string
    • orderValidity string
    • paymentAccountId integer
    • paymentAccountName object
      Hide paymentAccountName attributes Show paymentAccountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • paymentTerms string
    • placcountId integer
    • placcountName object
      Hide placcountName attributes Show placcountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • vatNumber string
    • vatRateId integer
    • vatTypeCodeId integer
  • communications array[object]
    Hide communications attributes Show communications attributes object

    • date string
    • description string
    • externalContactId integer
    • externalContactIdName string
    • externalContactName string
    • id integer
    • longDescription string
    • ourContactId integer
    • ourContactName string
    • type string

      Values are PHONE_CALL, EMAIL, INTERNAL_MEETING, EXTERNAL_MEETING, or NOTE.

  • contactId integer
  • contactType string

    Values are ORGANIZATION or PERSON.

  • defaultLanguage string

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

  • defaultModule string

    Values are ALL, NONE, CONTACTS, CONTACTS_DETAILS, CONTACTS_SUPPLIER, CONTACTS_CLIENT, 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_CODES, ORGANIZATIONS_SYSTEM_INVENTORY, ORGANIZATIONS_SYSTEM_ALLOCATION_KEYS, ORGANIZATIONS_SYSTEM_EBICS, 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_PAYROLL, 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.

  • ecorrespondence boolean
  • email string
  • externalId string
  • fax string
  • groupRoles array[object]
    Hide groupRoles attributes Show groupRoles attributes object

    • id integer
    • name string
    • roleType string

      Values are ORGANIZATION or GLOBAL.

  • id integer
  • isCustomer boolean
  • isStaff boolean
  • isUser boolean
  • isVendor boolean
  • mobile string
  • organizationId integer
  • organizationUsesTimesheets boolean
  • permissionsTree array[object]
    Hide permissionsTree attributes Show permissionsTree attributes object

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

      • email string
      • id integer
      • name string
    • availableRoles array[object]
      Hide availableRoles attributes Show availableRoles attributes object

      • description string
      • id integer
      • isDefault boolean
      • name string
      • realId integer
      • roleType string

        Values are ORGANIZATION or GLOBAL.

      • type string

        Values are ROLE or SUPER_ROLE.

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

      • id integer
      • isDefault boolean
      • name string
      • type string

        Values are ROLE or SUPER_ROLE.

    • id integer
    • isActive boolean
    • name string
    • organizationId integer
    • parentOrganizationId integer(int32)
    • roles array[object]
      Hide roles attributes Show roles attributes object

      • id integer
      • isDefault boolean
      • name string
      • type string

        Values are ROLE or SUPER_ROLE.

    • subUserContactId integer
  • phone string
  • relatedContactIds array[integer]
  • relatedOrganizationContactIds array[integer]
  • staff object
    Hide staff attributes Show staff attributes object

    • avsNumber string
    • contactId integer
    • contractType string

      Values are OPEN_ENDED, OPEN_ENDED_YEAR, FIXED, APPRENTICESHIP, or INTERN.

    • costCalculationType string

      Values are AUTOMATIC or MANUAL.

    • documentExpiryDate string
    • documentNumber string
    • employeeDocumentType string

      Values are PASSPORT or ID.

    • employmentEndDate string
    • employmentStartDate string
    • enforceTimesheets boolean
    • familyMembers array[object]
      Hide familyMembers attributes Show familyMembers attributes object

      • birthDate string
      • familyMemberType string

        Values are SPOUSE or CHILD.

      • firstName string
      • id integer
      • lastName string
      • nationalityCountryId integer
      • staffId integer
    • id integer
    • isSpouseWorking boolean
    • jobTitle string
    • maritalDate string
    • maritalType string

      Values are SINGLE, MARRIED, DIVORCED, SEPARATED, or WIDOWED.

    • pdfPassword string
    • permitExpiryDate string
    • position string

      Values are SENIOR, MIDDLE, LOWER, or RESP.

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

      • baseSalaryLine object
        Hide baseSalaryLine attributes Show baseSalaryLine attributes object

        • employeeAmount string
        • employerAmount string
        • id integer
        • payslipLineEntityId integer
        • payslipValueSplitType string

          Values are EMPLOYEE, EMPLOYER, or BOTH.

        • staffPayslipEntityId integer
      • calendarYear integer(int32)
      • employeeGroups array[object]
        Hide employeeGroups attributes Show employeeGroups attributes object

        • departmentId integer
        • departmentName string
        • groupType string

          Values are ADMIN or OPERATIONS.

        • id integer
        • officeId integer
        • officeName string
        • percentage string
        • staffPayslipEntityId integer
      • employmentEndDate string
      • employmentStartDate string
      • id integer
      • isCanteenMealsOrMealsVouchers boolean
      • isFreeTransportToWork boolean
      • payslipTableLines array[object]
        Hide payslipTableLines attributes Show payslipTableLines attributes object

        • description string
        • employeePercentage string
        • employeeValue string
        • employerPercentage string
        • employerValue string
        • endDate string
        • id integer
        • number integer
        • organizationEmployeeGroupId integer
        • organizationPayslipEntityId integer
        • payslipEntityId integer
        • payslipLineId string
        • quantity string
        • staffPayslipEntityId integer
        • startDate string
      • salaryCertificateNotes string
      • salaryInfo object
        Hide salaryInfo attributes Show salaryInfo attributes object

        • capacity string
        • defaultPaymentAccountId integer
        • defaultPaymentAccountName object
          Hide defaultPaymentAccountName attributes Show defaultPaymentAccountName attributes object

          • de string
          • en string
          • fr string
          • it string
        • denominationType string

          Values are RCC, CCC, ERC, IRC, or ONO.

        • hasOnlyOneJob boolean
        • hourlyRate string
        • id integer
        • isSourceTaxEnabled boolean
        • numberOfVacationDays string
        • organizationEmployeeGroupId integer
        • organizationId integer
        • payableToBankId integer
        • payrollCurrencyId integer
        • regionId integer
        • salaryType string

          Values are MONTHLY or HOURLY.

        • singleParentType string

          Values are NOCOHAB, COHABSC, COHABJC, or COHABO18.

        • sourceTaxCode string
        • staffId integer
        • staffPayslipEntityId integer
        • totalOccupancy string
        • workOccupancy string
      • staffId integer
      • systemLine object
        Hide systemLine attributes Show systemLine attributes object

        • bracket string
        • id integer
        • localizations object
          Hide localizations attributes Show localizations attributes object

          • de string
          • en string
          • fr string
          • id integer
          • it string
        • number integer
        • payslipLineEntityId integer
        • rate string
        • staffPayslipEntityId integer
    • timesheetPricingLines array[object]
      Hide timesheetPricingLines attributes Show timesheetPricingLines attributes object

      • clientId integer
      • clientName string
      • endDate string
      • id integer
      • orderId integer
      • rate string
      • staffId integer
      • startDate string
      • task object
        Hide task attributes Show task attributes object

        • archived boolean
        • id integer
        • name string
        • organizationId integer
        • rate number
    • timesheetsCost string
    • trainingLevel string

      Values are PHD, MASTER_ETH, BACHELOR_ETH, MASTER_UAS, BACHELOR_UAS, HES, MASTER, BACHELOR, TC, MATU, CVT, IN_HOUSE, or COMP_SCHOOL.

    • workPermit object
      Hide workPermit attributes Show workPermit attributes object

      • countryId integer
      • id integer
      • name object
        Hide name attributes Show name attributes object

        • de string
        • en string
        • fr string
        • it string
      • nameId integer
  • supplier object
    Hide supplier attributes Show supplier attributes object

    • PLAccountName object
      Hide PLAccountName attributes Show PLAccountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • balanceSheetAccountId integer
    • balanceSheetAccountName object
      Hide balanceSheetAccountName attributes Show balanceSheetAccountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • businessUnitId integer
    • businessUnitName string
    • contactId integer
    • currencyId integer
    • feeSplitType string

      Values are CHARGED_TO_THE_BENEFICIARY, FIFTY_FIFTY_SPLIT, or CHARGED_TO_THE_ORDERER.

    • id integer
    • officeId integer
    • paymentAccountId integer
    • paymentAccountName object
      Hide paymentAccountName attributes Show paymentAccountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • paymentTerms string
    • placcountId integer
    • placcountName object
      Hide placcountName attributes Show placcountName attributes object

      • de string
      • en string
      • fr string
      • it string
    • vatNumber string
    • vatRateId integer
    • vatType string

      Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.

    • vatTypeCodeId integer
  • tags array[object]
    Hide tags attributes Show tags attributes object

    • id integer
    • name string
  • userGroups array[object]
    Hide userGroups attributes Show userGroups attributes object

    • description string
    • globalRoles array[object]
      Hide globalRoles attributes Show globalRoles attributes object

      • id integer
      • name string
      • roleType string

        Values are ORGANIZATION or GLOBAL.

    • groupIds array[integer]
    • id integer
    • isAdvanced boolean
    • name string
    • roles array[object]
      Hide roles attributes Show roles attributes object

      • id integer
      • name string
      • roleType string

        Values are ORGANIZATION or GLOBAL.

    • rule string
    • type string

      Values are GROUP or SUPER_GROUP.

    • userIds array[integer]
  • warnings string
  • webSite string
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error