PayrollRun

Add a line item to a payroll run

POST

http://localhost:3000/api/payroll-run/{id}/items

curl -X POST 'http://localhost:3000/api/payroll-run/string/items' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "employeeId": "string",
  "type": "BASIC_SALARY",
  "category": "EARNING",
  "description": "string",
  "amount": 0,
  "quantity": 0,
  "unitPrice": 0,
  "taxable": true
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "employeeId": "string",
  "type": "BASIC_SALARY",
  "category": "EARNING",
  "description": "string",
  "amount": 0,
  "quantity": 0,
  "unitPrice": 0,
  "taxable": true
}`;

const response = await fetch('http://localhost:3000/api/payroll-run/string/items', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "employeeId": "string",
  "type": "BASIC_SALARY",
  "category": "EARNING",
  "description": "string",
  "amount": 0,
  "quantity": 0,
  "unitPrice": 0,
  "taxable": true
}'''

response = requests.post(
    'http://localhost:3000/api/payroll-run/string/items',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "employeeId": "string",
  "type": "BASIC_SALARY",
  "category": "EARNING",
  "description": "string",
  "amount": 0,
  "quantity": 0,
  "unitPrice": 0,
  "taxable": true
}

Body

application/json

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstringrequired

sentTostring

employeeIdstringrequired

typestringBASIC_SALARYALLOWANCEBONUSCOMMISSIONOVERTIMETAX_DEDUCTIONSOCIAL_SECURITYHEALTH_INSURANCELOAN_DEDUCTIONADVANCE_DEDUCTIONLEAVE_DEDUCTIONOTHER_ADDITIONOTHER_DEDUCTIONrequired

categorystringEARNINGDEDUCTIONrequired

descriptionstring

amountnumberrequired

Always positive; category decides the sign

quantitynumber

unitPricenumber

taxableboolean

Parameters

idstringrequiredpath

Response

201Created

The line item has been added.

Stack Overflow Website Demo