openapi-directory/api/payrun.io.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://api.test.payrun.io"}],"info":{"contact":{"x-twitter":"PayRun_io"},"description":"Open, scableable, transparent payroll API.","title":"PayRun.IO","version":"23.24.2.136","x-apisguru-categories":["financial"],"x-logo":{"url":"https://twitter.com/PayRun_io/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://api.test.payrun.io/swagger/json","version":"3.0"}],"x-providerName":"payrun.io"},"externalDocs":{"description":"External Documents","url":"https://developer.test.payrun.io/docs"},"paths":{"/Employer/{EmployerId}":{"delete":{"description":"Delete the specified employer","operationId":"DeleteEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete an Employer","tags":["Employer"]},"get":{"description":"Get the specified employer object","operationId":"GetEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employer"}}},"description":"The employer object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Gets the employer","tags":["Employer"]},"patch":{"description":"Patches the specified employer with the supplied values","operationId":"PatchEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Employer"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employer"}}},"description":"The employer object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Patches the employer","tags":["Employer"]},"put":{"description":"Updates the existing specified employer object","operationId":"PutEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Employer"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employer"}}},"description":"The employer object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Updates the Employer","tags":["Employer"]}},"/Employer/{EmployerId}/CisLineType/{CisLineTypeId}":{"delete":{"description":"Delete the specified CIS line type","operationId":"DeleteCisLineType","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS line type unique identifier. E.g. TYPEA","in":"path","name":"CisLineTypeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete an CIS line type","tags":["CIS"]},"get":{"description":"Gets the specified CIS line type from employer.","operationId":"GetCisLineTypeFromEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS line type unique identifier. E.g. TYPEA","in":"path","name":"CisLineTypeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CisLineType"}}},"description":"The cis line type object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get CIS line type from employer","tags":["CIS"]},"put":{"description":"Updates the existing specified CIS line type object","operationId":"PutCisLineTypeIntoEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS line type unique identifier. E.g. TYPEA","in":"path","name":"CisLineTypeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CisLineType"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CisLineType"}}},"description":"The cis line type object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Updates the CIS line type","tags":["CIS"]}},"/Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId}":{"delete":{"description":"Deletes a tag from the CIS line type","operationId":"DeleteCisLineTypeTag","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS line type unique identifier. E.g. TYPEA","in":"path","name":"CisLineTypeId","required":true,"schema":{"type":"string"}},{"description":"The tag unique identifier. E.g. MyTag","in":"path","name":"TagId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete CIS line type tag","tags":["Tagging","CIS"]},"get":{"description":"Gets the tag from the CIS line type","operationId":"GetTagFromCisLineType","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS line type unique identifier. E.g. TYPEA","in":"path","name":"CisLineTypeId","required":true,"schema":{"type":"string"}},{"description":"The tag unique identifier. E.g. MyTag","in":"path","name":"TagId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"The tag object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get CIS line type tag","tags":["Tagging","CIS"]},"put":{"description":"Inserts a new tag on the CIS line type","operationId":"PutCisLineTypeTag","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS line type unique identifier. E.g. TYPEA","in":"path","name":"CisLineTypeId","required":true,"schema":{"type":"string"}},{"description":"The tag unique identifier. E.g. MyTag","in":"path","name":"TagId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}},"description":"The tag object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Insert CIS line type tag","tags":["Tagging","CIS"]}},"/Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tags":{"get":{"description":"Gets all the tags from the CIS line type","operationId":"GetTagsFromCisLineType","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS line type unique identifier. E.g. TYPEA","in":"path","name":"CisLineTypeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCollection"}}},"description":"The link collection object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get all tags from the CIS line type","tags":["Tagging","CIS"]}},"/Employer/{EmployerId}/CisLineTypes":{"get":{"description":"Get links to all CIS line types for the specified employer.","operationId":"GetCisLineTypesFromEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCollection"}}},"description":"The link collection object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get CIS line types from employer.","tags":["CIS"]},"post":{"description":"Create a new CIS line type object","operationId":"PostCisLineTypeIntoEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CisLineType"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}},"description":"The link object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Create a new CIS line type","tags":["CIS"]}},"/Employer/{EmployerId}/CisLineTypes/Tag/{TagId}":{"get":{"description":"Gets the CIS line type with the tag","operationId":"GetCisLineTypesWithTag","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The tag unique identifier. E.g. MyTag","in":"path","name":"TagId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCollection"}}},"description":"The link collection object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get CIS line types with tag","tags":["Tagging","CIS"]}},"/Employer/{EmployerId}/CisLineTypes/Tags":{"get":{"description":"Gets all the CIS line type tags","operationId":"GetAllCisLineTypeTags","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCollection"}}},"description":"The link collection object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get all CIS line type tags","tags":["Tagging","CIS"]}},"/Employer/{EmployerId}/CisTransaction/{CisTransactionId}":{"delete":{"description":"Deletes the specified CIS transaction","operationId":"DeleteCisTransaction","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS transaction unique identifier. E.g. CISTRAN001","in":"path","name":"CisTransactionId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete the CIS transaction","tags":["CIS"]},"get":{"description":"Returns the specified CIS transaction","operationId":"GetCisTransactionFromEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The CIS transaction unique identifier. E.g. CISTRAN001","in":"path","name":"CisTransactionId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CisTransaction"}}},"description":"The cis transaction object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get the CIS transaction","tags":["CIS"]}},"/Employer/{EmployerId}/CisTransactions":{"get":{"description":"Get links for all CIS transactions for the specified employer","operationId":"GetCisTransactionsFromEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCollection"}}},"description":"The link collection object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get all CIS transactions for the employer","tags":["CIS"]}},"/Employer/{EmployerId}/DpsMessage/{DpsMessageId}":{"delete":{"description":"Deletes the DPS message","operationId":"DeleteDpsMessage","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The DPS message unique identifier. E.g. DPS001","in":"path","name":"DpsMessageId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Deletes the DPS message","tags":["DpsMessage"]},"get":{"description":"Gets the DPS message","operationId":"GetDpsMessageFromEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The DPS message unique identifier. E.g. DPS001","in":"path","name":"DpsMessageId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DpsMessage"}}},"description":"The dps message object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Gets the DPS message","tags":["DpsMessage"]},"patch":{"description":"Patches the specified DPS message with the supplied values","operationId":"PatchDpsMessage","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The DPS message unique identifier. E.g. DPS001","in":"path","name":"DpsMessageId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DpsMessage"}}},"description":"The dps message object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Patches the DPS message","tags":["DpsMessage"]},"put":{"description":"Puts the DPS message","operationId":"PutDpsMessage","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The DPS message unique identifier. E.g. DPS001","in":"path","name":"DpsMessageId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DpsMessage"}}},"description":"The dps message object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Puts the DPS message","tags":["DpsMessage"]}},"/Employer/{EmployerId}/DpsMessages":{"get":{"description":"Gets the DPS message links","operationId":"GetDpsMessagesFromEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCollection"}}},"description":"The link collection object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Gets the DPS messages","tags":["DpsMessage"]},"post":{"description":"Insert new DPS message","operationId":"PostDpsMessage","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}},"description":"The link object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Posta the DPS message","tags":["DpsMessage"]}},"/Employer/{EmployerId}/Employee/{EmployeeId}":{"delete":{"description":"Delete the specified employee","operationId":"DeleteEmployee","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The employees' unique identifier. E.g EE001","in":"path","name":"EmployeeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete an Employee","tags":["Employee"]},"get":{"description":"Gets the specified employee from employer by employee code.","operationId":"GetEmployeeFromEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The employees' unique identifier. E.g EE001","in":"path","name":"EmployeeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}},"description":"The employee object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get employee from employer","tags":["Employee"]},"patch":{"description":"Patches the specified employee with the supplied values","operationId":"PatchEmployee","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The employees' unique identifier. E.g EE001","in":"path","name":"EmployeeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Employee"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}},"description":"The employee object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Patches the employee","tags":["Employee"]},"put":{"description":"Updates the existing specified employee object","operationId":"PutEmployeeIntoEmployer","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The employees' unique identifier. E.g EE001","in":"path","name":"EmployeeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Employee"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Employee"}}},"description":"The employee object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Updates the Employee","tags":["Employee"]}},"/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}":{"delete":{"description":"Deletes an existing auto enrolment assessment for the employee. Used to remove historical assessments","operationId":"DeleteAEAssessment","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The employees' unique identifier. E.g EE001","in":"path","name":"EmployeeId","required":true,"schema":{"type":"string"}},{"description":"The auto enrolment assessment unique identifier. E.g. AE001","in":"path","name":"AEAssessmentId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Delete auto enrolment assessment","tags":["AEAssessment"]},"get":{"description":"Gets the auto enrolment assessment from the specified employee","operationId":"GetAEAssessmentFromEmployee","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The employees' unique identifier. E.g EE001","in":"path","name":"EmployeeId","required":true,"schema":{"type":"string"}},{"description":"The auto enrolment assessment unique identifier. E.g. AE001","in":"path","name":"AEAssessmentId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AEAssessment"}}},"description":"The a e assessment object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get the auto enrolment assessment","tags":["AEAssessment","Employee"]},"put":{"description":"Creates a new auto enrolment assessment for the employee. Used to insert historical assessments","operationId":"PutNewAEAssessment","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The employees' unique identifier. E.g EE001","in":"path","name":"EmployeeId","required":true,"schema":{"type":"string"}},{"description":"The auto enrolment assessment unique identifier. E.g. AE001","in":"path","name":"AEAssessmentId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/AEAssessment"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AEAssessment"}}},"description":"The a e assessment object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Insert new auto enrolment assessment","tags":["AEAssessment"]}},"/Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments":{"get":{"description":"Gets all auto enrolment assessments from the specified employee","operationId":"GetAEAssessmentsFromEmployee","parameters":[{"description":"The employers' unique identifier. E.g ER001","in":"path","name":"EmployerId","required":true,"schema":{"type":"string"}},{"description":"The employees' unique identifier. E.g EE001","in":"path","name":"EmployeeId","required":true,"schema":{"type":"string"}},{"description":"The OAuth 1 authorization header. 'Auto' enables auto complete.","in":"header","name":"Authorization","required":true,"schema":{"default":"Auto","format":"string","type":"string"}},{"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","in":"header","name":"Api-Version","required":true,"schema":{"default":"default","format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkCollection"}}},"description":"The link collection object."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}},"description":"Internal Server Error"}},"summary":"Get the auto enrolment assessments","tags":["AEAssessment","Employee"]},"post":{"description":"Creates a new auto enrolment assessment for the employee.