Get details of payroll

GET /api-v1/payroll/{id}

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

id integer Required

id

Responses

200

OK
Hide response attributes Show response attributes object
- address object
  
  Additional properties are allowed.
  
  Hide address attributes Show address attributes object
  
  city string
  
  countryCode2 string
  
  countryId integer
  
  houseNumber string
  
  id integer
  
  line1 string
  
  line2 string
  
  name string
  
  position integer(int32)
  
  postCode string
  
  readOnly boolean
  
  region object
  
  Additional properties are allowed.
  
  Hide region attributes Show region attributes object
  
  code string
  
  id integer
  
  name string
  
  taxMode string
  
  Values are ANNUALLY or MONTHLY.
  
  service string
  
  toTheAttentionOf string
- calendarYear integer(int32)
- contactEntityId integer
- createdOn string
- currencyId integer
- description string
- employeeInfoId integer
- grossSalary string
- id integer
- isDeleted boolean
- isFromLockedAccountingPeriod boolean
- journalEntryId integer
- monthEndDate string(date-time)
- monthStartDate string(date-time)
- monthType string
  
  Values are JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, or DECEMBER.
- netSalary string
- organizationEmployeeGroupId integer
- organizationId integer
- payable string
- paymentDate string
- payrollLines array[object]
  
  Hide payrollLines attributes Show payrollLines attributes object
  
  baseAmount string
  
  description string
  
  employeeAmount string
  
  employeeRate string
  
  employerAmount string
  
  employerRate string
  
  id integer
  
  isAutomaticallyAdded boolean
  
  isChanged boolean
  
  isShownOnSalarySlip boolean
  
  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
  
  payrollEntityId integer
  
  payslipLineEntityId integer
  
  payslipLineType string
  
  Values are EMPLOYEE_LINE, COMPANY_LINE, CALCULATION, or SYSTEM.
  
  payslipValueType string
  
  Values are VALUE or PERCENTAGE.
  
  specialAttributionType string
  
  Values are BASE_SALARY, GROSS_SALARY, NET_SALARY, PAYABLE, CHARGES, EMPLOYEE_ALLOCATION, or SYSTEM_LINE_ADJUSTMENT.
- payrollPayments array[object]
  
  Hide payrollPayments attributes Show payrollPayments attributes object
  
  bankCharges string
  
  id integer
  
  isFromLockedAccountingPeriod boolean
  
  paidAmount string
  
  payableByAccountId integer
  
  payableToBankId integer
  
  payrollEntityId integer
  
  plannedDate string
  
  requestedAmount string
  
  requestedDate string
  
  sentDate string
  
  valueDate string
- removedPayrollLineNumbers array[integer]
- staffEntityId integer
- staffPayslipId integer
- status string
  
  Values are UNPAID, PAID, PARTIALLY_PAID, WIRED, or NOT_SENT.
- warnings string
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/payroll/{id}

curl \
 -X GET http://10.10.10.132/api-v1/payroll/{id} \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

{
  "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"
}