# PayRun.IO API

> PayRun.IO API on Apizie: 390 endpoints (Gets the employer, Updates the Employer, Patches the employer, Delete an Employer, …) returned as clean JSON through one API key. 390 endpoints are live now. Call it over REST at https://www.apizie.tech/v1/finance:payrun/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:payrun`
- Category: Finance
- Status: live
- Source: https://payrun.io
- Page: https://www.apizie.tech/api/finance/payrun
- OpenAPI: https://www.apizie.tech/api/finance/payrun/openapi.json

Open, scableable, transparent payroll API.

## Endpoints

### Gets the employer
`GET https://www.apizie.tech/v1/finance:payrun/get-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Updates the Employer
`POST https://www.apizie.tech/v1/finance:payrun/put-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Patches the employer
`POST https://www.apizie.tech/v1/finance:payrun/patch-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Delete an Employer
`POST https://www.apizie.tech/v1/finance:payrun/delete-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get CIS line type from employer
`GET https://www.apizie.tech/v1/finance:payrun/get-cis-line-type-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisLineTypeId | string | yes | The CIS line type unique identifier. E.g. TYPEA |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Updates the CIS line type
`POST https://www.apizie.tech/v1/finance:payrun/put-cis-line-type-into-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisLineTypeId | string | yes | The CIS line type unique identifier. E.g. TYPEA |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Delete an CIS line type
`POST https://www.apizie.tech/v1/finance:payrun/delete-cis-line-type`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisLineTypeId | string | yes | The CIS line type unique identifier. E.g. TYPEA |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get CIS line type tag
`GET https://www.apizie.tech/v1/finance:payrun/get-tag-from-cis-line-type`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisLineTypeId | string | yes | The CIS line type unique identifier. E.g. TYPEA |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert CIS line type tag
`POST https://www.apizie.tech/v1/finance:payrun/put-cis-line-type-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisLineTypeId | string | yes | The CIS line type unique identifier. E.g. TYPEA |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete CIS line type tag
`POST https://www.apizie.tech/v1/finance:payrun/delete-cis-line-type-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisLineTypeId | string | yes | The CIS line type unique identifier. E.g. TYPEA |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all tags from the CIS line type
`GET https://www.apizie.tech/v1/finance:payrun/get-tags-from-cis-line-type`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisLineTypeId | string | yes | The CIS line type unique identifier. E.g. TYPEA |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get CIS line types from employer.
`GET https://www.apizie.tech/v1/finance:payrun/get-cis-line-types-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Create a new CIS line type
`POST https://www.apizie.tech/v1/finance:payrun/post-cis-line-type-into-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Get CIS line types with tag
`GET https://www.apizie.tech/v1/finance:payrun/get-cis-line-types-with-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all CIS line type tags
`GET https://www.apizie.tech/v1/finance:payrun/get-all-cis-line-type-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get the CIS transaction
`GET https://www.apizie.tech/v1/finance:payrun/get-cis-transaction-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisTransactionId | string | yes | The CIS transaction unique identifier. E.g. CISTRAN001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete the CIS transaction
`POST https://www.apizie.tech/v1/finance:payrun/delete-cis-transaction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| CisTransactionId | string | yes | The CIS transaction unique identifier. E.g. CISTRAN001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all CIS transactions for the employer
`GET https://www.apizie.tech/v1/finance:payrun/get-cis-transactions-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the DPS message
`GET https://www.apizie.tech/v1/finance:payrun/get-dps-message-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| DpsMessageId | string | yes | The DPS message unique identifier. E.g. DPS001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Puts the DPS message
`POST https://www.apizie.tech/v1/finance:payrun/put-dps-message`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| DpsMessageId | string | yes | The DPS message unique identifier. E.g. DPS001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Patches the DPS message
`POST https://www.apizie.tech/v1/finance:payrun/patch-dps-message`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| DpsMessageId | string | yes | The DPS message unique identifier. E.g. DPS001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Deletes the DPS message
`POST https://www.apizie.tech/v1/finance:payrun/delete-dps-message`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| DpsMessageId | string | yes | The DPS message unique identifier. E.g. DPS001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the DPS messages
`GET https://www.apizie.tech/v1/finance:payrun/get-dps-messages-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Posta the DPS message
`POST https://www.apizie.tech/v1/finance:payrun/post-dps-message`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employee from employer
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Updates the Employee
`POST https://www.apizie.tech/v1/finance:payrun/put-employee-into-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Patches the employee
`POST https://www.apizie.tech/v1/finance:payrun/patch-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Delete an Employee
`POST https://www.apizie.tech/v1/finance:payrun/delete-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get the auto enrolment assessment
`GET https://www.apizie.tech/v1/finance:payrun/get-aeassessment-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| AEAssessmentId | string | yes | The auto enrolment assessment unique identifier. E.g. AE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert new auto enrolment assessment
`POST https://www.apizie.tech/v1/finance:payrun/put-new-aeassessment`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| AEAssessmentId | string | yes | The auto enrolment assessment unique identifier. E.g. AE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Delete auto enrolment assessment
`POST https://www.apizie.tech/v1/finance:payrun/delete-aeassessment`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| AEAssessmentId | string | yes | The auto enrolment assessment unique identifier. E.g. AE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get the auto enrolment assessments
`GET https://www.apizie.tech/v1/finance:payrun/get-aeassessments-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert new auto enrolment assessment
`POST https://www.apizie.tech/v1/finance:payrun/post-new-aeassessment`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Get links to all commentaries for the specified employee
`GET https://www.apizie.tech/v1/finance:payrun/get-commentaries-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get commentary from employee
`GET https://www.apizie.tech/v1/finance:payrun/get-commentary-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| CommentaryId | string | yes | The commentary unique identifier. E.g. C001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the journal Lines from the specified employee
`GET https://www.apizie.tech/v1/finance:payrun/get-journal-lines-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the specified pay instruction from the employee
`GET https://www.apizie.tech/v1/finance:payrun/get-pay-instruction-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayInstructionId | string | yes | The pay instruction unique identifier. E.g. SAL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Update a Pay Instruction
`POST https://www.apizie.tech/v1/finance:payrun/put-pay-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayInstructionId | string | yes | The pay instruction unique identifier. E.g. SAL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Sparse Update of a Pay Instruction
`POST https://www.apizie.tech/v1/finance:payrun/patch-pay-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayInstructionId | string | yes | The pay instruction unique identifier. E.g. SAL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Deletes a pay instruction
`POST https://www.apizie.tech/v1/finance:payrun/delete-pay-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayInstructionId | string | yes | The pay instruction unique identifier. E.g. SAL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get pay instruction tag
`GET https://www.apizie.tech/v1/finance:payrun/get-tag-from-pay-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayInstructionId | string | yes | The pay instruction unique identifier. E.g. SAL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert pay instruction tag
`POST https://www.apizie.tech/v1/finance:payrun/put-pay-instruction-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayInstructionId | string | yes | The pay instruction unique identifier. E.g. SAL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete pay instruction tag
`POST https://www.apizie.tech/v1/finance:payrun/delete-pay-instruction-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayInstructionId | string | yes | The pay instruction unique identifier. E.g. SAL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all tags from the pay instruction
`GET https://www.apizie.tech/v1/finance:payrun/get-tags-from-pay-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayInstructionId | string | yes | The pay instruction unique identifier. E.g. SAL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the pay instructions from the specified employee
`GET https://www.apizie.tech/v1/finance:payrun/get-pay-instructions-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Creates a new Pay Instruction
`POST https://www.apizie.tech/v1/finance:payrun/post-pay-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Get pay instructions with tag
`GET https://www.apizie.tech/v1/finance:payrun/get-pay-instructions-with-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all pay instruction tags
`GET https://www.apizie.tech/v1/finance:payrun/get-all-pay-instruction-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the specified pay line from the employee
`GET https://www.apizie.tech/v1/finance:payrun/get-pay-line-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayLineId | string | yes | The pay line unique identifier. E.g. PL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get pay line tag
`GET https://www.apizie.tech/v1/finance:payrun/get-tag-from-pay-line`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayLineId | string | yes | The pay line unique identifier. E.g. PL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert pay line tag
`POST https://www.apizie.tech/v1/finance:payrun/put-pay-line-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayLineId | string | yes | The pay line unique identifier. E.g. PL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete pay line tag
`POST https://www.apizie.tech/v1/finance:payrun/delete-pay-line-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayLineId | string | yes | The pay line unique identifier. E.g. PL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all tags from the pay line
`GET https://www.apizie.tech/v1/finance:payrun/get-tags-from-pay-line`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| PayLineId | string | yes | The pay line unique identifier. E.g. PL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the pay lines from the specified employee
`GET https://www.apizie.tech/v1/finance:payrun/get-pay-lines-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get pay lines with tag
`GET https://www.apizie.tech/v1/finance:payrun/get-pay-lines-with-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all pay line tags
`GET https://www.apizie.tech/v1/finance:payrun/get-all-pay-line-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the pay runs from the employee
`GET https://www.apizie.tech/v1/finance:payrun/get-pay-runs-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the employee by revision number
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-revision-by-number`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| RevisionNumber | string | yes | The revision number. E.g. 1 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete an Employee revision matching the specified revision number.
`POST https://www.apizie.tech/v1/finance:payrun/delete-employee-revision-by-number`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| RevisionNumber | string | yes | The revision number. E.g. 1 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the employee summary by revision number
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-revision-summary-by-number`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| RevisionNumber | string | yes | The revision number. E.g. 1 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all employee revisions
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-revisions`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all employee revision summaries
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-revision-summaries`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employee secret
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-secret`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| SecretId | string | yes | The secret unique identifier. E.g ERSEC001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Create a new employee secret
`POST https://www.apizie.tech/v1/finance:payrun/put-employee-secret`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| SecretId | string | yes | The secret unique identifier. E.g ERSEC001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Deletes employee secret
`POST https://www.apizie.tech/v1/finance:payrun/delete-employee-secret`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| SecretId | string | yes | The secret unique identifier. E.g ERSEC001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all employee secret links
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-secrets`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Create a new employee secret
`POST https://www.apizie.tech/v1/finance:payrun/post-employee-secret`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employee summary from employer
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-summary-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employee tag
`GET https://www.apizie.tech/v1/finance:payrun/get-tag-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert employee tag
`POST https://www.apizie.tech/v1/finance:payrun/put-employee-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete employee tag
`POST https://www.apizie.tech/v1/finance:payrun/delete-employee-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employee revision tag
`GET https://www.apizie.tech/v1/finance:payrun/get-tag-from-employee-revision`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all employee tags
`GET https://www.apizie.tech/v1/finance:payrun/get-tags-from-employee`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all employee revision tags
`GET https://www.apizie.tech/v1/finance:payrun/get-tags-from-employee-revision`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employee by effective date.
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-by-effective-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete an Employee revision matching the specified revision date.
`POST https://www.apizie.tech/v1/finance:payrun/delete-employee-revision`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employee summary by effective date.
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-summary-by-effective-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EmployeeId | string | yes | The employees' unique identifier. E.g EE001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employees from employer.
`GET https://www.apizie.tech/v1/finance:payrun/get-employees-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Create a new Employee
`POST https://www.apizie.tech/v1/finance:payrun/post-employee-into-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Get employee summaries from employer.
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-summaries-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employees with tag
`GET https://www.apizie.tech/v1/finance:payrun/get-employees-with-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all employee tags
`GET https://www.apizie.tech/v1/finance:payrun/get-all-employee-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employees from employer at a given effective date.
`GET https://www.apizie.tech/v1/finance:payrun/get-employees-by-effective-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get employee summaries from employer at a given effective date.
`GET https://www.apizie.tech/v1/finance:payrun/get-employee-summaries-by-effective-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get holiday scheme from employer
`GET https://www.apizie.tech/v1/finance:payrun/get-holiday-scheme-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Updates the holiday scheme
`POST https://www.apizie.tech/v1/finance:payrun/put-holiday-scheme-into-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Patches the holiday scheme
`POST https://www.apizie.tech/v1/finance:payrun/patch-holiday-scheme`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Delete an holiday scheme
`POST https://www.apizie.tech/v1/finance:payrun/delete-holiday-scheme`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the holiday scheme revision by revision number
`GET https://www.apizie.tech/v1/finance:payrun/get-holiday-scheme-revision-by-number`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| RevisionNumber | string | yes | The revision number. E.g. 1 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete an HolidayScheme revision matching the specified revision number.
`POST https://www.apizie.tech/v1/finance:payrun/delete-holiday-scheme-revision-by-number`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| RevisionNumber | string | yes | The revision number. E.g. 1 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all holiday scheme revisions
`GET https://www.apizie.tech/v1/finance:payrun/get-holiday-scheme-revisions`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get holiday scheme tag
`GET https://www.apizie.tech/v1/finance:payrun/get-tag-from-holiday-scheme`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert holiday scheme tag
`POST https://www.apizie.tech/v1/finance:payrun/put-holiday-scheme-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete holiday scheme tag
`POST https://www.apizie.tech/v1/finance:payrun/delete-holiday-scheme-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get holiday scheme revision tag
`GET https://www.apizie.tech/v1/finance:payrun/get-tag-from-holiday-scheme-revision`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all tags from the holiday scheme
`GET https://www.apizie.tech/v1/finance:payrun/get-tags-from-holiday-scheme`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all holiday scheme revision tags
`GET https://www.apizie.tech/v1/finance:payrun/get-tags-from-holiday-scheme-revision`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get holiday scheme by effective date.
`GET https://www.apizie.tech/v1/finance:payrun/get-holiday-scheme-by-effective-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete an holiday scheme revision matching the specified revision date.
`POST https://www.apizie.tech/v1/finance:payrun/delete-holiday-scheme-revision`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| HolidaySchemeId | string | yes | The holiday schemes' unique identifier. E.g HOLSCH001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get holiday schemes from employer.
`GET https://www.apizie.tech/v1/finance:payrun/get-holiday-schemes-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Create a new holiday scheme
`POST https://www.apizie.tech/v1/finance:payrun/post-holiday-scheme-into-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Get holiday schemes with tag
`GET https://www.apizie.tech/v1/finance:payrun/get-holiday-schemes-with-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all holiday scheme tags
`GET https://www.apizie.tech/v1/finance:payrun/get-all-holiday-scheme-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get holiday schemes from employer at a given effective date.
`GET https://www.apizie.tech/v1/finance:payrun/get-holiday-schemes-by-effective-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| EffectiveDate | string | yes | The effective date to be applied. E.g 2016-04-06 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the specified journal instruction from the employer
`GET https://www.apizie.tech/v1/finance:payrun/get-journal-instruction-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| JournalInstructionId | string | yes | The journal instruction unique identifier. E.g JI001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Update a Journal Instruction
`POST https://www.apizie.tech/v1/finance:payrun/put-journal-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| JournalInstructionId | string | yes | The journal instruction unique identifier. E.g JI001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Deletes a Journal instruction
`POST https://www.apizie.tech/v1/finance:payrun/delete-journal-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| JournalInstructionId | string | yes | The journal instruction unique identifier. E.g JI001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the Journal instructions from the specified employer
`GET https://www.apizie.tech/v1/finance:payrun/get-journal-instructions-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Creates a new Journal Instruction
`POST https://www.apizie.tech/v1/finance:payrun/post-journal-instruction`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the specified journal Line from the employer
`GET https://www.apizie.tech/v1/finance:payrun/get-journal-line-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| JournalLineId | string | yes | The journal line unique identifier. E.g JL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get journal line tag
`GET https://www.apizie.tech/v1/finance:payrun/get-tag-from-journal-line`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| JournalLineId | string | yes | The journal line unique identifier. E.g JL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert journal line tag
`POST https://www.apizie.tech/v1/finance:payrun/put-journal-line-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| JournalLineId | string | yes | The journal line unique identifier. E.g JL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Delete journal line tag
`POST https://www.apizie.tech/v1/finance:payrun/delete-journal-line-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| JournalLineId | string | yes | The journal line unique identifier. E.g JL001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get tags from journal line
`GET https://www.apizie.tech/v1/finance:payrun/get-tags-from-journal-line`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| JournalLineId | string | yes | The journal line unique identifier. E.g JL001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the Journal Lines from the specified employer
`GET https://www.apizie.tech/v1/finance:payrun/get-journal-lines-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get links to tagged journal lines
`GET https://www.apizie.tech/v1/finance:payrun/get-all-journal-lines-with-tag`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| TagId | string | yes | The tag unique identifier. E.g. MyTag |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Get all journal line tags
`GET https://www.apizie.tech/v1/finance:payrun/get-all-journal-line-tags`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Gets the nominal code
`GET https://www.apizie.tech/v1/finance:payrun/get-nominal-code-from-employer`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| NominalCodeId | string | yes | The nominal code unique identifier. E.g. NOM001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

### Insert nominal code
`POST https://www.apizie.tech/v1/finance:payrun/put-nominal-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| NominalCodeId | string | yes | The nominal code unique identifier. E.g. NOM001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |
| body | object | yes | JSON request body |

### Deletes the nominal codes
`POST https://www.apizie.tech/v1/finance:payrun/delete-nominal-code`

| Parameter | Type | Required | Description |
|---|---|---|---|
| EmployerId | string | yes | The employers' unique identifier. E.g ER001 |
| NominalCodeId | string | yes | The nominal code unique identifier. E.g. NOM001 |
| Api-Version | string | yes | The version of the api to target. Omit or set as 'default' to target the current api version. |

…and 270 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/finance:payrun/get-employer" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the PayRun.IO API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/finance:payrun/get-employer with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the PayRun.IO API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the PayRun.IO API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:payrun.

### What is the status of the PayRun.IO API?
Live: works with just an Apizie key