GET /api-v1/payslip/region

Headers

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID integer

    ID of organization, for which the operation must be performed

Query parameters

  • countryCode string Required
  • regionCode string Required

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • * array[object] Additional properties
      Hide * attributes Show * attributes object
      • id integer
      • parentPayslipId integer
      • startDate string Required
      • endDate string Required
      • calendarYear integer(int32) Required
      • countryId integer Required
      • countryName object
        Hide countryName attributes Show countryName attributes object
        • en string
        • fr string
        • de string
        • it string
      • countryCode string
      • isRegionAvailable boolean
      • type string Required

        Values are COUNTRY, REGION, or CLA.

      • region object
        Hide region attributes Show region attributes object
        • id integer
        • name string
        • code string
        • taxMode string

          Values are ANNUALLY or MONTHLY.

      • cla string
      • warnings string
      • payslipLines array[object]
        Hide payslipLines attributes Show payslipLines attributes object
        • id integer
        • number integer Required
        • localizations object Required
          Hide localizations attributes Show localizations attributes object
          • id integer
          • en string
          • fr string
          • de string
          • it string
        • payslipLineType string Required

          Values are EMPLOYEE_LINE, COMPANY_LINE, CALCULATION, or SYSTEM.

        • payslipLineSign string Required

          Values are INCOME or CHARGES.

        • isShownOnSalarySlip boolean
        • isAutomaticallyAdded boolean
        • isLinkedToAccount boolean
        • specialAttributionType string

          Values are BASE_SALARY, GROSS_SALARY, NET_SALARY, PAYABLE, CHARGES, EMPLOYEE_ALLOCATION, or SYSTEM_LINE_ADJUSTMENT.

        • payslipEntityId integer

        • systemLine object

          One of:
          SystemLine object object-2 object object-2 object object-2 object
        • parentPayslipLines array[integer]
        • touched boolean
        • shouldIncludeVat boolean
        • isHourlyWageLine boolean
        • description object
          Hide description attributes Show description attributes object
          • en string
          • fr string
          • de string
          • it string
        • lineName object
          Hide lineName attributes Show lineName attributes object
          • en string
          • fr string
          • de string
          • it string
      • payslipCertificateInsuranceInfoEntity object
        Hide payslipCertificateInsuranceInfoEntity attributes Show payslipCertificateInsuranceInfoEntity attributes object
        • id integer
        • salaryRent array[integer]
        • ancillaryWageBenefitsPensionHousing array[integer]
        • ancillaryWageBenefitsPrivateCarUse array[integer]
        • ancillaryWageBenefitsOther array[integer]
        • nonRecurringBenefits array[integer]
        • capitalBenefits array[integer]
        • participationFeeAccordingToAnnex array[integer]
        • allowancesOfTheMembersOfTheAdministration array[integer]
        • otherServices array[integer]
        • socialContributions array[integer]
        • occupationalBenefitsOrdinary array[integer]
        • occupationalBenefitsRePurchaseContributions array[integer]
        • directTaxAtSource array[integer]
        • costAllowancesTravelFoodLodging array[integer]
        • costAllowancesActualCosts array[integer]
        • costAllowancesFixedExpensesRepresentation array[integer]
        • costAllowancesFixedExpensesCar array[integer]
        • costAllowancesFixedExpensesOther array[integer]
        • developmentContributions array[integer]
        • avsSalary array[integer]
        • aciSalary array[integer]
        • aciiSalary array[integer]
        • laaSalary array[integer]
        • laacSalary array[integer]
        • laacExceesSalary array[integer]
        • apgSalary array[integer]
      • holidays array[object]
        Hide holidays attributes Show holidays attributes object
        • id integer
        • date string Required
        • name string Required
      • status string

        Values are DRAFT or FINAL.

      • fromSwitzerland boolean
      • regionAvailable boolean
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

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