Tax Membership

These endpoints let you manage tax memberships for employees in the system. It allows you to retrieve, create, update, and delete tax membership records.

Get Tax Membership

get

Get the current tax membership information for a specific employee

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequired

Unique identifier for the employee

Example: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Responses

200

Tax membership returned successfully

application/json

idstringOptional

Unique identifier for the tax membership

foreignTaxObjectbooleanOptional

Whether this is a foreign tax object

kppIdstringOptional

Tax office (KPP) identifier

linkToPayrollbooleanOptional

Whether this tax membership is linked to payroll

methodstring · enumOptional

PPh21 calculation method

Possible values:

moreThanOneEmployerbooleanOptional

Whether employee has more than one employer

npwpAddressstringOptional

Address registered with NPWP

npwpNumberstringOptional

NPWP (Tax ID) number - can be empty or contain only digits

Pattern: ^$|^\d+$

tinstringOptional

Tax Identification Number

previousNetIncomenumber · doubleOptional

Previous net income amount

previousPaidPphnumber · doubleOptional

Previous paid PPh amount

ptkpCategoryIdstringOptional

PTKP (Personal Tax Free Income) category identifier

taxObjectstring · enumOptional

Type of tax object for the employee

Possible values:

useRecommendedPeriodbooleanOptional

400

Bad Request - Invalid request parameters

application/json

404

Employee not found

application/json

get

/core/v1/employees/{employeeId}/tax-memberships

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/tax-memberships" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "foreignTaxObject": false,
  "id": "string",
  "kppId": "string",
  "linkToPayroll": true,
  "membershipEndPeriod": {
    "month": 1,
    "year": 1970
  },
  "membershipStartPeriod": {
    "month": 1,
    "year": 1970
  },
  "effectiveStartPeriod": {
    "month": 1,
    "year": 1970
  },
  "effectiveEndPeriod": {
    "month": 1,
    "year": 1970
  },
  "method": "GROSS",
  "moreThanOneEmployer": true,
  "npwpAddress": "Jakarta Selatan, DKI Jakarta",
  "npwpNumber": "123456789012345",
  "tin": "TIN123456",
  "idTku": "TKU1234567890",
  "previousNetIncome": 0,
  "previousPaidPph": 0,
  "ptkpCategoryId": "string",
  "taxObject": "PERMANENT",
  "taxDependents": []
}

Update Tax Membership

put

Update the tax membership information for a specific employee

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequired

Unique identifier for the employee

Example: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Body

idstringOptional

Unique identifier for the tax membership

foreignTaxObjectbooleanOptional

Whether this is a foreign tax object

kppIdstringOptional

Tax office (KPP) identifier

linkToPayrollbooleanOptional

Whether this tax membership is linked to payroll

methodstring · enumOptional

PPh21 calculation method

Possible values:

moreThanOneEmployerbooleanOptional

Whether employee has more than one employer

npwpAddressstringOptional

Address registered with NPWP

npwpNumberstringOptional

NPWP (Tax ID) number - can be empty or contain only digits

Pattern: ^$|^\d+$

tinstringOptional

Tax Identification Number

previousNetIncomenumber · doubleOptional

Previous net income amount

previousPaidPphnumber · doubleOptional

Previous paid PPh amount

ptkpCategoryIdstringOptional

PTKP (Personal Tax Free Income) category identifier

taxObjectstring · enumOptional

Type of tax object for the employee

Possible values:

useRecommendedPeriodbooleanOptional

Responses

200

Tax membership updated successfully

application/json

idstringOptional

Unique identifier for the tax membership

foreignTaxObjectbooleanOptional

Whether this is a foreign tax object

kppIdstringOptional

Tax office (KPP) identifier

linkToPayrollbooleanOptional

Whether this tax membership is linked to payroll

methodstring · enumOptional

PPh21 calculation method

Possible values:

moreThanOneEmployerbooleanOptional

Whether employee has more than one employer

npwpAddressstringOptional

Address registered with NPWP

npwpNumberstringOptional

NPWP (Tax ID) number - can be empty or contain only digits

Pattern: ^$|^\d+$

tinstringOptional

Tax Identification Number

previousNetIncomenumber · doubleOptional

Previous net income amount

previousPaidPphnumber · doubleOptional

Previous paid PPh amount

ptkpCategoryIdstringOptional

PTKP (Personal Tax Free Income) category identifier

taxObjectstring · enumOptional

Type of tax object for the employee

Possible values:

useRecommendedPeriodbooleanOptional

400

Bad Request - Invalid request data

application/json

404

Employee not found

application/json

put

/core/v1/employees/{employeeId}/tax-memberships

curl -X PUT \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/tax-memberships" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '...'

{
  "foreignTaxObject": false,
  "id": "tm-12345",
  "kppId": "kpp-jakarta-selatan",
  "linkToPayroll": true,
  "membershipEndPeriod": {
    "month": 12,
    "year": 2024
  },
  "membershipStartPeriod": {
    "month": 1,
    "year": 2024
  },
  "effectiveStartPeriod": {
    "month": 1,
    "year": 2024
  },
  "effectiveEndPeriod": {
    "month": 12,
    "year": 2024
  },
  "method": "GROSS",
  "moreThanOneEmployer": false,
  "npwpAddress": "Jakarta Selatan, DKI Jakarta",
  "npwpNumber": "123456789012345",
  "tin": "TIN123456",
  "idTku": "TKU1234567890",
  "previousNetIncome": 120000000,
  "previousPaidPph": 12000000,
  "ptkpCategoryId": "ptkp-tk-1",
  "taxObject": "PERMANENT",
  "taxDependents": [
    {
      "id": "dep-1",
      "name": "Jane Doe",
      "ptkpRelationType": "SPOUSE",
      "dateOfBirth": "1990-05-15",
      "job": "Teacher"
    }
  ]
}

Update Tax Membership Tax Subject

put

Update tax subject information for an employee's tax membership

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequired

Unique identifier for the employee

Example: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Body

npwpAddressstringRequired

Address registered with NPWP

npwpNumberstringOptional

NPWP (Tax ID) number - can be empty or contain only digits

Pattern: ^$|^\d+$

idTkustringOptional

TKU (Tax Knowledge Unit) identifier

tinstringOptional

Tax Identification Number

kppIdstringOptional

Tax office (KPP) identifier

ptkpCategoryIdstringOptional

PTKP (Personal Tax Free Income) category identifier

Responses

200

Tax membership tax subject updated successfully

application/json

idstringOptional

Unique identifier for the tax membership

foreignTaxObjectbooleanOptional

Whether this is a foreign tax object

kppIdstringOptional

Tax office (KPP) identifier

linkToPayrollbooleanOptional

Whether this tax membership is linked to payroll

methodstring · enumOptional

PPh21 calculation method

Possible values:

moreThanOneEmployerbooleanOptional

Whether employee has more than one employer

npwpAddressstringOptional

Address registered with NPWP

npwpNumberstringOptional

NPWP (Tax ID) number - can be empty or contain only digits

Pattern: ^$|^\d+$

tinstringOptional

Tax Identification Number

previousNetIncomenumber · doubleOptional

Previous net income amount

previousPaidPphnumber · doubleOptional

Previous paid PPh amount

ptkpCategoryIdstringOptional

PTKP (Personal Tax Free Income) category identifier

taxObjectstring · enumOptional

Type of tax object for the employee

Possible values:

useRecommendedPeriodbooleanOptional

400

Bad Request - Invalid input data

application/json

404

Employee not found

application/json

put

/core/v1/employees/{employeeId}/tax-memberships/tax-subjects

curl -X PUT \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/tax-memberships/tax-subjects" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '{
  "npwpAddress": "Jakarta Selatan, DKI Jakarta",
  "npwpNumber": "123456789012345",
  "idTku": "TKU123456",
  "tin": "TIN123456",
  "kppId": "kpp-jakarta-selatan",
  "ptkpCategoryId": "ptkp-tk-0",
  "taxDependents": [
    {
      "id": "dep-1",
      "name": "Jane Doe",
      "ptkpRelationType": "SPOUSE",
      "dateOfBirth": "1990-05-15",
      "job": "Teacher"
    },
    {
      "id": "dep-2",
      "name": "John Doe Jr",
      "ptkpRelationType": "CHILD",
      "dateOfBirth": "2015-03-20",
      "job": "Student"
    }
  ]
}'

{
  "id": "tm-12345",
  "taxObject": "PERMANENT",
  "membershipStartPeriod": {
    "month": 1,
    "year": 2024
  },
  "membershipEndPeriod": {
    "month": 12,
    "year": 2024
  },
  "effectiveStartPeriod": {
    "month": 1,
    "year": 2024
  },
  "effectiveEndPeriod": {
    "month": 12,
    "year": 2024
  },
  "method": "GROSS",
  "npwpNumber": "123456789012345",
  "npwpAddress": "Jakarta Selatan, DKI Jakarta",
  "tin": "TIN123456",
  "linkToPayroll": true,
  "moreThanOneEmployer": false,
  "foreignTaxObject": false,
  "previousNetIncome": 120000000,
  "previousPaidPph": 12000000,
  "kppId": "kpp-jakarta-selatan",
  "ptkpCategoryId": "ptkp-tk-0",
  "taxDependents": [
    {
      "id": "dep-1",
      "name": "Jane Doe",
      "ptkpRelationType": "SPOUSE",
      "dateOfBirth": "1990-05-15",
      "job": "Teacher"
    }
  ]
}

Last updated 16 days ago

hashtagGet Tax Membership

hashtagUpdate Tax Membership

hashtagUpdate Tax Membership Tax Subject

Get Tax Membership

Update Tax Membership

Update Tax Membership Tax Subject