Modify batch of contacts
Headers
-
TARGET-ORGANIZATION-ID integer(int32)
ID of organization, for which the operation must be performed
-
API token (can be retrieved from account settings)
Body Required
contacts
-
additionalInformation array[object]
-
addresses array[object]
-
archived boolean
-
banks array[object]
-
client object
Additional properties are allowed.
-
communications array[object]
-
contactId integer
-
contactType string
Values are
ORGANIZATIONorPERSON. -
defaultLanguage string
Values are
EN,FR,DE,IT, orUNDEFINED. -
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, orFINANCIAL_STATEMENTS. -
ecorrespondence boolean
-
email string
-
externalId string
-
fax string
-
groupRoles array[object]
-
id integer
-
isCustomer boolean
-
isStaff boolean
-
isUser boolean
-
isVendor boolean
-
mobile string
-
organizationId integer
-
organizationUsesTimesheets boolean
-
permissionsTree array[object]
-
phone string
-
staff object
Additional properties are allowed.
-
supplier object
Additional properties are allowed.
-
userGroups array[object]
-
warnings string
-
webSite string
POST /api-v1/contact/batch
curl \
-X POST http://10.10.10.132/api-v1/contact/batch \
-H "TARGET-ORGANIZATION-ID: 42" \
-H "WEAL-TOKEN: string" \
-d '[{"additionalInformation":[{"id":42,"note":"string","tag":{"id":42,"name":"string"}}],"addresses":[{"city":"string","countryCode2":"string","countryId":42,"houseNumber":"string","id":42,"line1":"string","line2":"string","name":"string","position":42,"postCode":"string","readOnly":true,"region":{"code":"string","id":42,"name":"string","taxMode":"ANNUALLY"},"service":"string","toTheAttentionOf":"string"}],"archived":true,"banks":[{"accountHolderAddress":{"city":"string","countryCode2":"string","countryId":42,"houseNumber":"string","id":42,"line1":"string","line2":"string","name":"string","position":42,"postCode":"string","readOnly":true,"region":{"code":"string","id":42,"name":"string","taxMode":"ANNUALLY"},"service":"string","toTheAttentionOf":"string"},"accountNumber":"string","bankCustomerNumber":"string","bankName":"string","chartOfAccounts":42,"customHolder":true,"id":42,"isrCustomerNumber":"string","name":"string","position":42,"qrIban":"string","remark":"string","swiftBic":"string","useForReconciliation":true}],"client":{"PLAccountName":{"de":"string","en":"string","fr":"string","it":"string"},"advancedInvoicingNote":"string","articleDiscounts":[{"articleId":42,"articleIdName":{"de":"string","en":"string","fr":"string","it":"string"},"discount":42.0,"id":42}],"balanceSheetAccountId":42,"balanceSheetAccountName":{"de":"string","en":"string","fr":"string","it":"string"},"billingEmail":"string","businessUnitId":42,"businessUnitName":"string","clientDiscountRate":"string","contactId":42,"creditLimit":"string","currencyId":42,"id":42,"invoiceAddressId":42,"invoiceAddressName":"string","lateNoticeEmail":"string","lateNoticeMargin":"string","orderAddressId":42,"orderAddressName":"string","orderEmail":"string","orderValidity":"string","paymentAccountId":42,"paymentAccountName":{"de":"string","en":"string","fr":"string","it":"string"},"paymentTerms":"string","placcountId":42,"placcountName":{"de":"string","en":"string","fr":"string","it":"string"},"vatNumber":"string","vatRateId":42,"vatTypeCodeId":42},"communications":[{"date":"string","description":"string","externalContactId":42,"externalContactIdName":"string","externalContactName":"string","id":42,"longDescription":"string","ourContactId":42,"ourContactName":"string","type":"PHONE_CALL"}],"contactId":42,"contactType":"ORGANIZATION","defaultLanguage":"EN","defaultModule":"ALL","ecorrespondence":true,"email":"string","externalId":"string","fax":"string","groupRoles":[{"id":42,"name":"string","roleType":"ORGANIZATION"}],"id":42,"isCustomer":true,"isStaff":true,"isUser":true,"isVendor":true,"mobile":"string","organizationId":42,"organizationUsesTimesheets":true,"permissionsTree":[{"availableRoles":[{"description":"string","id":42,"isDefault":true,"name":"string","realId":42,"roleType":"ORGANIZATION","type":"ROLE"}],"globalRoles":[{"id":42,"isDefault":true,"name":"string","type":"ROLE"}],"id":42,"isActive":true,"name":"string","organizationId":42,"parentOrganizationId":42,"roles":[{"id":42,"isDefault":true,"name":"string","type":"ROLE"}]}],"phone":"string","relatedContactIds":[42],"relatedOrganizationContactIds":[42],"staff":{"avsNumber":"string","contactId":42,"contractType":"OPEN_ENDED","costCalculationType":"AUTOMATIC","documentExpiryDate":"string","documentNumber":"string","employeeDocumentType":"PASSPORT","employmentEndDate":"string","employmentStartDate":"string","enforceTimesheets":true,"familyMembers":[{"birthDate":"string","familyMemberType":"SPOUSE","firstName":"string","id":42,"lastName":"string","nationalityCountryId":42,"staffId":42}],"id":42,"isSpouseWorking":true,"jobTitle":"string","maritalDate":"string","maritalType":"SINGLE","pdfPassword":"string","permitExpiryDate":"string","staffPayslips":[{"baseSalaryLine":{"employeeAmount":"string","employerAmount":"string","id":42,"payslipLineEntityId":42,"payslipValueSplitType":"EMPLOYEE","staffPayslipEntityId":42},"calendarYear":42,"employeeGroups":[{"departmentId":42,"departmentName":"string","groupType":"ADMIN","id":42,"officeId":42,"officeName":"string","percentage":"string","staffPayslipEntityId":42}],"employmentEndDate":"string","employmentStartDate":"string","id":42,"isCanteenMealsOrMealsVouchers":true,"isFreeTransportToWork":true,"payslipTableLines":[{"description":"string","employeePercentage":"string","employeeValue":"string","employerPercentage":"string","employerValue":"string","endDate":"string","id":42,"number":42,"organizationEmployeeGroupId":42,"organizationPayslipEntityId":42,"payslipEntityId":42,"payslipLineId":"string","quantity":"string","staffPayslipEntityId":42,"startDate":"string"}],"salaryCertificateNotes":"string","salaryInfo":{"capacity":"string","defaultPaymentAccountId":42,"defaultPaymentAccountName":{"de":"string","en":"string","fr":"string","it":"string"},"hasOnlyOneJob":true,"hourlyRate":"string","id":42,"isSourceTaxEnabled":true,"numberOfVacationDays":"string","organizationEmployeeGroupId":42,"organizationId":42,"payableToBankId":42,"payrollCurrencyId":42,"regionId":42,"salaryType":"MONTHLY","sourceTaxCode":"string","staffId":42,"staffPayslipEntityId":42,"totalOccupancy":"string","workOccupancy":"string"},"staffId":42,"systemLine":{"bracket":"string","id":42,"localizations":{"de":"string","en":"string","fr":"string","id":42,"it":"string"},"number":42,"payslipLineEntityId":42,"rate":"string","staffPayslipEntityId":42}}],"timesheetPricingLines":[{"clientId":42,"clientName":"string","endDate":"string","id":42,"orderId":42,"rate":"string","staffId":42,"startDate":"string","task":{"archived":true,"id":42,"name":"string","organizationId":42,"rate":42.0}}],"timesheetsCost":"string","workPermit":{"countryId":42,"id":42,"name":{"de":"string","en":"string","fr":"string","it":"string"},"nameId":42}},"supplier":{"PLAccountName":{"de":"string","en":"string","fr":"string","it":"string"},"balanceSheetAccountId":42,"balanceSheetAccountName":{"de":"string","en":"string","fr":"string","it":"string"},"businessUnitId":42,"businessUnitName":"string","contactId":42,"currencyId":42,"feeSplitType":"CHARGED_TO_THE_BENEFICIARY","id":42,"paymentAccountId":42,"paymentAccountName":{"de":"string","en":"string","fr":"string","it":"string"},"paymentTerms":"string","placcountId":42,"placcountName":{"de":"string","en":"string","fr":"string","it":"string"},"vatNumber":"string","vatRateId":42,"vatType":"NO_VAT","vatTypeCodeId":42},"tags":[{"id":42,"name":"string"}],"userGroups":[{"description":"string","globalRoles":[{"id":42,"name":"string","roleType":"ORGANIZATION"}],"groupIds":[42],"id":42,"isAdvanced":true,"name":"string","roles":[{"id":42,"name":"string","roleType":"ORGANIZATION"}],"rule":"string","type":"GROUP","userIds":[42]}],"warnings":"string","webSite":"string"}]'
Request examples
# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string
# Payload
[
{
"additionalInformation": [
{
"id": 42,
"note": "string",
"tag": {
"id": 42,
"name": "string"
}
}
],
"addresses": [
{
"city": "string",
"countryCode2": "string",
"countryId": 42,
"houseNumber": "string",
"id": 42,
"line1": "string",
"line2": "string",
"name": "string",
"position": 42,
"postCode": "string",
"readOnly": true,
"region": {
"code": "string",
"id": 42,
"name": "string",
"taxMode": "ANNUALLY"
},
"service": "string",
"toTheAttentionOf": "string"
}
],
"archived": true,
"banks": [
{
"accountHolderAddress": {
"city": "string",
"countryCode2": "string",
"countryId": 42,
"houseNumber": "string",
"id": 42,
"line1": "string",
"line2": "string",
"name": "string",
"position": 42,
"postCode": "string",
"readOnly": true,
"region": {
"code": "string",
"id": 42,
"name": "string",
"taxMode": "ANNUALLY"
},
"service": "string",
"toTheAttentionOf": "string"
},
"accountNumber": "string",
"bankCustomerNumber": "string",
"bankName": "string",
"chartOfAccounts": 42,
"customHolder": true,
"id": 42,
"isrCustomerNumber": "string",
"name": "string",
"position": 42,
"qrIban": "string",
"remark": "string",
"swiftBic": "string",
"useForReconciliation": true
}
],
"client": {
"PLAccountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"advancedInvoicingNote": "string",
"articleDiscounts": [
{
"articleId": 42,
"articleIdName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"discount": 42.0,
"id": 42
}
],
"balanceSheetAccountId": 42,
"balanceSheetAccountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"billingEmail": "string",
"businessUnitId": 42,
"businessUnitName": "string",
"clientDiscountRate": "string",
"contactId": 42,
"creditLimit": "string",
"currencyId": 42,
"id": 42,
"invoiceAddressId": 42,
"invoiceAddressName": "string",
"lateNoticeEmail": "string",
"lateNoticeMargin": "string",
"orderAddressId": 42,
"orderAddressName": "string",
"orderEmail": "string",
"orderValidity": "string",
"paymentAccountId": 42,
"paymentAccountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"paymentTerms": "string",
"placcountId": 42,
"placcountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"vatNumber": "string",
"vatRateId": 42,
"vatTypeCodeId": 42
},
"communications": [
{
"date": "string",
"description": "string",
"externalContactId": 42,
"externalContactIdName": "string",
"externalContactName": "string",
"id": 42,
"longDescription": "string",
"ourContactId": 42,
"ourContactName": "string",
"type": "PHONE_CALL"
}
],
"contactId": 42,
"contactType": "ORGANIZATION",
"defaultLanguage": "EN",
"defaultModule": "ALL",
"ecorrespondence": true,
"email": "string",
"externalId": "string",
"fax": "string",
"groupRoles": [
{
"id": 42,
"name": "string",
"roleType": "ORGANIZATION"
}
],
"id": 42,
"isCustomer": true,
"isStaff": true,
"isUser": true,
"isVendor": true,
"mobile": "string",
"organizationId": 42,
"organizationUsesTimesheets": true,
"permissionsTree": [
{
"availableRoles": [
{
"description": "string",
"id": 42,
"isDefault": true,
"name": "string",
"realId": 42,
"roleType": "ORGANIZATION",
"type": "ROLE"
}
],
"globalRoles": [
{
"id": 42,
"isDefault": true,
"name": "string",
"type": "ROLE"
}
],
"id": 42,
"isActive": true,
"name": "string",
"organizationId": 42,
"parentOrganizationId": 42,
"roles": [
{
"id": 42,
"isDefault": true,
"name": "string",
"type": "ROLE"
}
]
}
],
"phone": "string",
"relatedContactIds": [
42
],
"relatedOrganizationContactIds": [
42
],
"staff": {
"avsNumber": "string",
"contactId": 42,
"contractType": "OPEN_ENDED",
"costCalculationType": "AUTOMATIC",
"documentExpiryDate": "string",
"documentNumber": "string",
"employeeDocumentType": "PASSPORT",
"employmentEndDate": "string",
"employmentStartDate": "string",
"enforceTimesheets": true,
"familyMembers": [
{
"birthDate": "string",
"familyMemberType": "SPOUSE",
"firstName": "string",
"id": 42,
"lastName": "string",
"nationalityCountryId": 42,
"staffId": 42
}
],
"id": 42,
"isSpouseWorking": true,
"jobTitle": "string",
"maritalDate": "string",
"maritalType": "SINGLE",
"pdfPassword": "string",
"permitExpiryDate": "string",
"staffPayslips": [
{
"baseSalaryLine": {
"employeeAmount": "string",
"employerAmount": "string",
"id": 42,
"payslipLineEntityId": 42,
"payslipValueSplitType": "EMPLOYEE",
"staffPayslipEntityId": 42
},
"calendarYear": 42,
"employeeGroups": [
{
"departmentId": 42,
"departmentName": "string",
"groupType": "ADMIN",
"id": 42,
"officeId": 42,
"officeName": "string",
"percentage": "string",
"staffPayslipEntityId": 42
}
],
"employmentEndDate": "string",
"employmentStartDate": "string",
"id": 42,
"isCanteenMealsOrMealsVouchers": true,
"isFreeTransportToWork": true,
"payslipTableLines": [
{
"description": "string",
"employeePercentage": "string",
"employeeValue": "string",
"employerPercentage": "string",
"employerValue": "string",
"endDate": "string",
"id": 42,
"number": 42,
"organizationEmployeeGroupId": 42,
"organizationPayslipEntityId": 42,
"payslipEntityId": 42,
"payslipLineId": "string",
"quantity": "string",
"staffPayslipEntityId": 42,
"startDate": "string"
}
],
"salaryCertificateNotes": "string",
"salaryInfo": {
"capacity": "string",
"defaultPaymentAccountId": 42,
"defaultPaymentAccountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"hasOnlyOneJob": true,
"hourlyRate": "string",
"id": 42,
"isSourceTaxEnabled": true,
"numberOfVacationDays": "string",
"organizationEmployeeGroupId": 42,
"organizationId": 42,
"payableToBankId": 42,
"payrollCurrencyId": 42,
"regionId": 42,
"salaryType": "MONTHLY",
"sourceTaxCode": "string",
"staffId": 42,
"staffPayslipEntityId": 42,
"totalOccupancy": "string",
"workOccupancy": "string"
},
"staffId": 42,
"systemLine": {
"bracket": "string",
"id": 42,
"localizations": {
"de": "string",
"en": "string",
"fr": "string",
"id": 42,
"it": "string"
},
"number": 42,
"payslipLineEntityId": 42,
"rate": "string",
"staffPayslipEntityId": 42
}
}
],
"timesheetPricingLines": [
{
"clientId": 42,
"clientName": "string",
"endDate": "string",
"id": 42,
"orderId": 42,
"rate": "string",
"staffId": 42,
"startDate": "string",
"task": {
"archived": true,
"id": 42,
"name": "string",
"organizationId": 42,
"rate": 42.0
}
}
],
"timesheetsCost": "string",
"workPermit": {
"countryId": 42,
"id": 42,
"name": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"nameId": 42
}
},
"supplier": {
"PLAccountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"balanceSheetAccountId": 42,
"balanceSheetAccountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"businessUnitId": 42,
"businessUnitName": "string",
"contactId": 42,
"currencyId": 42,
"feeSplitType": "CHARGED_TO_THE_BENEFICIARY",
"id": 42,
"paymentAccountId": 42,
"paymentAccountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"paymentTerms": "string",
"placcountId": 42,
"placcountName": {
"de": "string",
"en": "string",
"fr": "string",
"it": "string"
},
"vatNumber": "string",
"vatRateId": 42,
"vatType": "NO_VAT",
"vatTypeCodeId": 42
},
"tags": [
{
"id": 42,
"name": "string"
}
],
"userGroups": [
{
"description": "string",
"globalRoles": [
{
"id": 42,
"name": "string",
"roleType": "ORGANIZATION"
}
],
"groupIds": [
42
],
"id": 42,
"isAdvanced": true,
"name": "string",
"roles": [
{
"id": 42,
"name": "string",
"roleType": "ORGANIZATION"
}
],
"rule": "string",
"type": "GROUP",
"userIds": [
42
]
}
],
"warnings": "string",
"webSite": "string"
}
]
Response examples (200)
{
"items": [
{
"error": true,
"errorCode": {
"errorCode": "NO_ERROR",
"errorDetailValues": [
{
"data": "string",
"errorCode": "string",
"fieldName": "string",
"isSevere": true
}
]
},
"freshData": {},
"freshRow": {},
"possibleWorkflows": [
{
"id": 42,
"name": "string"
}
],
"severeError": true
}
]
}