Modify batch of payrolls

POST /api-v1/payroll/batch

Headers

Body Required

payrolls

Responses

  • OK

    Hide response attribute Show response attribute object
    • items array[object]
      Hide items attributes Show items attributes object
      • error boolean
      • Additional properties are allowed.

        Hide errorCode attributes Show errorCode attributes object
        • 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
      • Additional properties are allowed.

      • freshRow object

        Additional properties are allowed.

      • possibleWorkflows array[object]
        Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  • 400 Bad Request

  • 401 Unauthorized

  • 403 Access Denied

  • 404 Not Found

  • 500 Internal Server Error

POST /api-v1/payroll/batch
curl \
 -X POST http://wyzio.app/api-v1/payroll/batch \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '[{"address":{"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"},"calendarYear":42,"contactEntityId":42,"createdOn":"string","currencyId":42,"description":"string","employeeInfoId":42,"grossSalary":"string","id":42,"isDeleted":true,"isFromLockedAccountingPeriod":true,"journalEntryId":42,"monthEndDate":"2024-05-04T09:42:00+00:00","monthStartDate":"2024-05-04T09:42:00+00:00","monthType":"JANUARY","netSalary":"string","organizationEmployeeGroupId":42,"organizationId":42,"payable":"string","paymentDate":"string","payrollLines":[{"baseAmount":"string","description":"string","employeeAmount":"string","employeeRate":"string","employerAmount":"string","employerRate":"string","id":42,"isAutomaticallyAdded":true,"isChanged":true,"isShownOnSalarySlip":true,"localizations":{"de":"string","en":"string","fr":"string","id":42,"it":"string"},"number":42,"payrollEntityId":42,"payslipLineEntityId":42,"payslipLineType":"EMPLOYEE_LINE","payslipValueType":"VALUE","specialAttributionType":"BASE_SALARY"}],"payrollPayments":[{"bankCharges":"string","id":42,"isFromLockedAccountingPeriod":true,"paidAmount":"string","payableByAccountId":42,"payableToBankId":42,"payrollEntityId":42,"plannedDate":"string","requestedAmount":"string","requestedDate":"string","sentDate":"string","valueDate":"string"}],"removedPayrollLineNumbers":[42],"staffEntityId":42,"staffPayslipId":42,"status":"UNPAID","warnings":"string"}]'
Request examples
# Headers
TARGET-ORGANIZATION-ID: 42
WEAL-TOKEN: string

# Payload
[
  {
    "address": {
      "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"
    },
    "calendarYear": 42,
    "contactEntityId": 42,
    "createdOn": "string",
    "currencyId": 42,
    "description": "string",
    "employeeInfoId": 42,
    "grossSalary": "string",
    "id": 42,
    "isDeleted": true,
    "isFromLockedAccountingPeriod": true,
    "journalEntryId": 42,
    "monthEndDate": "2024-05-04T09:42:00+00:00",
    "monthStartDate": "2024-05-04T09:42:00+00:00",
    "monthType": "JANUARY",
    "netSalary": "string",
    "organizationEmployeeGroupId": 42,
    "organizationId": 42,
    "payable": "string",
    "paymentDate": "string",
    "payrollLines": [
      {
        "baseAmount": "string",
        "description": "string",
        "employeeAmount": "string",
        "employeeRate": "string",
        "employerAmount": "string",
        "employerRate": "string",
        "id": 42,
        "isAutomaticallyAdded": true,
        "isChanged": true,
        "isShownOnSalarySlip": true,
        "localizations": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "id": 42,
          "it": "string"
        },
        "number": 42,
        "payrollEntityId": 42,
        "payslipLineEntityId": 42,
        "payslipLineType": "EMPLOYEE_LINE",
        "payslipValueType": "VALUE",
        "specialAttributionType": "BASE_SALARY"
      }
    ],
    "payrollPayments": [
      {
        "bankCharges": "string",
        "id": 42,
        "isFromLockedAccountingPeriod": true,
        "paidAmount": "string",
        "payableByAccountId": 42,
        "payableToBankId": 42,
        "payrollEntityId": 42,
        "plannedDate": "string",
        "requestedAmount": "string",
        "requestedDate": "string",
        "sentDate": "string",
        "valueDate": "string"
      }
    ],
    "removedPayrollLineNumbers": [
      42
    ],
    "staffEntityId": 42,
    "staffPayslipId": 42,
    "status": "UNPAID",
    "warnings": "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
    }
  ]
}