Modify batch of contacts

POST /api-v1/contact/batch

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

application/json

Body object Required

contactId integer
contactType string Discriminator
isCustomer boolean
isVendor boolean
isStaff boolean
isUser boolean
defaultLanguage string

Values are EN, FR, DE, IT, or UNDEFINED.
phone string
fax string
mobile string
email string
webSite string
warnings string
archived boolean
relatedOrganizationContactIds array[integer]
relatedContactIds array[integer]
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
communications array[object]
Hide communications attributes Show communications attributes object
- id integer
- date string Required
- type string
  
  Values are PHONE_CALL, EMAIL, INTERNAL_MEETING, EXTERNAL_MEETING, or NOTE.
- description string
- longDescription string
- ourContactId integer
- externalContactId integer
- externalContactName string
- ourContactName string
- externalContactIdName string
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
tags array[object]
Hide tags attributes Show tags attributes object
- id integer
- name string
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
organizationId integer
organizationUsesTimesheets boolean
permissionsTree array[object]
Hide permissionsTree attributes Show permissionsTree attributes object
- id integer
- organizationId integer
- parentOrganizationId integer(int32)
- name string
- isActive boolean
- roles array[object]
  Hide roles attributes Show roles attributes object
  
  id integer
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
- globalRoles array[object]
  Hide globalRoles attributes Show globalRoles attributes object
  
  id integer
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
- availableRoles array[object]
  Hide availableRoles attributes Show availableRoles attributes object
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
  
  description string
  
  id integer
  
  realId integer
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- subUserContactId integer
- availableEmployees array[object]
  Hide availableEmployees attributes Show availableEmployees attributes object
  
  id integer
  
  name string
  
  email string
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.
supplier object
Hide supplier attributes Show supplier attributes object
- id integer
- businessUnitId integer
- paymentAccountId integer
- balanceSheetAccountId integer
- currencyId integer
- paymentTerms string
- feeSplitType string
  
  Values are CHARGED_TO_THE_BENEFICIARY, FIFTY_FIFTY_SPLIT, or CHARGED_TO_THE_ORDERER.
- contactId integer
- vatNumber string
- vatType string
  
  Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.
- vatTypeCodeId integer
- vatRateId integer
- businessUnitName string
- paymentAccountName object
  Hide paymentAccountName attributes Show paymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- PLAccountName object
  Hide PLAccountName attributes Show PLAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- balanceSheetAccountName object
  Hide balanceSheetAccountName attributes Show balanceSheetAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- officeId integer
- placcountName object
  Hide placcountName attributes Show placcountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- placcountId integer
client object
Hide client attributes Show client attributes object
- id integer
- businessUnitId integer
- paymentAccountId integer
- balanceSheetAccountId integer
- currencyId integer
- orderAddressId integer
- orderAddressName string
- invoiceAddressId integer
- invoiceAddressName string
- paymentTerms string
- lateNoticeMargin string
- clientDiscountRate string
- creditLimit string
- contactId integer
- vatNumber string
- advancedInvoicingNote string
- vatTypeCodeId integer
- vatRateId integer
- orderValidity string
- articleDiscounts array[object]
  Hide articleDiscounts attributes Show articleDiscounts attributes object
  
  id integer
  
  articleId integer Required
  
  discount number Required
  
  articleIdName object
  
  Hide articleIdName attributes Show articleIdName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- businessUnitName string
- paymentAccountName object
  Hide paymentAccountName attributes Show paymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- PLAccountName object
  Hide PLAccountName attributes Show PLAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- balanceSheetAccountName object
  Hide balanceSheetAccountName attributes Show balanceSheetAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- billingEmail string
- orderEmail string
- lateNoticeEmail string
- officeId integer
- placcountName object
  Hide placcountName attributes Show placcountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- placcountId integer
staff object
Hide staff attributes Show staff attributes object
- id integer
- avsNumber string
- permitExpiryDate string
- jobTitle string
- employmentStartDate string
- employmentEndDate string
- contactId integer
- workPermit object
  Hide workPermit attributes Show workPermit attributes object
  
  id integer
  
  countryId integer
  
  name object
  
  Hide name attributes Show name attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
  
  nameId integer
- contractType string
  
  Values are OPEN_ENDED, OPEN_ENDED_YEAR, FIXED, APPRENTICESHIP, or INTERN.
- employeeDocumentType string
  
  Values are PASSPORT or ID.
- documentNumber string
- documentExpiryDate string
- maritalType string
  
  Values are SINGLE, MARRIED, DIVORCED, SEPARATED, or WIDOWED.
- maritalDate string
- isSpouseWorking boolean
- enforceTimesheets boolean
- familyMembers array[object]
  Hide familyMembers attributes Show familyMembers attributes object
  
  id integer
  
  staffId integer
  
  familyMemberType string Required
  
  Values are SPOUSE or CHILD.
  
  firstName string
  
  lastName string
  
  birthDate string Required
  
  nationalityCountryId integer
- timesheetPricingLines array[object]
  Hide timesheetPricingLines attributes Show timesheetPricingLines attributes object
  
  id integer
  
  startDate string Required
  
  endDate string
  
  orderId integer
  
  task object
  
  Hide task attributes Show task attributes object
  
  id integer
  
  name string
  
  rate number
  
  organizationId integer
  
  archived boolean
  
  rate string
  
  clientId integer
  
  staffId integer
  
  clientName string
- staffPayslips array[object]
  Hide staffPayslips attributes Show staffPayslips attributes object
  
  id integer
  
  staffId integer
  
  calendarYear integer(int32)
  
  employmentStartDate string
  
  employmentEndDate string
  
  salaryCertificateNotes string
  
  isFreeTransportToWork boolean
  
  isCanteenMealsOrMealsVouchers boolean
  
  salaryInfo object
  
  Hide salaryInfo attributes Show salaryInfo attributes object
  
  id integer
  
  organizationId integer
  
  staffId integer
  
  staffPayslipEntityId integer
  
  salaryType string
  
  Values are MONTHLY or HOURLY.
  
  workOccupancy string
  
  numberOfVacationDays string
  
  defaultPaymentAccountId integer
  
  payrollCurrencyId integer
  
  isSourceTaxEnabled boolean
  
  capacity string
  
  hourlyRate string
  
  payableToBankId integer
  
  organizationEmployeeGroupId integer
  
  sourceTaxCode string
  
  regionId integer
  
  totalOccupancy string
  
  defaultPaymentAccountName object
  
  Hide defaultPaymentAccountName attributes Show defaultPaymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
  
  hasOnlyOneJob boolean
  
  singleParentType string
  
  Values are NOCOHAB, COHABSC, COHABJC, or COHABO18.
  
  denominationType string
  
  Values are RCC, CCC, ERC, IRC, or ONO.
  
  employeeGroups array[object]
  
  Hide employeeGroups attributes Show employeeGroups attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  groupType string
  
  Values are ADMIN or OPERATIONS.
  
  departmentId integer
  
  percentage string
  
  departmentName string
  
  officeId integer
  
  officeName string
  
  systemLine object
  
  Hide systemLine attributes Show systemLine attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  payslipLineEntityId integer
  
  bracket string
  
  rate string
  
  localizations object
  
  Hide localizations attributes Show localizations attributes object
  
  id integer
  
  en string
  
  fr string
  
  de string
  
  it string
  
  number integer
  
  baseSalaryLine object
  
  Hide baseSalaryLine attributes Show baseSalaryLine attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  payslipLineEntityId integer
  
  employeeAmount string
  
  employerAmount string
  
  payslipValueSplitType string
  
  Values are EMPLOYEE, EMPLOYER, or BOTH.
  
  payslipTableLines array[object]
  
  Hide payslipTableLines attributes Show payslipTableLines attributes object
  
  id integer
  
  startDate string
  
  endDate string
  
  payslipEntityId integer
  
  payslipLineId string
  
  organizationPayslipEntityId integer
  
  staffPayslipEntityId integer
  
  number integer
  
  description string
  
  employeeValue string
  
  employerValue string
  
  quantity string
  
  employeePercentage string
  
  employerPercentage string
  
  organizationEmployeeGroupId integer
- costCalculationType string
  
  Values are AUTOMATIC or MANUAL.
- timesheetsCost string
- pdfPassword 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.
- position string
  
  Values are SENIOR, MIDDLE, LOWER, or RESP.
externalId string
groupRoles array[object]
Hide groupRoles attributes Show groupRoles attributes object
- id integer
- name string
- roleType string
  
  Values are ORGANIZATION or GLOBAL.
userGroups array[object]
Hide userGroups attributes Show userGroups attributes object
- id integer
- type string Required
  
  Values are GROUP or SUPER_GROUP.
- name string Required
- description string
- userIds array[integer]
- groupIds array[integer]
- roles array[object]
  Hide roles attributes Show roles attributes object
  
  id integer
  
  name string
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- globalRoles array[object]
  Hide globalRoles attributes Show globalRoles attributes object
  
  id integer
  
  name string
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- isAdvanced boolean
- rule string
id integer
ecorrespondence boolean

contactId integer
contactType string Discriminator
isCustomer boolean
isVendor boolean
isStaff boolean
isUser boolean
defaultLanguage string

Values are EN, FR, DE, IT, or UNDEFINED.
phone string
fax string
mobile string
email string
webSite string
warnings string
archived boolean
relatedOrganizationContactIds array[integer]
relatedContactIds array[integer]
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
communications array[object]
Hide communications attributes Show communications attributes object
- id integer
- date string Required
- type string
  
  Values are PHONE_CALL, EMAIL, INTERNAL_MEETING, EXTERNAL_MEETING, or NOTE.
- description string
- longDescription string
- ourContactId integer
- externalContactId integer
- externalContactName string
- ourContactName string
- externalContactIdName string
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
tags array[object]
Hide tags attributes Show tags attributes object
- id integer
- name string
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
organizationId integer
organizationUsesTimesheets boolean
permissionsTree array[object]
Hide permissionsTree attributes Show permissionsTree attributes object
- id integer
- organizationId integer
- parentOrganizationId integer(int32)
- name string
- isActive boolean
- roles array[object]
  Hide roles attributes Show roles attributes object
  
  id integer
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
- globalRoles array[object]
  Hide globalRoles attributes Show globalRoles attributes object
  
  id integer
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
- availableRoles array[object]
  Hide availableRoles attributes Show availableRoles attributes object
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
  
  description string
  
  id integer
  
  realId integer
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- subUserContactId integer
- availableEmployees array[object]
  Hide availableEmployees attributes Show availableEmployees attributes object
  
  id integer
  
  name string
  
  email string
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.
supplier object
Hide supplier attributes Show supplier attributes object
- id integer
- businessUnitId integer
- paymentAccountId integer
- balanceSheetAccountId integer
- currencyId integer
- paymentTerms string
- feeSplitType string
  
  Values are CHARGED_TO_THE_BENEFICIARY, FIFTY_FIFTY_SPLIT, or CHARGED_TO_THE_ORDERER.
- contactId integer
- vatNumber string
- vatType string
  
  Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.
- vatTypeCodeId integer
- vatRateId integer
- businessUnitName string
- paymentAccountName object
  Hide paymentAccountName attributes Show paymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- PLAccountName object
  Hide PLAccountName attributes Show PLAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- balanceSheetAccountName object
  Hide balanceSheetAccountName attributes Show balanceSheetAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- officeId integer
- placcountName object
  Hide placcountName attributes Show placcountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- placcountId integer
client object
Hide client attributes Show client attributes object
- id integer
- businessUnitId integer
- paymentAccountId integer
- balanceSheetAccountId integer
- currencyId integer
- orderAddressId integer
- orderAddressName string
- invoiceAddressId integer
- invoiceAddressName string
- paymentTerms string
- lateNoticeMargin string
- clientDiscountRate string
- creditLimit string
- contactId integer
- vatNumber string
- advancedInvoicingNote string
- vatTypeCodeId integer
- vatRateId integer
- orderValidity string
- articleDiscounts array[object]
  Hide articleDiscounts attributes Show articleDiscounts attributes object
  
  id integer
  
  articleId integer Required
  
  discount number Required
  
  articleIdName object
  
  Hide articleIdName attributes Show articleIdName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- businessUnitName string
- paymentAccountName object
  Hide paymentAccountName attributes Show paymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- PLAccountName object
  Hide PLAccountName attributes Show PLAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- balanceSheetAccountName object
  Hide balanceSheetAccountName attributes Show balanceSheetAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- billingEmail string
- orderEmail string
- lateNoticeEmail string
- officeId integer
- placcountName object
  Hide placcountName attributes Show placcountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- placcountId integer
staff object
Hide staff attributes Show staff attributes object
- id integer
- avsNumber string
- permitExpiryDate string
- jobTitle string
- employmentStartDate string
- employmentEndDate string
- contactId integer
- workPermit object
  Hide workPermit attributes Show workPermit attributes object
  
  id integer
  
  countryId integer
  
  name object
  
  Hide name attributes Show name attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
  
  nameId integer
- contractType string
  
  Values are OPEN_ENDED, OPEN_ENDED_YEAR, FIXED, APPRENTICESHIP, or INTERN.
- employeeDocumentType string
  
  Values are PASSPORT or ID.
- documentNumber string
- documentExpiryDate string
- maritalType string
  
  Values are SINGLE, MARRIED, DIVORCED, SEPARATED, or WIDOWED.
- maritalDate string
- isSpouseWorking boolean
- enforceTimesheets boolean
- familyMembers array[object]
  Hide familyMembers attributes Show familyMembers attributes object
  
  id integer
  
  staffId integer
  
  familyMemberType string Required
  
  Values are SPOUSE or CHILD.
  
  firstName string
  
  lastName string
  
  birthDate string Required
  
  nationalityCountryId integer
- timesheetPricingLines array[object]
  Hide timesheetPricingLines attributes Show timesheetPricingLines attributes object
  
  id integer
  
  startDate string Required
  
  endDate string
  
  orderId integer
  
  task object
  
  Hide task attributes Show task attributes object
  
  id integer
  
  name string
  
  rate number
  
  organizationId integer
  
  archived boolean
  
  rate string
  
  clientId integer
  
  staffId integer
  
  clientName string
- staffPayslips array[object]
  Hide staffPayslips attributes Show staffPayslips attributes object
  
  id integer
  
  staffId integer
  
  calendarYear integer(int32)
  
  employmentStartDate string
  
  employmentEndDate string
  
  salaryCertificateNotes string
  
  isFreeTransportToWork boolean
  
  isCanteenMealsOrMealsVouchers boolean
  
  salaryInfo object
  
  Hide salaryInfo attributes Show salaryInfo attributes object
  
  id integer
  
  organizationId integer
  
  staffId integer
  
  staffPayslipEntityId integer
  
  salaryType string
  
  Values are MONTHLY or HOURLY.
  
  workOccupancy string
  
  numberOfVacationDays string
  
  defaultPaymentAccountId integer
  
  payrollCurrencyId integer
  
  isSourceTaxEnabled boolean
  
  capacity string
  
  hourlyRate string
  
  payableToBankId integer
  
  organizationEmployeeGroupId integer
  
  sourceTaxCode string
  
  regionId integer
  
  totalOccupancy string
  
  defaultPaymentAccountName object
  
  Hide defaultPaymentAccountName attributes Show defaultPaymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
  
  hasOnlyOneJob boolean
  
  singleParentType string
  
  Values are NOCOHAB, COHABSC, COHABJC, or COHABO18.
  
  denominationType string
  
  Values are RCC, CCC, ERC, IRC, or ONO.
  
  employeeGroups array[object]
  
  Hide employeeGroups attributes Show employeeGroups attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  groupType string
  
  Values are ADMIN or OPERATIONS.
  
  departmentId integer
  
  percentage string
  
  departmentName string
  
  officeId integer
  
  officeName string
  
  systemLine object
  
  Hide systemLine attributes Show systemLine attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  payslipLineEntityId integer
  
  bracket string
  
  rate string
  
  localizations object
  
  Hide localizations attributes Show localizations attributes object
  
  id integer
  
  en string
  
  fr string
  
  de string
  
  it string
  
  number integer
  
  baseSalaryLine object
  
  Hide baseSalaryLine attributes Show baseSalaryLine attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  payslipLineEntityId integer
  
  employeeAmount string
  
  employerAmount string
  
  payslipValueSplitType string
  
  Values are EMPLOYEE, EMPLOYER, or BOTH.
  
  payslipTableLines array[object]
  
  Hide payslipTableLines attributes Show payslipTableLines attributes object
  
  id integer
  
  startDate string
  
  endDate string
  
  payslipEntityId integer
  
  payslipLineId string
  
  organizationPayslipEntityId integer
  
  staffPayslipEntityId integer
  
  number integer
  
  description string
  
  employeeValue string
  
  employerValue string
  
  quantity string
  
  employeePercentage string
  
  employerPercentage string
  
  organizationEmployeeGroupId integer
- costCalculationType string
  
  Values are AUTOMATIC or MANUAL.
- timesheetsCost string
- pdfPassword 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.
- position string
  
  Values are SENIOR, MIDDLE, LOWER, or RESP.
externalId string
groupRoles array[object]
Hide groupRoles attributes Show groupRoles attributes object
- id integer
- name string
- roleType string
  
  Values are ORGANIZATION or GLOBAL.
userGroups array[object]
Hide userGroups attributes Show userGroups attributes object
- id integer
- type string Required
  
  Values are GROUP or SUPER_GROUP.
- name string Required
- description string
- userIds array[integer]
- groupIds array[integer]
- roles array[object]
  Hide roles attributes Show roles attributes object
  
  id integer
  
  name string
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- globalRoles array[object]
  Hide globalRoles attributes Show globalRoles attributes object
  
  id integer
  
  name string
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- isAdvanced boolean
- rule string
id integer
ecorrespondence boolean
name string Required
nogaCodeId integer
uid string

contactId integer
contactType string Discriminator
isCustomer boolean
isVendor boolean
isStaff boolean
isUser boolean
defaultLanguage string

Values are EN, FR, DE, IT, or UNDEFINED.
phone string
fax string
mobile string
email string
webSite string
warnings string
archived boolean
relatedOrganizationContactIds array[integer]
relatedContactIds array[integer]
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
communications array[object]
Hide communications attributes Show communications attributes object
- id integer
- date string Required
- type string
  
  Values are PHONE_CALL, EMAIL, INTERNAL_MEETING, EXTERNAL_MEETING, or NOTE.
- description string
- longDescription string
- ourContactId integer
- externalContactId integer
- externalContactName string
- ourContactName string
- externalContactIdName string
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
tags array[object]
Hide tags attributes Show tags attributes object
- id integer
- name string
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
organizationId integer
organizationUsesTimesheets boolean
permissionsTree array[object]
Hide permissionsTree attributes Show permissionsTree attributes object
- id integer
- organizationId integer
- parentOrganizationId integer(int32)
- name string
- isActive boolean
- roles array[object]
  Hide roles attributes Show roles attributes object
  
  id integer
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
- globalRoles array[object]
  Hide globalRoles attributes Show globalRoles attributes object
  
  id integer
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
- availableRoles array[object]
  Hide availableRoles attributes Show availableRoles attributes object
  
  type string
  
  Values are ROLE or SUPER_ROLE.
  
  name string
  
  isDefault boolean
  
  description string
  
  id integer
  
  realId integer
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- subUserContactId integer
- availableEmployees array[object]
  Hide availableEmployees attributes Show availableEmployees attributes object
  
  id integer
  
  name string
  
  email string
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.
supplier object
Hide supplier attributes Show supplier attributes object
- id integer
- businessUnitId integer
- paymentAccountId integer
- balanceSheetAccountId integer
- currencyId integer
- paymentTerms string
- feeSplitType string
  
  Values are CHARGED_TO_THE_BENEFICIARY, FIFTY_FIFTY_SPLIT, or CHARGED_TO_THE_ORDERER.
- contactId integer
- vatNumber string
- vatType string
  
  Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.
- vatTypeCodeId integer
- vatRateId integer
- businessUnitName string
- paymentAccountName object
  Hide paymentAccountName attributes Show paymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- PLAccountName object
  Hide PLAccountName attributes Show PLAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- balanceSheetAccountName object
  Hide balanceSheetAccountName attributes Show balanceSheetAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- officeId integer
- placcountName object
  Hide placcountName attributes Show placcountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- placcountId integer
client object
Hide client attributes Show client attributes object
- id integer
- businessUnitId integer
- paymentAccountId integer
- balanceSheetAccountId integer
- currencyId integer
- orderAddressId integer
- orderAddressName string
- invoiceAddressId integer
- invoiceAddressName string
- paymentTerms string
- lateNoticeMargin string
- clientDiscountRate string
- creditLimit string
- contactId integer
- vatNumber string
- advancedInvoicingNote string
- vatTypeCodeId integer
- vatRateId integer
- orderValidity string
- articleDiscounts array[object]
  Hide articleDiscounts attributes Show articleDiscounts attributes object
  
  id integer
  
  articleId integer Required
  
  discount number Required
  
  articleIdName object
  
  Hide articleIdName attributes Show articleIdName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- businessUnitName string
- paymentAccountName object
  Hide paymentAccountName attributes Show paymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- PLAccountName object
  Hide PLAccountName attributes Show PLAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- balanceSheetAccountName object
  Hide balanceSheetAccountName attributes Show balanceSheetAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- billingEmail string
- orderEmail string
- lateNoticeEmail string
- officeId integer
- placcountName object
  Hide placcountName attributes Show placcountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
- placcountId integer
staff object
Hide staff attributes Show staff attributes object
- id integer
- avsNumber string
- permitExpiryDate string
- jobTitle string
- employmentStartDate string
- employmentEndDate string
- contactId integer
- workPermit object
  Hide workPermit attributes Show workPermit attributes object
  
  id integer
  
  countryId integer
  
  name object
  
  Hide name attributes Show name attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
  
  nameId integer
- contractType string
  
  Values are OPEN_ENDED, OPEN_ENDED_YEAR, FIXED, APPRENTICESHIP, or INTERN.
- employeeDocumentType string
  
  Values are PASSPORT or ID.
- documentNumber string
- documentExpiryDate string
- maritalType string
  
  Values are SINGLE, MARRIED, DIVORCED, SEPARATED, or WIDOWED.
- maritalDate string
- isSpouseWorking boolean
- enforceTimesheets boolean
- familyMembers array[object]
  Hide familyMembers attributes Show familyMembers attributes object
  
  id integer
  
  staffId integer
  
  familyMemberType string Required
  
  Values are SPOUSE or CHILD.
  
  firstName string
  
  lastName string
  
  birthDate string Required
  
  nationalityCountryId integer
- timesheetPricingLines array[object]
  Hide timesheetPricingLines attributes Show timesheetPricingLines attributes object
  
  id integer
  
  startDate string Required
  
  endDate string
  
  orderId integer
  
  task object
  
  Hide task attributes Show task attributes object
  
  id integer
  
  name string
  
  rate number
  
  organizationId integer
  
  archived boolean
  
  rate string
  
  clientId integer
  
  staffId integer
  
  clientName string
- staffPayslips array[object]
  Hide staffPayslips attributes Show staffPayslips attributes object
  
  id integer
  
  staffId integer
  
  calendarYear integer(int32)
  
  employmentStartDate string
  
  employmentEndDate string
  
  salaryCertificateNotes string
  
  isFreeTransportToWork boolean
  
  isCanteenMealsOrMealsVouchers boolean
  
  salaryInfo object
  
  Hide salaryInfo attributes Show salaryInfo attributes object
  
  id integer
  
  organizationId integer
  
  staffId integer
  
  staffPayslipEntityId integer
  
  salaryType string
  
  Values are MONTHLY or HOURLY.
  
  workOccupancy string
  
  numberOfVacationDays string
  
  defaultPaymentAccountId integer
  
  payrollCurrencyId integer
  
  isSourceTaxEnabled boolean
  
  capacity string
  
  hourlyRate string
  
  payableToBankId integer
  
  organizationEmployeeGroupId integer
  
  sourceTaxCode string
  
  regionId integer
  
  totalOccupancy string
  
  defaultPaymentAccountName object
  
  Hide defaultPaymentAccountName attributes Show defaultPaymentAccountName attributes object
  
  en string
  
  fr string
  
  de string
  
  it string
  
  hasOnlyOneJob boolean
  
  singleParentType string
  
  Values are NOCOHAB, COHABSC, COHABJC, or COHABO18.
  
  denominationType string
  
  Values are RCC, CCC, ERC, IRC, or ONO.
  
  employeeGroups array[object]
  
  Hide employeeGroups attributes Show employeeGroups attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  groupType string
  
  Values are ADMIN or OPERATIONS.
  
  departmentId integer
  
  percentage string
  
  departmentName string
  
  officeId integer
  
  officeName string
  
  systemLine object
  
  Hide systemLine attributes Show systemLine attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  payslipLineEntityId integer
  
  bracket string
  
  rate string
  
  localizations object
  
  Hide localizations attributes Show localizations attributes object
  
  id integer
  
  en string
  
  fr string
  
  de string
  
  it string
  
  number integer
  
  baseSalaryLine object
  
  Hide baseSalaryLine attributes Show baseSalaryLine attributes object
  
  id integer
  
  staffPayslipEntityId integer
  
  payslipLineEntityId integer
  
  employeeAmount string
  
  employerAmount string
  
  payslipValueSplitType string
  
  Values are EMPLOYEE, EMPLOYER, or BOTH.
  
  payslipTableLines array[object]
  
  Hide payslipTableLines attributes Show payslipTableLines attributes object
  
  id integer
  
  startDate string
  
  endDate string
  
  payslipEntityId integer
  
  payslipLineId string
  
  organizationPayslipEntityId integer
  
  staffPayslipEntityId integer
  
  number integer
  
  description string
  
  employeeValue string
  
  employerValue string
  
  quantity string
  
  employeePercentage string
  
  employerPercentage string
  
  organizationEmployeeGroupId integer
- costCalculationType string
  
  Values are AUTOMATIC or MANUAL.
- timesheetsCost string
- pdfPassword 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.
- position string
  
  Values are SENIOR, MIDDLE, LOWER, or RESP.
externalId string
groupRoles array[object]
Hide groupRoles attributes Show groupRoles attributes object
- id integer
- name string
- roleType string
  
  Values are ORGANIZATION or GLOBAL.
userGroups array[object]
Hide userGroups attributes Show userGroups attributes object
- id integer
- type string Required
  
  Values are GROUP or SUPER_GROUP.
- name string Required
- description string
- userIds array[integer]
- groupIds array[integer]
- roles array[object]
  Hide roles attributes Show roles attributes object
  
  id integer
  
  name string
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- globalRoles array[object]
  Hide globalRoles attributes Show globalRoles attributes object
  
  id integer
  
  name string
  
  roleType string
  
  Values are ORGANIZATION or GLOBAL.
- isAdvanced boolean
- rule string
id integer
ecorrespondence boolean
firstName string Required
middleName string
lastName string Required
nationalityCountryId integer
birthday string
gender string

Values are MALE, FEMALE, or OTHER.
isImpersonateOthers boolean
isAdmin boolean
isMainUser boolean
isEmployee boolean
avatarId integer
isActive boolean
isBlockedForLicenceNonPayment boolean
loginEmail string

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  errorCode object
  
  Hide errorCode attributes Show errorCode attributes object
  
  errorCode string
  
  Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.
  
  errorDetailValues array[object]
  
  Hide errorDetailValues attributes Show errorDetailValues attributes object
  
  errorCode string
  
  fieldName string
  
  data string
  
  isSevere boolean
  
  freshRow object
  
  freshData object
  
  possibleWorkflows array[object]
  
  Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  
  id integer
  
  name string
  
  error boolean
  
  severeError boolean
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

POST /api-v1/contact/batch

curl \
 --request POST 'https://wyzio.app/api-v1/contact/batch' \
 --header "Content-Type: application/json" \
 --header "WEAL-TOKEN: string" \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --data '[{"contactId":42,"contactType":"string","isCustomer":true,"isVendor":true,"isStaff":true,"isUser":true,"defaultLanguage":"EN","phone":"string","fax":"string","mobile":"string","email":"string","webSite":"string","warnings":"string","archived":true,"relatedOrganizationContactIds":[42],"relatedContactIds":[42],"addresses":[{"id":42,"name":"string","line1":"string","line2":"string","city":"string","region":{"id":42,"name":"string","code":"string","taxMode":"ANNUALLY"},"countryCode2":"string","postCode":"string","toTheAttentionOf":"string","position":42,"houseNumber":"string","countryId":42,"service":"string","readOnly":true}],"communications":[{"id":42,"date":"string","type":"PHONE_CALL","description":"string","longDescription":"string","ourContactId":42,"externalContactId":42,"externalContactName":"string","ourContactName":"string","externalContactIdName":"string"}],"additionalInformation":[{"id":42,"note":"string","tag":{"id":42,"name":"string"}}],"tags":[{"id":42,"name":"string"}],"banks":[{"id":42,"name":"string","accountNumber":"string","qrIban":"string","isrCustomerNumber":"string","bankCustomerNumber":"string","swiftBic":"string","bankName":"string","remark":"string","position":42,"useForReconciliation":true,"chartOfAccounts":42,"accountHolderAddress":{"id":42,"name":"string","line1":"string","line2":"string","city":"string","region":{"id":42,"name":"string","code":"string","taxMode":"ANNUALLY"},"countryCode2":"string","postCode":"string","toTheAttentionOf":"string","position":42,"houseNumber":"string","countryId":42,"service":"string","readOnly":true},"customHolder":true}],"organizationId":42,"organizationUsesTimesheets":true,"permissionsTree":[{"id":42,"organizationId":42,"parentOrganizationId":42,"name":"string","isActive":true,"roles":[{"id":42,"type":"ROLE","name":"string","isDefault":true}],"globalRoles":[{"id":42,"type":"ROLE","name":"string","isDefault":true}],"availableRoles":[{"type":"ROLE","name":"string","isDefault":true,"description":"string","id":42,"realId":42,"roleType":"ORGANIZATION"}],"subUserContactId":42,"availableEmployees":[{"id":42,"name":"string","email":"string"}]}],"defaultModule":"ALL","supplier":{"id":42,"businessUnitId":42,"paymentAccountId":42,"balanceSheetAccountId":42,"currencyId":42,"paymentTerms":"string","feeSplitType":"CHARGED_TO_THE_BENEFICIARY","contactId":42,"vatNumber":"string","vatType":"NO_VAT","vatTypeCodeId":42,"vatRateId":42,"businessUnitName":"string","paymentAccountName":{"en":"string","fr":"string","de":"string","it":"string"},"PLAccountName":{"en":"string","fr":"string","de":"string","it":"string"},"balanceSheetAccountName":{"en":"string","fr":"string","de":"string","it":"string"},"officeId":42,"placcountName":{"en":"string","fr":"string","de":"string","it":"string"},"placcountId":42},"client":{"id":42,"businessUnitId":42,"paymentAccountId":42,"balanceSheetAccountId":42,"currencyId":42,"orderAddressId":42,"orderAddressName":"string","invoiceAddressId":42,"invoiceAddressName":"string","paymentTerms":"string","lateNoticeMargin":"string","clientDiscountRate":"string","creditLimit":"string","contactId":42,"vatNumber":"string","advancedInvoicingNote":"string","vatTypeCodeId":42,"vatRateId":42,"orderValidity":"string","articleDiscounts":[{"id":42,"articleId":42,"discount":42.0,"articleIdName":{"en":"string","fr":"string","de":"string","it":"string"}}],"businessUnitName":"string","paymentAccountName":{"en":"string","fr":"string","de":"string","it":"string"},"PLAccountName":{"en":"string","fr":"string","de":"string","it":"string"},"balanceSheetAccountName":{"en":"string","fr":"string","de":"string","it":"string"},"billingEmail":"string","orderEmail":"string","lateNoticeEmail":"string","officeId":42,"placcountName":{"en":"string","fr":"string","de":"string","it":"string"},"placcountId":42},"staff":{"id":42,"avsNumber":"string","permitExpiryDate":"string","jobTitle":"string","employmentStartDate":"string","employmentEndDate":"string","contactId":42,"workPermit":{"id":42,"countryId":42,"name":{"en":"string","fr":"string","de":"string","it":"string"},"nameId":42},"contractType":"OPEN_ENDED","employeeDocumentType":"PASSPORT","documentNumber":"string","documentExpiryDate":"string","maritalType":"SINGLE","maritalDate":"string","isSpouseWorking":true,"enforceTimesheets":true,"familyMembers":[{"id":42,"staffId":42,"familyMemberType":"SPOUSE","firstName":"string","lastName":"string","birthDate":"string","nationalityCountryId":42}],"timesheetPricingLines":[{"id":42,"startDate":"string","endDate":"string","orderId":42,"task":{"id":42,"name":"string","rate":42.0,"organizationId":42,"archived":true},"rate":"string","clientId":42,"staffId":42,"clientName":"string"}],"staffPayslips":[{"id":42,"staffId":42,"calendarYear":42,"employmentStartDate":"string","employmentEndDate":"string","salaryCertificateNotes":"string","isFreeTransportToWork":true,"isCanteenMealsOrMealsVouchers":true,"salaryInfo":{"id":42,"organizationId":42,"staffId":42,"staffPayslipEntityId":42,"salaryType":"MONTHLY","workOccupancy":"string","numberOfVacationDays":"string","defaultPaymentAccountId":42,"payrollCurrencyId":42,"isSourceTaxEnabled":true,"capacity":"string","hourlyRate":"string","payableToBankId":42,"organizationEmployeeGroupId":42,"sourceTaxCode":"string","regionId":42,"totalOccupancy":"string","defaultPaymentAccountName":{"en":"string","fr":"string","de":"string","it":"string"},"hasOnlyOneJob":true,"singleParentType":"NOCOHAB","denominationType":"RCC"},"employeeGroups":[{"id":42,"staffPayslipEntityId":42,"groupType":"ADMIN","departmentId":42,"percentage":"string","departmentName":"string","officeId":42,"officeName":"string"}],"systemLine":{"id":42,"staffPayslipEntityId":42,"payslipLineEntityId":42,"bracket":"string","rate":"string","localizations":{"id":42,"en":"string","fr":"string","de":"string","it":"string"},"number":42},"baseSalaryLine":{"id":42,"staffPayslipEntityId":42,"payslipLineEntityId":42,"employeeAmount":"string","employerAmount":"string","payslipValueSplitType":"EMPLOYEE"},"payslipTableLines":[{"id":42,"startDate":"string","endDate":"string","payslipEntityId":42,"payslipLineId":"string","organizationPayslipEntityId":42,"staffPayslipEntityId":42,"number":42,"description":"string","employeeValue":"string","employerValue":"string","quantity":"string","employeePercentage":"string","employerPercentage":"string","organizationEmployeeGroupId":42}]}],"costCalculationType":"AUTOMATIC","timesheetsCost":"string","pdfPassword":"string","trainingLevel":"PHD","position":"SENIOR"},"externalId":"string","groupRoles":[{"id":42,"name":"string","roleType":"ORGANIZATION"}],"userGroups":[{"id":42,"type":"GROUP","name":"string","description":"string","userIds":[42],"groupIds":[42],"roles":[{"id":42,"name":"string","roleType":"ORGANIZATION"}],"globalRoles":[{"id":42,"name":"string","roleType":"ORGANIZATION"}],"isAdvanced":true,"rule":"string"}],"id":42,"ecorrespondence":true}]'

Request examples

# Headers
WEAL-TOKEN: string
TARGET-ORGANIZATION-ID: 42

# Payload
[
  {
    "contactId": 42,
    "contactType": "string",
    "isCustomer": true,
    "isVendor": true,
    "isStaff": true,
    "isUser": true,
    "defaultLanguage": "EN",
    "phone": "string",
    "fax": "string",
    "mobile": "string",
    "email": "string",
    "webSite": "string",
    "warnings": "string",
    "archived": true,
    "relatedOrganizationContactIds": [
      42
    ],
    "relatedContactIds": [
      42
    ],
    "addresses": [
      {
        "id": 42,
        "name": "string",
        "line1": "string",
        "line2": "string",
        "city": "string",
        "region": {
          "id": 42,
          "name": "string",
          "code": "string",
          "taxMode": "ANNUALLY"
        },
        "countryCode2": "string",
        "postCode": "string",
        "toTheAttentionOf": "string",
        "position": 42,
        "houseNumber": "string",
        "countryId": 42,
        "service": "string",
        "readOnly": true
      }
    ],
    "communications": [
      {
        "id": 42,
        "date": "string",
        "type": "PHONE_CALL",
        "description": "string",
        "longDescription": "string",
        "ourContactId": 42,
        "externalContactId": 42,
        "externalContactName": "string",
        "ourContactName": "string",
        "externalContactIdName": "string"
      }
    ],
    "additionalInformation": [
      {
        "id": 42,
        "note": "string",
        "tag": {
          "id": 42,
          "name": "string"
        }
      }
    ],
    "tags": [
      {
        "id": 42,
        "name": "string"
      }
    ],
    "banks": [
      {
        "id": 42,
        "name": "string",
        "accountNumber": "string",
        "qrIban": "string",
        "isrCustomerNumber": "string",
        "bankCustomerNumber": "string",
        "swiftBic": "string",
        "bankName": "string",
        "remark": "string",
        "position": 42,
        "useForReconciliation": true,
        "chartOfAccounts": 42,
        "accountHolderAddress": {
          "id": 42,
          "name": "string",
          "line1": "string",
          "line2": "string",
          "city": "string",
          "region": {
            "id": 42,
            "name": "string",
            "code": "string",
            "taxMode": "ANNUALLY"
          },
          "countryCode2": "string",
          "postCode": "string",
          "toTheAttentionOf": "string",
          "position": 42,
          "houseNumber": "string",
          "countryId": 42,
          "service": "string",
          "readOnly": true
        },
        "customHolder": true
      }
    ],
    "organizationId": 42,
    "organizationUsesTimesheets": true,
    "permissionsTree": [
      {
        "id": 42,
        "organizationId": 42,
        "parentOrganizationId": 42,
        "name": "string",
        "isActive": true,
        "roles": [
          {
            "id": 42,
            "type": "ROLE",
            "name": "string",
            "isDefault": true
          }
        ],
        "globalRoles": [
          {
            "id": 42,
            "type": "ROLE",
            "name": "string",
            "isDefault": true
          }
        ],
        "availableRoles": [
          {
            "type": "ROLE",
            "name": "string",
            "isDefault": true,
            "description": "string",
            "id": 42,
            "realId": 42,
            "roleType": "ORGANIZATION"
          }
        ],
        "subUserContactId": 42,
        "availableEmployees": [
          {
            "id": 42,
            "name": "string",
            "email": "string"
          }
        ]
      }
    ],
    "defaultModule": "ALL",
    "supplier": {
      "id": 42,
      "businessUnitId": 42,
      "paymentAccountId": 42,
      "balanceSheetAccountId": 42,
      "currencyId": 42,
      "paymentTerms": "string",
      "feeSplitType": "CHARGED_TO_THE_BENEFICIARY",
      "contactId": 42,
      "vatNumber": "string",
      "vatType": "NO_VAT",
      "vatTypeCodeId": 42,
      "vatRateId": 42,
      "businessUnitName": "string",
      "paymentAccountName": {
        "en": "string",
        "fr": "string",
        "de": "string",
        "it": "string"
      },
      "PLAccountName": {
        "en": "string",
        "fr": "string",
        "de": "string",
        "it": "string"
      },
      "balanceSheetAccountName": {
        "en": "string",
        "fr": "string",
        "de": "string",
        "it": "string"
      },
      "officeId": 42,
      "placcountName": {
        "en": "string",
        "fr": "string",
        "de": "string",
        "it": "string"
      },
      "placcountId": 42
    },
    "client": {
      "id": 42,
      "businessUnitId": 42,
      "paymentAccountId": 42,
      "balanceSheetAccountId": 42,
      "currencyId": 42,
      "orderAddressId": 42,
      "orderAddressName": "string",
      "invoiceAddressId": 42,
      "invoiceAddressName": "string",
      "paymentTerms": "string",
      "lateNoticeMargin": "string",
      "clientDiscountRate": "string",
      "creditLimit": "string",
      "contactId": 42,
      "vatNumber": "string",
      "advancedInvoicingNote": "string",
      "vatTypeCodeId": 42,
      "vatRateId": 42,
      "orderValidity": "string",
      "articleDiscounts": [
        {
          "id": 42,
          "articleId": 42,
          "discount": 42.0,
          "articleIdName": {
            "en": "string",
            "fr": "string",
            "de": "string",
            "it": "string"
          }
        }
      ],
      "businessUnitName": "string",
      "paymentAccountName": {
        "en": "string",
        "fr": "string",
        "de": "string",
        "it": "string"
      },
      "PLAccountName": {
        "en": "string",
        "fr": "string",
        "de": "string",
        "it": "string"
      },
      "balanceSheetAccountName": {
        "en": "string",
        "fr": "string",
        "de": "string",
        "it": "string"
      },
      "billingEmail": "string",
      "orderEmail": "string",
      "lateNoticeEmail": "string",
      "officeId": 42,
      "placcountName": {
        "en": "string",
        "fr": "string",
        "de": "string",
        "it": "string"
      },
      "placcountId": 42
    },
    "staff": {
      "id": 42,
      "avsNumber": "string",
      "permitExpiryDate": "string",
      "jobTitle": "string",
      "employmentStartDate": "string",
      "employmentEndDate": "string",
      "contactId": 42,
      "workPermit": {
        "id": 42,
        "countryId": 42,
        "name": {
          "en": "string",
          "fr": "string",
          "de": "string",
          "it": "string"
        },
        "nameId": 42
      },
      "contractType": "OPEN_ENDED",
      "employeeDocumentType": "PASSPORT",
      "documentNumber": "string",
      "documentExpiryDate": "string",
      "maritalType": "SINGLE",
      "maritalDate": "string",
      "isSpouseWorking": true,
      "enforceTimesheets": true,
      "familyMembers": [
        {
          "id": 42,
          "staffId": 42,
          "familyMemberType": "SPOUSE",
          "firstName": "string",
          "lastName": "string",
          "birthDate": "string",
          "nationalityCountryId": 42
        }
      ],
      "timesheetPricingLines": [
        {
          "id": 42,
          "startDate": "string",
          "endDate": "string",
          "orderId": 42,
          "task": {
            "id": 42,
            "name": "string",
            "rate": 42.0,
            "organizationId": 42,
            "archived": true
          },
          "rate": "string",
          "clientId": 42,
          "staffId": 42,
          "clientName": "string"
        }
      ],
      "staffPayslips": [
        {
          "id": 42,
          "staffId": 42,
          "calendarYear": 42,
          "employmentStartDate": "string",
          "employmentEndDate": "string",
          "salaryCertificateNotes": "string",
          "isFreeTransportToWork": true,
          "isCanteenMealsOrMealsVouchers": true,
          "salaryInfo": {
            "id": 42,
            "organizationId": 42,
            "staffId": 42,
            "staffPayslipEntityId": 42,
            "salaryType": "MONTHLY",
            "workOccupancy": "string",
            "numberOfVacationDays": "string",
            "defaultPaymentAccountId": 42,
            "payrollCurrencyId": 42,
            "isSourceTaxEnabled": true,
            "capacity": "string",
            "hourlyRate": "string",
            "payableToBankId": 42,
            "organizationEmployeeGroupId": 42,
            "sourceTaxCode": "string",
            "regionId": 42,
            "totalOccupancy": "string",
            "defaultPaymentAccountName": {
              "en": "string",
              "fr": "string",
              "de": "string",
              "it": "string"
            },
            "hasOnlyOneJob": true,
            "singleParentType": "NOCOHAB",
            "denominationType": "RCC"
          },
          "employeeGroups": [
            {
              "id": 42,
              "staffPayslipEntityId": 42,
              "groupType": "ADMIN",
              "departmentId": 42,
              "percentage": "string",
              "departmentName": "string",
              "officeId": 42,
              "officeName": "string"
            }
          ],
          "systemLine": {
            "id": 42,
            "staffPayslipEntityId": 42,
            "payslipLineEntityId": 42,
            "bracket": "string",
            "rate": "string",
            "localizations": {
              "id": 42,
              "en": "string",
              "fr": "string",
              "de": "string",
              "it": "string"
            },
            "number": 42
          },
          "baseSalaryLine": {
            "id": 42,
            "staffPayslipEntityId": 42,
            "payslipLineEntityId": 42,
            "employeeAmount": "string",
            "employerAmount": "string",
            "payslipValueSplitType": "EMPLOYEE"
          },
          "payslipTableLines": [
            {
              "id": 42,
              "startDate": "string",
              "endDate": "string",
              "payslipEntityId": 42,
              "payslipLineId": "string",
              "organizationPayslipEntityId": 42,
              "staffPayslipEntityId": 42,
              "number": 42,
              "description": "string",
              "employeeValue": "string",
              "employerValue": "string",
              "quantity": "string",
              "employeePercentage": "string",
              "employerPercentage": "string",
              "organizationEmployeeGroupId": 42
            }
          ]
        }
      ],
      "costCalculationType": "AUTOMATIC",
      "timesheetsCost": "string",
      "pdfPassword": "string",
      "trainingLevel": "PHD",
      "position": "SENIOR"
    },
    "externalId": "string",
    "groupRoles": [
      {
        "id": 42,
        "name": "string",
        "roleType": "ORGANIZATION"
      }
    ],
    "userGroups": [
      {
        "id": 42,
        "type": "GROUP",
        "name": "string",
        "description": "string",
        "userIds": [
          42
        ],
        "groupIds": [
          42
        ],
        "roles": [
          {
            "id": 42,
            "name": "string",
            "roleType": "ORGANIZATION"
          }
        ],
        "globalRoles": [
          {
            "id": 42,
            "name": "string",
            "roleType": "ORGANIZATION"
          }
        ],
        "isAdvanced": true,
        "rule": "string"
      }
    ],
    "id": 42,
    "ecorrespondence": true
  }
]

Response examples (200)

{
  "items": [
    {
      "errorCode": {
        "errorCode": "NO_ERROR",
        "errorDetailValues": [
          {
            "errorCode": "string",
            "fieldName": "string",
            "data": "string",
            "isSevere": true
          }
        ]
      },
      "freshRow": {},
      "freshData": {},
      "possibleWorkflows": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "error": true,
      "severeError": true
    }
  ]
}