Modify batch of payrolls payments

POST /api-v1/payroll/batch/payments

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Body Required

payrollPayments

bankCharges string
id integer
isFromLockedAccountingPeriod boolean
paidAmount string
payableByAccountId integer
payableToBankId integer
payrollEntityId integer
plannedDate string
requestedAmount string
requestedDate string
sentDate string
valueDate string

Responses

200

OK
Hide response attribute Show response attribute object
- items array[object]
  
  Hide items attributes Show items attributes object
  
  error boolean
  
  errorCode object
  
  Additional properties are allowed.
  
  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
  
  data string
  
  errorCode string
  
  fieldName string
  
  isSevere boolean
  
  freshData object
  
  Additional properties are allowed.
  
  freshRow object
  
  Additional properties are allowed.
  
  possibleWorkflows array[object]
  
  Hide possibleWorkflows attributes Show possibleWorkflows attributes object
  
  id integer
  
  name string
  
  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/payroll/batch/payments

curl \
 --request POST 'http://wyzio.app/api-v1/payroll/batch/payments' \
 --header "TARGET-ORGANIZATION-ID: 42" \
 --header "WEAL-TOKEN: string" \
 --data '[{"bankCharges":"string","id":42,"isFromLockedAccountingPeriod":true,"paidAmount":"string","payableByAccountId":42,"payableToBankId":42,"payrollEntityId":42,"plannedDate":"string","requestedAmount":"string","requestedDate":"string","sentDate":"string","valueDate":"string"}]'

Request examples

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

# Payload
[
  {
    "bankCharges": "string",
    "id": 42,
    "isFromLockedAccountingPeriod": true,
    "paidAmount": "string",
    "payableByAccountId": 42,
    "payableToBankId": 42,
    "payrollEntityId": 42,
    "plannedDate": "string",
    "requestedAmount": "string",
    "requestedDate": "string",
    "sentDate": "string",
    "valueDate": "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
    }
  ]
}