Wyzio API documentation

Modify batch of salary configs

POST /api-v1/payslip/batch

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

payslips

calendarYear integer(int32)
cla string
countryCode string
countryId integer
countryName object
Hide countryName attributes Show countryName attributes
- de string
- en string
- fr string
- it string
endDate string
fromSwitzerland boolean
holidays array[object]
Hide holidays attributes Show holidays attributes object
- date string
- id integer
- name string
id integer
isRegionAvailable boolean
parentPayslipId integer
payslipCertificateInsuranceInfoEntity object
Hide payslipCertificateInsuranceInfoEntity attributes Show payslipCertificateInsuranceInfoEntity attributes
- aciSalary array[integer]
- aciiSalary array[integer]
- allowancesOfTheMembersOfTheAdministration array[integer]
- ancillaryWageBenefitsOther array[integer]
- ancillaryWageBenefitsPensionHousing array[integer]
- ancillaryWageBenefitsPrivateCarUse array[integer]
- apgSalary array[integer]
- avsSalary array[integer]
- capitalBenefits array[integer]
- costAllowancesActualCosts array[integer]
- costAllowancesFixedExpensesCar array[integer]
- costAllowancesFixedExpensesOther array[integer]
- costAllowancesFixedExpensesRepresentation array[integer]
- costAllowancesTravelFoodLodging array[integer]
- developmentContributions array[integer]
- directTaxAtSource array[integer]
- id integer
- laaSalary array[integer]
- laacExceesSalary array[integer]
- laacSalary array[integer]
- nonRecurringBenefits array[integer]
- occupationalBenefitsOrdinary array[integer]
- occupationalBenefitsRePurchaseContributions array[integer]
- otherServices array[integer]
- participationFeeAccordingToAnnex array[integer]
- salaryRent array[integer]
- socialContributions array[integer]
payslipLines array[object]
Hide payslipLines attributes Show payslipLines attributes object
- description object
  Hide description attributes Show description attributes
  
  de string
  
  en string
  
  fr string
  
  it string
- id integer
- isAutomaticallyAdded boolean
- isLinkedToAccount boolean
- isShownOnSalarySlip boolean
- lineName object
  Hide lineName attributes Show lineName attributes
  
  de string
  
  en string
  
  fr string
  
  it string
- localizations object
  Hide localizations attributes Show localizations attributes
  
  de string
  
  en string
  
  fr string
  
  id integer
  
  it string
- number integer
- parentPayslipLines array[integer]
- payslipEntityId integer
- payslipLineSign string
  
  Values are INCOME or CHARGES.
- payslipLineType string
  
  Values are EMPLOYEE_LINE, COMPANY_LINE, CALCULATION, or SYSTEM.
- shouldIncludeVat boolean
- specialAttributionType string
  
  Values are BASE_SALARY, GROSS_SALARY, NET_SALARY, PAYABLE, CHARGES, EMPLOYEE_ALLOCATION, or SYSTEM_LINE_ADJUSTMENT.
- systemLine object
  Hide systemLine attributes Show systemLine attributes
  
  id integer
  
  payslipLineType string
  
  Values are EMPLOYEE_LINE, COMPANY_LINE, CALCULATION, or SYSTEM.
  
  systemAdjustmentLineNumber integer
- touched boolean
region object
Hide region attributes Show region attributes
- code string
- id integer
- name string
regionAvailable boolean
startDate string
status string

Values are DRAFT or FINAL.
type string

Values are COUNTRY, REGION, or CLA.
warnings 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
  
  Hide errorCode attributes Show errorCode attributes
  
  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
  
  freshRow object
  
  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/payslip/batch

curl \
 -X POST http://wyzio.app/api-v1/payslip/batch \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string" \
 -d '[{"calendarYear":42,"cla":"string","countryCode":"string","countryId":42,"countryName":{"de":"string","en":"string","fr":"string","it":"string"},"endDate":"string","fromSwitzerland":true,"holidays":[{"date":"string","id":42,"name":"string"}],"id":42,"isRegionAvailable":true,"parentPayslipId":42,"payslipCertificateInsuranceInfoEntity":{"aciSalary":[42],"aciiSalary":[42],"allowancesOfTheMembersOfTheAdministration":[42],"ancillaryWageBenefitsOther":[42],"ancillaryWageBenefitsPensionHousing":[42],"ancillaryWageBenefitsPrivateCarUse":[42],"apgSalary":[42],"avsSalary":[42],"capitalBenefits":[42],"costAllowancesActualCosts":[42],"costAllowancesFixedExpensesCar":[42],"costAllowancesFixedExpensesOther":[42],"costAllowancesFixedExpensesRepresentation":[42],"costAllowancesTravelFoodLodging":[42],"developmentContributions":[42],"directTaxAtSource":[42],"id":42,"laaSalary":[42],"laacExceesSalary":[42],"laacSalary":[42],"nonRecurringBenefits":[42],"occupationalBenefitsOrdinary":[42],"occupationalBenefitsRePurchaseContributions":[42],"otherServices":[42],"participationFeeAccordingToAnnex":[42],"salaryRent":[42],"socialContributions":[42]},"payslipLines":[{"description":{"de":"string","en":"string","fr":"string","it":"string"},"id":42,"isAutomaticallyAdded":true,"isLinkedToAccount":true,"isShownOnSalarySlip":true,"lineName":{"de":"string","en":"string","fr":"string","it":"string"},"localizations":{"de":"string","en":"string","fr":"string","id":42,"it":"string"},"number":42,"parentPayslipLines":[42],"payslipEntityId":42,"payslipLineSign":"INCOME","payslipLineType":"EMPLOYEE_LINE","shouldIncludeVat":true,"specialAttributionType":"BASE_SALARY","systemLine":{"id":42,"payslipLineType":"EMPLOYEE_LINE","systemAdjustmentLineNumber":42},"touched":true}],"region":{"code":"string","id":42,"name":"string"},"regionAvailable":true,"startDate":"string","status":"DRAFT","type":"COUNTRY","warnings":"string"}]'

Request example

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

# Payload
[
  {
    "calendarYear": 42,
    "cla": "string",
    "countryCode": "string",
    "countryId": 42,
    "countryName": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "it": "string"
    },
    "endDate": "string",
    "fromSwitzerland": true,
    "holidays": [
      {
        "date": "string",
        "id": 42,
        "name": "string"
      }
    ],
    "id": 42,
    "isRegionAvailable": true,
    "parentPayslipId": 42,
    "payslipCertificateInsuranceInfoEntity": {
      "aciSalary": [
        42
      ],
      "aciiSalary": [
        42
      ],
      "allowancesOfTheMembersOfTheAdministration": [
        42
      ],
      "ancillaryWageBenefitsOther": [
        42
      ],
      "ancillaryWageBenefitsPensionHousing": [
        42
      ],
      "ancillaryWageBenefitsPrivateCarUse": [
        42
      ],
      "apgSalary": [
        42
      ],
      "avsSalary": [
        42
      ],
      "capitalBenefits": [
        42
      ],
      "costAllowancesActualCosts": [
        42
      ],
      "costAllowancesFixedExpensesCar": [
        42
      ],
      "costAllowancesFixedExpensesOther": [
        42
      ],
      "costAllowancesFixedExpensesRepresentation": [
        42
      ],
      "costAllowancesTravelFoodLodging": [
        42
      ],
      "developmentContributions": [
        42
      ],
      "directTaxAtSource": [
        42
      ],
      "id": 42,
      "laaSalary": [
        42
      ],
      "laacExceesSalary": [
        42
      ],
      "laacSalary": [
        42
      ],
      "nonRecurringBenefits": [
        42
      ],
      "occupationalBenefitsOrdinary": [
        42
      ],
      "occupationalBenefitsRePurchaseContributions": [
        42
      ],
      "otherServices": [
        42
      ],
      "participationFeeAccordingToAnnex": [
        42
      ],
      "salaryRent": [
        42
      ],
      "socialContributions": [
        42
      ]
    },
    "payslipLines": [
      {
        "description": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "it": "string"
        },
        "id": 42,
        "isAutomaticallyAdded": true,
        "isLinkedToAccount": true,
        "isShownOnSalarySlip": true,
        "lineName": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "it": "string"
        },
        "localizations": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "id": 42,
          "it": "string"
        },
        "number": 42,
        "parentPayslipLines": [
          42
        ],
        "payslipEntityId": 42,
        "payslipLineSign": "INCOME",
        "payslipLineType": "EMPLOYEE_LINE",
        "shouldIncludeVat": true,
        "specialAttributionType": "BASE_SALARY",
        "systemLine": {
          "id": 42,
          "payslipLineType": "EMPLOYEE_LINE",
          "systemAdjustmentLineNumber": 42
        },
        "touched": true
      }
    ],
    "region": {
      "code": "string",
      "id": 42,
      "name": "string"
    },
    "regionAvailable": true,
    "startDate": "string",
    "status": "DRAFT",
    "type": "COUNTRY",
    "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
    }
  ]
}