Modify batch of contacts

POST /api-v1/contact/batch

Headers

Body Required

contacts

Responses

  • 200

    OK

    Hide response attribute Show response attribute object
    • items array[object]
      Hide items attributes Show items attributes object
      • error boolean
      • Hide errorCode attributes Show errorCode attributes
        • 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
      • freshRow object
      • possibleWorkflows array[object]
        Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  • 400

    Error

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

POST /api-v1/contact/batch
curl \
 -X POST http://wyzio.app/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"},"service":"string","toTheAttentionOf":"string"}],"archived":true,"banks":[{"accountNumber":"string","bankCustomerNumber":"string","bankName":"string","chartOfAccounts":42,"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","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,"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":{"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 example
# 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"
        },
        "service": "string",
        "toTheAttentionOf": "string"
      }
    ],
    "archived": true,
    "banks": [
      {
        "accountNumber": "string",
        "bankCustomerNumber": "string",
        "bankName": "string",
        "chartOfAccounts": 42,
        "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",
      "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,
              "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": {
            "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
    }
  ]
}