- Employer
- Delete an EmployerDELETE
- Gets the employerGET
- Patches the employerPATCH
- Updates the EmployerPUT
- Delete an Employer revision matching the specified revision number.DELETE
- Gets the employer by revision numberGET
- Gets the employer revisionsGET
- Deletes employer secretDELETE
- Get employer secretGET
- Create a new employer secretPUT
- Get all employer secret linksGET
- Create a new employer secretPOST
- Delete an Employer revision matching the specified revision date.DELETE
- Gets the employer at the specified effectiveGET
- Gets all employersGET
- Create a new EmployerPOST
- Gets all employers at the specified effective dateGET
- Delete an Employer
- CIS
- Delete an CIS line typeDELETE
- Get CIS line type from employerGET
- Updates the CIS line typePUT
- Get CIS line types from employer.GET
- Create a new CIS line typePOST
- Delete the CIS transactionDELETE
- Get the CIS transactionGET
- Get all CIS transactions for the employerGET
- Delete a CIS instructionDELETE
- Get CIS instruction from sub contractorGET
- Patches the CIS instructionPATCH
- Updates the CIS instructionPUT
- Get CIS instructions from sub contractor.GET
- Create a new CIS instructionPOST
- Delete a CIS lineDELETE
- Get CIS line from sub contractorGET
- Get CIS lines from sub contractor.GET
- Delete an CIS line type
- Tagging
- Delete CIS line type tag
- Get CIS line type tag
- Insert CIS line type tag
- Get all tags from the CIS line type
- Get CIS line types with tag
- Get all CIS line type tags
- Delete pay instruction tag
- Get pay instruction tag
- Insert pay instruction tag
- Get all tags from the pay instruction
- Get pay instructions with tag
- Get all pay instruction tags
- Delete pay line tag
- Get pay line tag
- Insert pay line tag
- Get all tags from the pay line
- Get pay lines with tag
- Get all pay line tags
- Delete employee tag
- Get employee tag
- Insert employee tag
- Get employee revision tag
- Get all employee tags
- Get all employee revision tags
- Get employees with tag
- Get all employee tags
- Delete holiday scheme tag
- Get holiday scheme tag
- Insert holiday scheme tag
- Get holiday scheme revision tag
- Get all tags from the holiday scheme
- Get all holiday scheme revision tags
- Get holiday schemes with tag
- Get all holiday scheme tags
- Delete journal line tag
- Get journal line tag
- Insert journal line tag
- Get tags from journal line
- Get links to tagged journal lines
- Get all journal line tags
- Delete pay code tag
- Get pay code tag
- Insert pay code tag
- Get all pay code tags
- Get pay codes with tag
- Get all pay code tags
- Delete pay run tag
- Get pay run tag
- Insert pay run tag
- Get all pay run tags
- Get pay runs with tag
- Get all pay run tags
- Delete pay schedule tag
- Get pay schedule tag
- Insert pay schedule tag
- Get all pay schedule tags
- Get pay schedule with tag
- Get all pay schedule tags
- Delete RTI transaction tag
- Get RTI transaction tag
- Insert RTI transaction tag
- Get all tags from RTI transaction
- Get RTI transactions with tag
- Get all RTI transaction tags
- Delete CIS instruction tag
- Get CIS instruction tag
- Insert CIS instruction tag
- Get all tags from the CIS instruction
- Get CIS instructions with tag
- Get all CIS instruction tags
- Delete CIS line tag
- Get CIS line tag
- Insert CIS line tag
- Get all tags from the CIS line
- Get CIS lines with tag
- Get all CIS line tags
- Delete sub contractor tag
- Get sub contractor tag
- Insert sub contractor tag
- Get sub contractor revision tag
- Get all tags from the sub contractor
- Get all sub contractor revision tags
- Get sub contractors with tag
- Get all sub contractor tags
- Delete employer tag
- Get employer tag
- Insert employer tag
- Get employer revision tag
- Get all employer tags
- Get all employer revision tags
- Delete third party transaction tag
- Get third party transaction tag
- insert third party transaction tag
- Get tags from third party transaction
- Get links to tagged third party transactions
- Get all third party transaction tags
- Get employers with tag
- Get all employer tags
- Delete user tag
- Get user tag
- Insert user tag
- Get tags from user
- Get links to tagged users
- Get all user tags
- DpsMessage
- Employee
- Delete an Employee
- Get employee from employer
- Patches the employee
- Updates the Employee
- Get links to all commentaries for the specified employee
- Get commentary from employee
- Delete an Employee revision matching the specified revision number.
- Gets the employee by revision number
- Get all employee revisions
- Deletes employee secret
- Get employee secret
- Create a new employee secret
- Get all employee secret links
- Create a new employee secret
- Delete an Employee revision matching the specified revision date.
- Get employee by effective date.
- Get employees from employer.
- Create a new Employee
- Get employees from employer at a given effective date.
- Get all employees revisions from a pay schedule.
- Get employees from a pay schedule on effective date.
- Get commentary from payrun by specified employee.
- Get employees from the pay run
- AEAssessment
- Journals
- Gets the journal Lines from the specified employee
- Deletes a Journal instruction
- Gets the specified journal instruction from the employer
- Update a Journal Instruction
- Gets the Journal instructions from the specified employer
- Creates a new Journal Instruction
- Gets the specified journal Line from the employer
- Gets the Journal Lines from the specified employer
- Gets the journal Lines from the specified pay run
- Gets the journal Lines from the specified sub contractor
- Deletes a Journal instruction template
- Gets the Journal instructions template for the application
- Update a Journal Instruction template
- Gets the Journal instructions templates for the application
- Creates a new Journal Instruction template
- PayInstruction
- PayLine
- PayRun
- HolidayScheme
- Delete an holiday scheme
- Get holiday scheme from employer
- Patches the holiday scheme
- Updates the holiday scheme
- Delete an HolidayScheme revision matching the specified revision number.
- Gets the holiday scheme revision by revision number
- Get all holiday scheme revisions
- Delete an holiday scheme revision matching the specified revision date.
- Get holiday scheme by effective date.
- Get holiday schemes from employer.
- Create a new holiday scheme
- Get holiday schemes from employer at a given effective date.
- NominalCode
- PayCode
- Gets the pay codes by nominal code
- Deletes a pay code
- Gets the specified pay code from the employer
- Patches the pay code
- Updates a pay code
- Delete an PayCode revision matching the specified revision number.
- Gets the pay code by revision number
- Get all revisions of the Pay Code
- Deletes a pay code revision
- Gets pay code for specified date
- Gets the pay codes from the employer
- Create a new pay code
- Gets all pay codes for specified date
- PaySchedule
- ReportLine
- Pension
- Delete a Pension
- Get pension from employer
- Patches the pension
- Updates the Pension
- Delete an Pension revision matching the specified revision number.
- Gets the pension by revision number
- Get all pension revisions
- Delete an Pension revision matching the specified revision date.
- Get pension by effective date.
- Get pensions from employer.
- Create a new Pension
- Get pensions from employer at a given effective date.
- ReportLineInstruction
- RTI
- SubContractor
- Delete an sub contractor
- Get sub contractor from employer
- Patches the sub contractor
- Updates the sub contractor
- Delete an SubContractor revision matching the specified revision number.
- Gets the sub contractor by revision number
- Get all sub contractor revisions
- Delete an sub contractor revision matching the specified revision date.
- Get sub contractor by effective date.
- Get sub contractors from employer.
- Create a new sub contractor
- Get sub contractors from employer at a given effective date.
- ThirdPartyTransmission
- Healthcheck
- Jobs
- Get all Batch jobs
- Create new Batch job
- Delete the Batch job
- Get the Batch job information
- Get the Batch job progress
- Get the Batch job status
- Get all CIS jobs
- Create new CIS job
- Delete the CIS job
- Get the CIS job information
- Get the CIS job progress
- Get the CIS job status
- Get all DPS jobs
- Create new DPS job
- Delete the DPS job
- Get the DPS job information
- Get the DPS job progress
- Get the DPS job status
- Gets all jobs relating to the employer.
- Get all PayRun jobs
- Create new PayRun job
- Delete the pay run job
- Get the pay run job information
- Get the pay run job progress
- Get the pay run job status
- Get all RTI jobs
- Create new RTI job
- Delete the RTI job
- Get the RTI job information
- Get the RTI job progress
- Get the RTI job status
- Get all Third Party jobs
- Create new Third Party job
- Delete the Third Party job
- Get the Third Party job information
- Get the Third Party job progress
- Get the Third Party job status
- Permission
- Query
- Reference
- Reports
- Runs the active pay instructions report
- Runs the AOE liability report
- Runs the DPS message report
- Runs the employer summary report
- Runs the gross to net report
- Runs the holiday balance report
- Runs the journal report
- Runs the last pay date report
- Runs the net pay report
- Runs the next pay period report
- Runs the P11 summary report
- Runs the P32 report
- Runs the P32 summary report
- Runs the P45 report
- Runs the P60 report
- Runs the PAPDIS report
- Runs the PASS report
- Runs the Pay Dashboard payslips report
- Runs the verbose payslip report
- Runs the pension liability report
- Deletes a report definition
- Get the report definition
- Updates a report definition
- Runs the specified report definition
- Gets all reports
- Create a new report definition
- Deletes a transform definition
- Get the transform definition
- Updates a transform definition
- Gets all transform definitions
- Create a new transform definition
- Schemas
- Templates
- User
- Schemas
- Schemas
- AEAssessment
- BatchItemBase
- BatchJobInstruction
- CisInstruction
- CisJobInstructionBase
- CisLine
- CisLineType
- CisTransaction
- Commentary
- DpsJobInstruction
- DpsMessage
- Employee
- EmployeeSecret
- Employer
- EmployerSecret
- ErrorModel
- HealthCheck
- HolidayScheme
- JobInfo
- JournalExpressionDataTable
- JournalInstruction
- JournalLine
- Link
- LinkCollection
- NominalCode
- PayCode
- PayInstruction
- PayLine
- PayRun
- PayRunJobInstruction
- PaySchedule
- Pension
- Permission
- Query
- ReportDefinition
- ReportLine
- ReportingInstruction
- RtiJobInstruction
- RtiTransactionBase
- SubContractor
- Tag
- ThirdPartyJobInstruction
- ThirdPartyTransaction
- TransformDefinition
- User
- Schemas
Get the query result
POST
/Query
Request
Header Params
Body Params application/json
Examples
Responses
🟢200The result of the query execution
application/json
Body
🟠400Bad Request
🟠401Unauthorized
🟠404Not Found
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.test.payrun.io/Query' \
--header 'Authorization;' \
--header 'Api-Version;' \
--header 'Content-Type: application/json' \
--data-raw '{
"Query": {
"ExcludeNullOrEmptyElements": true,
"Groups": {
"Group": [
{
"@GroupName": "string",
"@ItemName": "string",
"@LoopExpression": "string",
"@Selector": "string",
"@UniqueKeyVariable": "string",
"Condition": [
{
"@ValueA": "string",
"@ValueB": "string"
}
],
"Filter": [
{
"@Property": "string",
"@Value": "string"
}
],
"Order": [
{
"@Property": "string"
}
],
"Output": [
{
"@MaxLength": "string",
"@Output": "Element"
}
]
}
]
},
"RootNodeName": "string",
"SuppressMetricAttributes": true,
"Variables": {
"Variable": [
{
"@Name": "string",
"@Value": "string"
}
]
}
}
}'Response Response Example
200 - Example 1
"string"Modified at 2022-09-10 20:12:19