Get list of salary lines for payroll

GET /api-v1/payroll/payroll-table/line-names/{calendarYear}/{organizationId}

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)

Path parameters

calendarYear integer(int32) Required

calendarYear
organizationId integer Required

organizationId

Responses

200

OK
Hide response attributes Show response attributes object
- description object
  
  Additional properties are allowed.
  
  Hide description attributes Show description attributes object
  
  de string
  
  en string
  
  fr string
  
  it string
- id integer
- isAutomaticallyAdded boolean
- isHourlyWageLine boolean
- isLinkedToAccount boolean
- isShownOnSalarySlip boolean
- lineName object
  
  Additional properties are allowed.
  
  Hide lineName attributes Show lineName attributes object
  
  de string
  
  en string
  
  fr string
  
  it string
- localizations object
  
  Additional properties are allowed.
  
  Hide localizations attributes Show localizations attributes object
  
  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
  
  Additional properties are allowed.
  
  Hide systemLine attributes Show systemLine attributes object
  
  id integer
  
  payslipLineType string
  
  Values are EMPLOYEE_LINE, COMPANY_LINE, CALCULATION, or SYSTEM.
  
  systemAdjustmentLineNumber integer
- touched boolean
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/payroll/payroll-table/line-names/{calendarYear}/{organizationId}

curl \
 -X GET http://10.10.10.132/api-v1/payroll/payroll-table/line-names/{calendarYear}/{organizationId} \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "description": {
      "de": "string",
      "en": "string",
      "fr": "string",
      "it": "string"
    },
    "id": 42,
    "isAutomaticallyAdded": true,
    "isHourlyWageLine": 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
  }
]