{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:payrun/get-employer":{"get":{"operationId":"finance_payrun_get_employer","summary":"Gets the employer","description":"GET /Employer/{EmployerId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-employer":{"post":{"operationId":"finance_payrun_put_employer","summary":"Updates the Employer","description":"PUT /Employer/{EmployerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-employer":{"post":{"operationId":"finance_payrun_patch_employer","summary":"Patches the employer","description":"PATCH /Employer/{EmployerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employer":{"post":{"operationId":"finance_payrun_delete_employer","summary":"Delete an Employer","description":"DELETE /Employer/{EmployerId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-line-type-from-employer":{"get":{"operationId":"finance_payrun_get_cis_line_type_from_employer","summary":"Get CIS line type from employer","description":"GET /Employer/{EmployerId}/CisLineType/{CisLineTypeId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"CisLineTypeId","in":"query","required":true,"description":"The CIS line type unique identifier. E.g. TYPEA","schema":{"type":"string","description":"The CIS line type unique identifier. E.g. TYPEA"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-cis-line-type-into-employer":{"post":{"operationId":"finance_payrun_put_cis_line_type_into_employer","summary":"Updates the CIS line type","description":"PUT /Employer/{EmployerId}/CisLineType/{CisLineTypeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","CisLineTypeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"CisLineTypeId":{"type":"string","description":"The CIS line type unique identifier. E.g. TYPEA"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-cis-line-type":{"post":{"operationId":"finance_payrun_delete_cis_line_type","summary":"Delete an CIS line type","description":"DELETE /Employer/{EmployerId}/CisLineType/{CisLineTypeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","CisLineTypeId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"CisLineTypeId":{"type":"string","description":"The CIS line type unique identifier. E.g. TYPEA"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-cis-line-type":{"get":{"operationId":"finance_payrun_get_tag_from_cis_line_type","summary":"Get CIS line type tag","description":"GET /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"CisLineTypeId","in":"query","required":true,"description":"The CIS line type unique identifier. E.g. TYPEA","schema":{"type":"string","description":"The CIS line type unique identifier. E.g. TYPEA"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-cis-line-type-tag":{"post":{"operationId":"finance_payrun_put_cis_line_type_tag","summary":"Insert CIS line type tag","description":"PUT /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","CisLineTypeId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"CisLineTypeId":{"type":"string","description":"The CIS line type unique identifier. E.g. TYPEA"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-cis-line-type-tag":{"post":{"operationId":"finance_payrun_delete_cis_line_type_tag","summary":"Delete CIS line type tag","description":"DELETE /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","CisLineTypeId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"CisLineTypeId":{"type":"string","description":"The CIS line type unique identifier. E.g. TYPEA"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-cis-line-type":{"get":{"operationId":"finance_payrun_get_tags_from_cis_line_type","summary":"Get all tags from the CIS line type","description":"GET /Employer/{EmployerId}/CisLineType/{CisLineTypeId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"CisLineTypeId","in":"query","required":true,"description":"The CIS line type unique identifier. E.g. TYPEA","schema":{"type":"string","description":"The CIS line type unique identifier. E.g. TYPEA"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-line-types-from-employer":{"get":{"operationId":"finance_payrun_get_cis_line_types_from_employer","summary":"Get CIS line types from employer.","description":"GET /Employer/{EmployerId}/CisLineTypes","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-cis-line-type-into-employer":{"post":{"operationId":"finance_payrun_post_cis_line_type_into_employer","summary":"Create a new CIS line type","description":"POST /Employer/{EmployerId}/CisLineTypes","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-line-types-with-tag":{"get":{"operationId":"finance_payrun_get_cis_line_types_with_tag","summary":"Get CIS line types with tag","description":"GET /Employer/{EmployerId}/CisLineTypes/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-cis-line-type-tags":{"get":{"operationId":"finance_payrun_get_all_cis_line_type_tags","summary":"Get all CIS line type tags","description":"GET /Employer/{EmployerId}/CisLineTypes/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-transaction-from-employer":{"get":{"operationId":"finance_payrun_get_cis_transaction_from_employer","summary":"Get the CIS transaction","description":"GET /Employer/{EmployerId}/CisTransaction/{CisTransactionId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"CisTransactionId","in":"query","required":true,"description":"The CIS transaction unique identifier. E.g. CISTRAN001","schema":{"type":"string","description":"The CIS transaction unique identifier. E.g. CISTRAN001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-cis-transaction":{"post":{"operationId":"finance_payrun_delete_cis_transaction","summary":"Delete the CIS transaction","description":"DELETE /Employer/{EmployerId}/CisTransaction/{CisTransactionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","CisTransactionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"CisTransactionId":{"type":"string","description":"The CIS transaction unique identifier. E.g. CISTRAN001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-transactions-from-employer":{"get":{"operationId":"finance_payrun_get_cis_transactions_from_employer","summary":"Get all CIS transactions for the employer","description":"GET /Employer/{EmployerId}/CisTransactions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-dps-message-from-employer":{"get":{"operationId":"finance_payrun_get_dps_message_from_employer","summary":"Gets the DPS message","description":"GET /Employer/{EmployerId}/DpsMessage/{DpsMessageId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"DpsMessageId","in":"query","required":true,"description":"The DPS message unique identifier. E.g. DPS001","schema":{"type":"string","description":"The DPS message unique identifier. E.g. DPS001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-dps-message":{"post":{"operationId":"finance_payrun_put_dps_message","summary":"Puts the DPS message","description":"PUT /Employer/{EmployerId}/DpsMessage/{DpsMessageId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","DpsMessageId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"DpsMessageId":{"type":"string","description":"The DPS message unique identifier. E.g. DPS001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-dps-message":{"post":{"operationId":"finance_payrun_patch_dps_message","summary":"Patches the DPS message","description":"PATCH /Employer/{EmployerId}/DpsMessage/{DpsMessageId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","DpsMessageId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"DpsMessageId":{"type":"string","description":"The DPS message unique identifier. E.g. DPS001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-dps-message":{"post":{"operationId":"finance_payrun_delete_dps_message","summary":"Deletes the DPS message","description":"DELETE /Employer/{EmployerId}/DpsMessage/{DpsMessageId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","DpsMessageId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"DpsMessageId":{"type":"string","description":"The DPS message unique identifier. E.g. DPS001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-dps-messages-from-employer":{"get":{"operationId":"finance_payrun_get_dps_messages_from_employer","summary":"Gets the DPS messages","description":"GET /Employer/{EmployerId}/DpsMessages","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-dps-message":{"post":{"operationId":"finance_payrun_post_dps_message","summary":"Posta the DPS message","description":"POST /Employer/{EmployerId}/DpsMessages","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-from-employer":{"get":{"operationId":"finance_payrun_get_employee_from_employer","summary":"Get employee from employer","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-employee-into-employer":{"post":{"operationId":"finance_payrun_put_employee_into_employer","summary":"Updates the Employee","description":"PUT /Employer/{EmployerId}/Employee/{EmployeeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-employee":{"post":{"operationId":"finance_payrun_patch_employee","summary":"Patches the employee","description":"PATCH /Employer/{EmployerId}/Employee/{EmployeeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employee":{"post":{"operationId":"finance_payrun_delete_employee","summary":"Delete an Employee","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-aeassessment-from-employee":{"get":{"operationId":"finance_payrun_get_aeassessment_from_employee","summary":"Get the auto enrolment assessment","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"AEAssessmentId","in":"query","required":true,"description":"The auto enrolment assessment unique identifier. E.g. AE001","schema":{"type":"string","description":"The auto enrolment assessment unique identifier. E.g. AE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-new-aeassessment":{"post":{"operationId":"finance_payrun_put_new_aeassessment","summary":"Insert new auto enrolment assessment","description":"PUT /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","AEAssessmentId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"AEAssessmentId":{"type":"string","description":"The auto enrolment assessment unique identifier. E.g. AE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-aeassessment":{"post":{"operationId":"finance_payrun_delete_aeassessment","summary":"Delete auto enrolment assessment","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessment/{AEAssessmentId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","AEAssessmentId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"AEAssessmentId":{"type":"string","description":"The auto enrolment assessment unique identifier. E.g. AE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-aeassessments-from-employee":{"get":{"operationId":"finance_payrun_get_aeassessments_from_employee","summary":"Get the auto enrolment assessments","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-new-aeassessment":{"post":{"operationId":"finance_payrun_post_new_aeassessment","summary":"Insert new auto enrolment assessment","description":"POST /Employer/{EmployerId}/Employee/{EmployeeId}/AEAssessments","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-commentaries-from-employee":{"get":{"operationId":"finance_payrun_get_commentaries_from_employee","summary":"Get links to all commentaries for the specified employee","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Commentaries","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-commentary-from-employee":{"get":{"operationId":"finance_payrun_get_commentary_from_employee","summary":"Get commentary from employee","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Commentary/{CommentaryId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"CommentaryId","in":"query","required":true,"description":"The commentary unique identifier. E.g. C001","schema":{"type":"string","description":"The commentary unique identifier. E.g. C001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-lines-from-employee":{"get":{"operationId":"finance_payrun_get_journal_lines_from_employee","summary":"Gets the journal Lines from the specified employee","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/JournalLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-instruction-from-employee":{"get":{"operationId":"finance_payrun_get_pay_instruction_from_employee","summary":"Gets the specified pay instruction from the employee","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"PayInstructionId","in":"query","required":true,"description":"The pay instruction unique identifier. E.g. SAL001","schema":{"type":"string","description":"The pay instruction unique identifier. E.g. SAL001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pay-instruction":{"post":{"operationId":"finance_payrun_put_pay_instruction","summary":"Update a Pay Instruction","description":"PUT /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","PayInstructionId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"PayInstructionId":{"type":"string","description":"The pay instruction unique identifier. E.g. SAL001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-pay-instruction":{"post":{"operationId":"finance_payrun_patch_pay_instruction","summary":"Sparse Update of a Pay Instruction","description":"PATCH /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","PayInstructionId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"PayInstructionId":{"type":"string","description":"The pay instruction unique identifier. E.g. SAL001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-instruction":{"post":{"operationId":"finance_payrun_delete_pay_instruction","summary":"Deletes a pay instruction","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","PayInstructionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"PayInstructionId":{"type":"string","description":"The pay instruction unique identifier. E.g. SAL001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-pay-instruction":{"get":{"operationId":"finance_payrun_get_tag_from_pay_instruction","summary":"Get pay instruction tag","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"PayInstructionId","in":"query","required":true,"description":"The pay instruction unique identifier. E.g. SAL001","schema":{"type":"string","description":"The pay instruction unique identifier. E.g. SAL001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pay-instruction-tag":{"post":{"operationId":"finance_payrun_put_pay_instruction_tag","summary":"Insert pay instruction tag","description":"PUT /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","PayInstructionId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"PayInstructionId":{"type":"string","description":"The pay instruction unique identifier. E.g. SAL001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-instruction-tag":{"post":{"operationId":"finance_payrun_delete_pay_instruction_tag","summary":"Delete pay instruction tag","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","PayInstructionId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"PayInstructionId":{"type":"string","description":"The pay instruction unique identifier. E.g. SAL001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-pay-instruction":{"get":{"operationId":"finance_payrun_get_tags_from_pay_instruction","summary":"Get all tags from the pay instruction","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstruction/{PayInstructionId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"PayInstructionId","in":"query","required":true,"description":"The pay instruction unique identifier. E.g. SAL001","schema":{"type":"string","description":"The pay instruction unique identifier. E.g. SAL001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-instructions-from-employee":{"get":{"operationId":"finance_payrun_get_pay_instructions_from_employee","summary":"Gets the pay instructions from the specified employee","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-pay-instruction":{"post":{"operationId":"finance_payrun_post_pay_instruction","summary":"Creates a new Pay Instruction","description":"POST /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-instructions-with-tag":{"get":{"operationId":"finance_payrun_get_pay_instructions_with_tag","summary":"Get pay instructions with tag","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-pay-instruction-tags":{"get":{"operationId":"finance_payrun_get_all_pay_instruction_tags","summary":"Get all pay instruction tags","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayInstructions/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-line-from-employee":{"get":{"operationId":"finance_payrun_get_pay_line_from_employee","summary":"Gets the specified pay line from the employee","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"PayLineId","in":"query","required":true,"description":"The pay line unique identifier. E.g. PL001","schema":{"type":"string","description":"The pay line unique identifier. E.g. PL001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-pay-line":{"get":{"operationId":"finance_payrun_get_tag_from_pay_line","summary":"Get pay line tag","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"PayLineId","in":"query","required":true,"description":"The pay line unique identifier. E.g. PL001","schema":{"type":"string","description":"The pay line unique identifier. E.g. PL001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pay-line-tag":{"post":{"operationId":"finance_payrun_put_pay_line_tag","summary":"Insert pay line tag","description":"PUT /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","PayLineId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"PayLineId":{"type":"string","description":"The pay line unique identifier. E.g. PL001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-line-tag":{"post":{"operationId":"finance_payrun_delete_pay_line_tag","summary":"Delete pay line tag","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","PayLineId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"PayLineId":{"type":"string","description":"The pay line unique identifier. E.g. PL001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-pay-line":{"get":{"operationId":"finance_payrun_get_tags_from_pay_line","summary":"Get all tags from the pay line","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLine/{PayLineId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"PayLineId","in":"query","required":true,"description":"The pay line unique identifier. E.g. PL001","schema":{"type":"string","description":"The pay line unique identifier. E.g. PL001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-lines-from-employee":{"get":{"operationId":"finance_payrun_get_pay_lines_from_employee","summary":"Gets the pay lines from the specified employee","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-lines-with-tag":{"get":{"operationId":"finance_payrun_get_pay_lines_with_tag","summary":"Get pay lines with tag","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLines/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-pay-line-tags":{"get":{"operationId":"finance_payrun_get_all_pay_line_tags","summary":"Get all pay line tags","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayLines/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-runs-from-employee":{"get":{"operationId":"finance_payrun_get_pay_runs_from_employee","summary":"Gets the pay runs from the employee","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/PayRuns","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-revision-by-number":{"get":{"operationId":"finance_payrun_get_employee_revision_by_number","summary":"Gets the employee by revision number","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"RevisionNumber","in":"query","required":true,"description":"The revision number. E.g. 1","schema":{"type":"string","description":"The revision number. E.g. 1"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employee-revision-by-number":{"post":{"operationId":"finance_payrun_delete_employee_revision_by_number","summary":"Delete an Employee revision matching the specified revision number.","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","RevisionNumber","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"RevisionNumber":{"type":"string","description":"The revision number. E.g. 1"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-revision-summary-by-number":{"get":{"operationId":"finance_payrun_get_employee_revision_summary_by_number","summary":"Gets the employee summary by revision number","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Revision/{RevisionNumber}/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"RevisionNumber","in":"query","required":true,"description":"The revision number. E.g. 1","schema":{"type":"string","description":"The revision number. E.g. 1"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-revisions":{"get":{"operationId":"finance_payrun_get_employee_revisions","summary":"Get all employee revisions","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Revisions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-revision-summaries":{"get":{"operationId":"finance_payrun_get_employee_revision_summaries","summary":"Get all employee revision summaries","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Revisions/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-secret":{"get":{"operationId":"finance_payrun_get_employee_secret","summary":"Get employee secret","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"SecretId","in":"query","required":true,"description":"The secret unique identifier. E.g ERSEC001","schema":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-employee-secret":{"post":{"operationId":"finance_payrun_put_employee_secret","summary":"Create a new employee secret","description":"PUT /Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","SecretId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"SecretId":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employee-secret":{"post":{"operationId":"finance_payrun_delete_employee_secret","summary":"Deletes employee secret","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}/Secret/{SecretId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","SecretId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"SecretId":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-secrets":{"get":{"operationId":"finance_payrun_get_employee_secrets","summary":"Get all employee secret links","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Secrets","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-employee-secret":{"post":{"operationId":"finance_payrun_post_employee_secret","summary":"Create a new employee secret","description":"POST /Employer/{EmployerId}/Employee/{EmployeeId}/Secrets","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-summary-from-employer":{"get":{"operationId":"finance_payrun_get_employee_summary_from_employer","summary":"Get employee summary from employer","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-employee":{"get":{"operationId":"finance_payrun_get_tag_from_employee","summary":"Get employee tag","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-employee-tag":{"post":{"operationId":"finance_payrun_put_employee_tag","summary":"Insert employee tag","description":"PUT /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employee-tag":{"post":{"operationId":"finance_payrun_delete_employee_tag","summary":"Delete employee tag","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-employee-revision":{"get":{"operationId":"finance_payrun_get_tag_from_employee_revision","summary":"Get employee revision tag","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Tag/{TagId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-employee":{"get":{"operationId":"finance_payrun_get_tags_from_employee","summary":"Get all employee tags","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-employee-revision":{"get":{"operationId":"finance_payrun_get_tags_from_employee_revision","summary":"Get all employee revision tags","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/Tags/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-by-effective-date":{"get":{"operationId":"finance_payrun_get_employee_by_effective_date","summary":"Get employee by effective date.","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employee-revision":{"post":{"operationId":"finance_payrun_delete_employee_revision","summary":"Delete an Employee revision matching the specified revision date.","description":"DELETE /Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EmployeeId","EffectiveDate","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"EffectiveDate":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-summary-by-effective-date":{"get":{"operationId":"finance_payrun_get_employee_summary_by_effective_date","summary":"Get employee summary by effective date.","description":"GET /Employer/{EmployerId}/Employee/{EmployeeId}/{EffectiveDate}/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employees-from-employer":{"get":{"operationId":"finance_payrun_get_employees_from_employer","summary":"Get employees from employer.","description":"GET /Employer/{EmployerId}/Employees","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-employee-into-employer":{"post":{"operationId":"finance_payrun_post_employee_into_employer","summary":"Create a new Employee","description":"POST /Employer/{EmployerId}/Employees","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-summaries-from-employer":{"get":{"operationId":"finance_payrun_get_employee_summaries_from_employer","summary":"Get employee summaries from employer.","description":"GET /Employer/{EmployerId}/Employees/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employees-with-tag":{"get":{"operationId":"finance_payrun_get_employees_with_tag","summary":"Get employees with tag","description":"GET /Employer/{EmployerId}/Employees/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-employee-tags":{"get":{"operationId":"finance_payrun_get_all_employee_tags","summary":"Get all employee tags","description":"GET /Employer/{EmployerId}/Employees/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employees-by-effective-date":{"get":{"operationId":"finance_payrun_get_employees_by_effective_date","summary":"Get employees from employer at a given effective date.","description":"GET /Employer/{EmployerId}/Employees/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employee-summaries-by-effective-date":{"get":{"operationId":"finance_payrun_get_employee_summaries_by_effective_date","summary":"Get employee summaries from employer at a given effective date.","description":"GET /Employer/{EmployerId}/Employees/{EffectiveDate}/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-holiday-scheme-from-employer":{"get":{"operationId":"finance_payrun_get_holiday_scheme_from_employer","summary":"Get holiday scheme from employer","description":"GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"HolidaySchemeId","in":"query","required":true,"description":"The holiday schemes' unique identifier. E.g HOLSCH001","schema":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-holiday-scheme-into-employer":{"post":{"operationId":"finance_payrun_put_holiday_scheme_into_employer","summary":"Updates the holiday scheme","description":"PUT /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","HolidaySchemeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"HolidaySchemeId":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-holiday-scheme":{"post":{"operationId":"finance_payrun_patch_holiday_scheme","summary":"Patches the holiday scheme","description":"PATCH /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","HolidaySchemeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"HolidaySchemeId":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-holiday-scheme":{"post":{"operationId":"finance_payrun_delete_holiday_scheme","summary":"Delete an holiday scheme","description":"DELETE /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","HolidaySchemeId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"HolidaySchemeId":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-holiday-scheme-revision-by-number":{"get":{"operationId":"finance_payrun_get_holiday_scheme_revision_by_number","summary":"Gets the holiday scheme revision by revision number","description":"GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"HolidaySchemeId","in":"query","required":true,"description":"The holiday schemes' unique identifier. E.g HOLSCH001","schema":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"}},{"name":"RevisionNumber","in":"query","required":true,"description":"The revision number. E.g. 1","schema":{"type":"string","description":"The revision number. E.g. 1"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-holiday-scheme-revision-by-number":{"post":{"operationId":"finance_payrun_delete_holiday_scheme_revision_by_number","summary":"Delete an HolidayScheme revision matching the specified revision number.","description":"DELETE /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","HolidaySchemeId","RevisionNumber","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"HolidaySchemeId":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"},"RevisionNumber":{"type":"string","description":"The revision number. E.g. 1"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-holiday-scheme-revisions":{"get":{"operationId":"finance_payrun_get_holiday_scheme_revisions","summary":"Get all holiday scheme revisions","description":"GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Revisions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"HolidaySchemeId","in":"query","required":true,"description":"The holiday schemes' unique identifier. E.g HOLSCH001","schema":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-holiday-scheme":{"get":{"operationId":"finance_payrun_get_tag_from_holiday_scheme","summary":"Get holiday scheme tag","description":"GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"HolidaySchemeId","in":"query","required":true,"description":"The holiday schemes' unique identifier. E.g HOLSCH001","schema":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-holiday-scheme-tag":{"post":{"operationId":"finance_payrun_put_holiday_scheme_tag","summary":"Insert holiday scheme tag","description":"PUT /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","HolidaySchemeId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"HolidaySchemeId":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-holiday-scheme-tag":{"post":{"operationId":"finance_payrun_delete_holiday_scheme_tag","summary":"Delete holiday scheme tag","description":"DELETE /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","HolidaySchemeId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"HolidaySchemeId":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-holiday-scheme-revision":{"get":{"operationId":"finance_payrun_get_tag_from_holiday_scheme_revision","summary":"Get holiday scheme revision tag","description":"GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tag/{TagId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"HolidaySchemeId","in":"query","required":true,"description":"The holiday schemes' unique identifier. E.g HOLSCH001","schema":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-holiday-scheme":{"get":{"operationId":"finance_payrun_get_tags_from_holiday_scheme","summary":"Get all tags from the holiday scheme","description":"GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"HolidaySchemeId","in":"query","required":true,"description":"The holiday schemes' unique identifier. E.g HOLSCH001","schema":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-holiday-scheme-revision":{"get":{"operationId":"finance_payrun_get_tags_from_holiday_scheme_revision","summary":"Get all holiday scheme revision tags","description":"GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/Tags/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"HolidaySchemeId","in":"query","required":true,"description":"The holiday schemes' unique identifier. E.g HOLSCH001","schema":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-holiday-scheme-by-effective-date":{"get":{"operationId":"finance_payrun_get_holiday_scheme_by_effective_date","summary":"Get holiday scheme by effective date.","description":"GET /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"HolidaySchemeId","in":"query","required":true,"description":"The holiday schemes' unique identifier. E.g HOLSCH001","schema":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-holiday-scheme-revision":{"post":{"operationId":"finance_payrun_delete_holiday_scheme_revision","summary":"Delete an holiday scheme revision matching the specified revision date.","description":"DELETE /Employer/{EmployerId}/HolidayScheme/{HolidaySchemeId}/{EffectiveDate}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","HolidaySchemeId","EffectiveDate","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"HolidaySchemeId":{"type":"string","description":"The holiday schemes' unique identifier. E.g HOLSCH001"},"EffectiveDate":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-holiday-schemes-from-employer":{"get":{"operationId":"finance_payrun_get_holiday_schemes_from_employer","summary":"Get holiday schemes from employer.","description":"GET /Employer/{EmployerId}/HolidaySchemes","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-holiday-scheme-into-employer":{"post":{"operationId":"finance_payrun_post_holiday_scheme_into_employer","summary":"Create a new holiday scheme","description":"POST /Employer/{EmployerId}/HolidaySchemes","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-holiday-schemes-with-tag":{"get":{"operationId":"finance_payrun_get_holiday_schemes_with_tag","summary":"Get holiday schemes with tag","description":"GET /Employer/{EmployerId}/HolidaySchemes/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-holiday-scheme-tags":{"get":{"operationId":"finance_payrun_get_all_holiday_scheme_tags","summary":"Get all holiday scheme tags","description":"GET /Employer/{EmployerId}/HolidaySchemes/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-holiday-schemes-by-effective-date":{"get":{"operationId":"finance_payrun_get_holiday_schemes_by_effective_date","summary":"Get holiday schemes from employer at a given effective date.","description":"GET /Employer/{EmployerId}/HolidaySchemes/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-instruction-from-employer":{"get":{"operationId":"finance_payrun_get_journal_instruction_from_employer","summary":"Gets the specified journal instruction from the employer","description":"GET /Employer/{EmployerId}/JournalInstruction/{JournalInstructionId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"JournalInstructionId","in":"query","required":true,"description":"The journal instruction unique identifier. E.g JI001","schema":{"type":"string","description":"The journal instruction unique identifier. E.g JI001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-journal-instruction":{"post":{"operationId":"finance_payrun_put_journal_instruction","summary":"Update a Journal Instruction","description":"PUT /Employer/{EmployerId}/JournalInstruction/{JournalInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","JournalInstructionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"JournalInstructionId":{"type":"string","description":"The journal instruction unique identifier. E.g JI001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-journal-instruction":{"post":{"operationId":"finance_payrun_delete_journal_instruction","summary":"Deletes a Journal instruction","description":"DELETE /Employer/{EmployerId}/JournalInstruction/{JournalInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","JournalInstructionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"JournalInstructionId":{"type":"string","description":"The journal instruction unique identifier. E.g JI001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-instructions-from-employer":{"get":{"operationId":"finance_payrun_get_journal_instructions_from_employer","summary":"Gets the Journal instructions from the specified employer","description":"GET /Employer/{EmployerId}/JournalInstructions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-journal-instruction":{"post":{"operationId":"finance_payrun_post_journal_instruction","summary":"Creates a new Journal Instruction","description":"POST /Employer/{EmployerId}/JournalInstructions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-line-from-employer":{"get":{"operationId":"finance_payrun_get_journal_line_from_employer","summary":"Gets the specified journal Line from the employer","description":"GET /Employer/{EmployerId}/JournalLine/{JournalLineId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"JournalLineId","in":"query","required":true,"description":"The journal line unique identifier. E.g JL001","schema":{"type":"string","description":"The journal line unique identifier. E.g JL001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-journal-line":{"get":{"operationId":"finance_payrun_get_tag_from_journal_line","summary":"Get journal line tag","description":"GET /Employer/{EmployerId}/JournalLine/{JournalLineId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"JournalLineId","in":"query","required":true,"description":"The journal line unique identifier. E.g JL001","schema":{"type":"string","description":"The journal line unique identifier. E.g JL001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-journal-line-tag":{"post":{"operationId":"finance_payrun_put_journal_line_tag","summary":"Insert journal line tag","description":"PUT /Employer/{EmployerId}/JournalLine/{JournalLineId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","JournalLineId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"JournalLineId":{"type":"string","description":"The journal line unique identifier. E.g JL001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-journal-line-tag":{"post":{"operationId":"finance_payrun_delete_journal_line_tag","summary":"Delete journal line tag","description":"DELETE /Employer/{EmployerId}/JournalLine/{JournalLineId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","JournalLineId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"JournalLineId":{"type":"string","description":"The journal line unique identifier. E.g JL001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-journal-line":{"get":{"operationId":"finance_payrun_get_tags_from_journal_line","summary":"Get tags from journal line","description":"GET /Employer/{EmployerId}/JournalLine/{JournalLineId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"JournalLineId","in":"query","required":true,"description":"The journal line unique identifier. E.g JL001","schema":{"type":"string","description":"The journal line unique identifier. E.g JL001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-lines-from-employer":{"get":{"operationId":"finance_payrun_get_journal_lines_from_employer","summary":"Gets the Journal Lines from the specified employer","description":"GET /Employer/{EmployerId}/JournalLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-journal-lines-with-tag":{"get":{"operationId":"finance_payrun_get_all_journal_lines_with_tag","summary":"Get links to tagged journal lines","description":"GET /Employer/{EmployerId}/JournalLines/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-journal-line-tags":{"get":{"operationId":"finance_payrun_get_all_journal_line_tags","summary":"Get all journal line tags","description":"GET /Employer/{EmployerId}/JournalLines/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-nominal-code-from-employer":{"get":{"operationId":"finance_payrun_get_nominal_code_from_employer","summary":"Gets the nominal code","description":"GET /Employer/{EmployerId}/NominalCode/{NominalCodeId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"NominalCodeId","in":"query","required":true,"description":"The nominal code unique identifier. E.g. NOM001","schema":{"type":"string","description":"The nominal code unique identifier. E.g. NOM001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-nominal-code":{"post":{"operationId":"finance_payrun_put_nominal_code","summary":"Insert nominal code","description":"PUT /Employer/{EmployerId}/NominalCode/{NominalCodeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","NominalCodeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"NominalCodeId":{"type":"string","description":"The nominal code unique identifier. E.g. NOM001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-nominal-code":{"post":{"operationId":"finance_payrun_delete_nominal_code","summary":"Deletes the nominal codes","description":"DELETE /Employer/{EmployerId}/NominalCode/{NominalCodeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","NominalCodeId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"NominalCodeId":{"type":"string","description":"The nominal code unique identifier. E.g. NOM001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-codes-from-nominal-code":{"get":{"operationId":"finance_payrun_get_pay_codes_from_nominal_code","summary":"Gets the pay codes by nominal code","description":"GET /Employer/{EmployerId}/NominalCode/{NominalCodeId}/PayCodes","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"NominalCodeId","in":"query","required":true,"description":"The nominal code unique identifier. E.g. NOM001","schema":{"type":"string","description":"The nominal code unique identifier. E.g. NOM001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-nominal-codes-from-employer":{"get":{"operationId":"finance_payrun_get_nominal_codes_from_employer","summary":"Gets the nominal codes","description":"GET /Employer/{EmployerId}/NominalCodes","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-nominal-code":{"post":{"operationId":"finance_payrun_post_nominal_code","summary":"Insert nominal code","description":"POST /Employer/{EmployerId}/NominalCodes","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-code-from-employer":{"get":{"operationId":"finance_payrun_get_pay_code_from_employer","summary":"Gets the specified pay code from the employer","description":"GET /Employer/{EmployerId}/PayCode/{PayCodeId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayCodeId","in":"query","required":true,"description":"The pay code unique identifier. E.g. BASIC","schema":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pay-code":{"post":{"operationId":"finance_payrun_put_pay_code","summary":"Updates a pay code","description":"PUT /Employer/{EmployerId}/PayCode/{PayCodeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayCodeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayCodeId":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-pay-code":{"post":{"operationId":"finance_payrun_patch_pay_code","summary":"Patches the pay code","description":"PATCH /Employer/{EmployerId}/PayCode/{PayCodeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayCodeId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayCodeId":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-code":{"post":{"operationId":"finance_payrun_delete_pay_code","summary":"Deletes a pay code","description":"DELETE /Employer/{EmployerId}/PayCode/{PayCodeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayCodeId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayCodeId":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-code-revision-by-number":{"get":{"operationId":"finance_payrun_get_pay_code_revision_by_number","summary":"Gets the pay code by revision number","description":"GET /Employer/{EmployerId}/PayCode/{PayCodeId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayCodeId","in":"query","required":true,"description":"The pay code unique identifier. E.g. BASIC","schema":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"}},{"name":"RevisionNumber","in":"query","required":true,"description":"The revision number. E.g. 1","schema":{"type":"string","description":"The revision number. E.g. 1"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-code-revision-by-number":{"post":{"operationId":"finance_payrun_delete_pay_code_revision_by_number","summary":"Delete an PayCode revision matching the specified revision number.","description":"DELETE /Employer/{EmployerId}/PayCode/{PayCodeId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayCodeId","RevisionNumber","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayCodeId":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"},"RevisionNumber":{"type":"string","description":"The revision number. E.g. 1"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-code-revisions":{"get":{"operationId":"finance_payrun_get_pay_code_revisions","summary":"Get all revisions of the Pay Code","description":"GET /Employer/{EmployerId}/PayCode/{PayCodeId}/Revisions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayCodeId","in":"query","required":true,"description":"The pay code unique identifier. E.g. BASIC","schema":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-pay-code":{"get":{"operationId":"finance_payrun_get_tag_from_pay_code","summary":"Get pay code tag","description":"GET /Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayCodeId","in":"query","required":true,"description":"The pay code unique identifier. E.g. BASIC","schema":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pay-code-tag":{"post":{"operationId":"finance_payrun_put_pay_code_tag","summary":"Insert pay code tag","description":"PUT /Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayCodeId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayCodeId":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-code-tag":{"post":{"operationId":"finance_payrun_delete_pay_code_tag","summary":"Delete pay code tag","description":"DELETE /Employer/{EmployerId}/PayCode/{PayCodeId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayCodeId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayCodeId":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-pay-code":{"get":{"operationId":"finance_payrun_get_tags_from_pay_code","summary":"Get all pay code tags","description":"GET /Employer/{EmployerId}/PayCode/{PayCodeId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayCodeId","in":"query","required":true,"description":"The pay code unique identifier. E.g. BASIC","schema":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-code-by-effective-date":{"get":{"operationId":"finance_payrun_get_pay_code_by_effective_date","summary":"Gets pay code for specified date","description":"GET /Employer/{EmployerId}/PayCode/{PayCodeId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayCodeId","in":"query","required":true,"description":"The pay code unique identifier. E.g. BASIC","schema":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-code-revision":{"post":{"operationId":"finance_payrun_delete_pay_code_revision","summary":"Deletes a pay code revision","description":"DELETE /Employer/{EmployerId}/PayCode/{PayCodeId}/{EffectiveDate}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayCodeId","EffectiveDate","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayCodeId":{"type":"string","description":"The pay code unique identifier. E.g. BASIC"},"EffectiveDate":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-codes-from-employer":{"get":{"operationId":"finance_payrun_get_pay_codes_from_employer","summary":"Gets the pay codes from the employer","description":"GET /Employer/{EmployerId}/PayCodes","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-pay-code":{"post":{"operationId":"finance_payrun_post_pay_code","summary":"Create a new pay code","description":"POST /Employer/{EmployerId}/PayCodes","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-codes-with-tag":{"get":{"operationId":"finance_payrun_get_pay_codes_with_tag","summary":"Get pay codes with tag","description":"GET /Employer/{EmployerId}/PayCodes/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-pay-code-tags":{"get":{"operationId":"finance_payrun_get_all_pay_code_tags","summary":"Get all pay code tags","description":"GET /Employer/{EmployerId}/PayCodes/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-codes-by-effective-date":{"get":{"operationId":"finance_payrun_get_pay_codes_by_effective_date","summary":"Gets all pay codes for specified date","description":"GET /Employer/{EmployerId}/PayCodes/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-schedule-from-employer":{"get":{"operationId":"finance_payrun_get_pay_schedule_from_employer","summary":"Gets the specified pay schedule from the employer","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pay-schedule":{"post":{"operationId":"finance_payrun_put_pay_schedule","summary":"Updates a pay schedule","description":"PUT /Employer/{EmployerId}/PaySchedule/{PayScheduleId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayScheduleId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayScheduleId":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-schedule":{"post":{"operationId":"finance_payrun_delete_pay_schedule","summary":"Deletes a pay schedule","description":"DELETE /Employer/{EmployerId}/PaySchedule/{PayScheduleId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayScheduleId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayScheduleId":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employees-from-pay-schedule":{"get":{"operationId":"finance_payrun_get_employees_from_pay_schedule","summary":"Get all employees revisions from a pay schedule.","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employees-from-pay-schedule-on-effective-date":{"get":{"operationId":"finance_payrun_get_employees_from_pay_schedule_on_effective_date","summary":"Get employees from a pay schedule on effective date.","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Employees/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-run-from-pay-schedule":{"get":{"operationId":"finance_payrun_get_pay_run_from_pay_schedule","summary":"Gets the pay run from the pay schedule","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-run":{"post":{"operationId":"finance_payrun_delete_pay_run","summary":"Deletes a pay run","description":"DELETE /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayScheduleId","PayRunId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayScheduleId":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"},"PayRunId":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-aeassessments-from-pay-run":{"get":{"operationId":"finance_payrun_get_aeassessments_from_pay_run","summary":"Get the auto enrolment assessments","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/AEAssessments","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-commentaries-from-pay-run":{"get":{"operationId":"finance_payrun_get_commentaries_from_pay_run","summary":"Get links to all commentaries for the specified pay run","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Commentaries","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-run-employee":{"post":{"operationId":"finance_payrun_delete_pay_run_employee","summary":"Deletes a pay run employee","description":"DELETE /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employee/{EmployeeId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayScheduleId","PayRunId","EmployeeId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayScheduleId":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"},"PayRunId":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"},"EmployeeId":{"type":"string","description":"The employees' unique identifier. E.g EE001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-commentary-from-pay-run-by-employee":{"get":{"operationId":"finance_payrun_get_commentary_from_pay_run_by_employee","summary":"Get commentary from payrun by specified employee.","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employee/{EmployeeId}/Commentary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"EmployeeId","in":"query","required":true,"description":"The employees' unique identifier. E.g EE001","schema":{"type":"string","description":"The employees' unique identifier. E.g EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employees-from-pay-run":{"get":{"operationId":"finance_payrun_get_employees_from_pay_run","summary":"Get employees from the pay run","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Employees","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-lines-from-pay-run":{"get":{"operationId":"finance_payrun_get_journal_lines_from_pay_run","summary":"Gets the journal Lines from the specified pay run","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/JournalLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-lines-from-pay-run":{"get":{"operationId":"finance_payrun_get_pay_lines_from_pay_run","summary":"Gets the pay lines from the specified pay run","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/PayLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-report-lines-from-pay-run":{"get":{"operationId":"finance_payrun_get_report_lines_from_pay_run","summary":"Gets the report lines from the specified pay run","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/ReportLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-pay-run":{"get":{"operationId":"finance_payrun_get_tag_from_pay_run","summary":"Get pay run tag","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pay-run-tag":{"post":{"operationId":"finance_payrun_put_pay_run_tag","summary":"Insert pay run tag","description":"PUT /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayScheduleId","PayRunId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayScheduleId":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"},"PayRunId":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-run-tag":{"post":{"operationId":"finance_payrun_delete_pay_run_tag","summary":"Delete pay run tag","description":"DELETE /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayScheduleId","PayRunId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayScheduleId":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"},"PayRunId":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-pay-run":{"get":{"operationId":"finance_payrun_get_tags_from_pay_run","summary":"Get all pay run tags","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRun/{PayRunId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"PayRunId","in":"query","required":true,"description":"The pay runs' unique identifier. E.g. PR001","schema":{"type":"string","description":"The pay runs' unique identifier. E.g. PR001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-runs-from-pay-schedule":{"get":{"operationId":"finance_payrun_get_pay_runs_from_pay_schedule","summary":"Gets the pay runs from the pay schedule","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-runs-with-tag":{"get":{"operationId":"finance_payrun_get_pay_runs_with_tag","summary":"Get pay runs with tag","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-pay-run-tags":{"get":{"operationId":"finance_payrun_get_all_pay_run_tags","summary":"Get all pay run tags","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/PayRuns/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-pay-schedule":{"get":{"operationId":"finance_payrun_get_tag_from_pay_schedule","summary":"Get pay schedule tag","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pay-schedule-tag":{"post":{"operationId":"finance_payrun_put_pay_schedule_tag","summary":"Insert pay schedule tag","description":"PUT /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayScheduleId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayScheduleId":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-schedule-tag":{"post":{"operationId":"finance_payrun_delete_pay_schedule_tag","summary":"Delete pay schedule tag","description":"DELETE /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PayScheduleId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PayScheduleId":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-pay-schedule":{"get":{"operationId":"finance_payrun_get_tags_from_pay_schedule","summary":"Get all pay schedule tags","description":"GET /Employer/{EmployerId}/PaySchedule/{PayScheduleId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PayScheduleId","in":"query","required":true,"description":"The pay schedules' unique identifier. E.g SCH001","schema":{"type":"string","description":"The pay schedules' unique identifier. E.g SCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-schedules-from-employer":{"get":{"operationId":"finance_payrun_get_pay_schedules_from_employer","summary":"Gets the pay schedule from the specified employer","description":"GET /Employer/{EmployerId}/PaySchedules","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-pay-schedule":{"post":{"operationId":"finance_payrun_post_pay_schedule","summary":"Create a new pay schedule","description":"POST /Employer/{EmployerId}/PaySchedules","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-schedules-with-tag":{"get":{"operationId":"finance_payrun_get_pay_schedules_with_tag","summary":"Get pay schedule with tag","description":"GET /Employer/{EmployerId}/PaySchedules/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-pay-schedule-tags":{"get":{"operationId":"finance_payrun_get_all_pay_schedule_tags","summary":"Get all pay schedule tags","description":"GET /Employer/{EmployerId}/PaySchedules/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pension-from-employer":{"get":{"operationId":"finance_payrun_get_pension_from_employer","summary":"Get pension from employer","description":"GET /Employer/{EmployerId}/Pension/{PensionId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PensionId","in":"query","required":true,"description":"The pensions' unique identifier. E.g PEN001","schema":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-pension-into-employer":{"post":{"operationId":"finance_payrun_put_pension_into_employer","summary":"Updates the Pension","description":"PUT /Employer/{EmployerId}/Pension/{PensionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PensionId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PensionId":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-pension":{"post":{"operationId":"finance_payrun_patch_pension","summary":"Patches the pension","description":"PATCH /Employer/{EmployerId}/Pension/{PensionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PensionId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PensionId":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pension":{"post":{"operationId":"finance_payrun_delete_pension","summary":"Delete a Pension","description":"DELETE /Employer/{EmployerId}/Pension/{PensionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PensionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PensionId":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pension-revision-by-number":{"get":{"operationId":"finance_payrun_get_pension_revision_by_number","summary":"Gets the pension by revision number","description":"GET /Employer/{EmployerId}/Pension/{PensionId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PensionId","in":"query","required":true,"description":"The pensions' unique identifier. E.g PEN001","schema":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"}},{"name":"RevisionNumber","in":"query","required":true,"description":"The revision number. E.g. 1","schema":{"type":"string","description":"The revision number. E.g. 1"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pension-revision-by-number":{"post":{"operationId":"finance_payrun_delete_pension_revision_by_number","summary":"Delete an Pension revision matching the specified revision number.","description":"DELETE /Employer/{EmployerId}/Pension/{PensionId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PensionId","RevisionNumber","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PensionId":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"},"RevisionNumber":{"type":"string","description":"The revision number. E.g. 1"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pension-revisions":{"get":{"operationId":"finance_payrun_get_pension_revisions","summary":"Get all pension revisions","description":"GET /Employer/{EmployerId}/Pension/{PensionId}/Revisions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PensionId","in":"query","required":true,"description":"The pensions' unique identifier. E.g PEN001","schema":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pension-by-effective-date":{"get":{"operationId":"finance_payrun_get_pension_by_effective_date","summary":"Get pension by effective date.","description":"GET /Employer/{EmployerId}/Pension/{PensionId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"PensionId","in":"query","required":true,"description":"The pensions' unique identifier. E.g PEN001","schema":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pension-revision":{"post":{"operationId":"finance_payrun_delete_pension_revision","summary":"Delete an Pension revision matching the specified revision date.","description":"DELETE /Employer/{EmployerId}/Pension/{PensionId}/{EffectiveDate}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","PensionId","EffectiveDate","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"PensionId":{"type":"string","description":"The pensions' unique identifier. E.g PEN001"},"EffectiveDate":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pensions-from-employer":{"get":{"operationId":"finance_payrun_get_pensions_from_employer","summary":"Get pensions from employer.","description":"GET /Employer/{EmployerId}/Pensions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-pension-into-employer":{"post":{"operationId":"finance_payrun_post_pension_into_employer","summary":"Create a new Pension","description":"POST /Employer/{EmployerId}/Pensions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pensions-by-effective-date":{"get":{"operationId":"finance_payrun_get_pensions_by_effective_date","summary":"Get pensions from employer at a given effective date.","description":"GET /Employer/{EmployerId}/Pensions/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-report-line-from-employer":{"get":{"operationId":"finance_payrun_get_report_line_from_employer","summary":"Gets the specified report line from the employer","description":"GET /Employer/{EmployerId}/ReportLine/{ReportLineId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"ReportLineId","in":"query","required":true,"description":"The report line unique identifier. E.g. RTL001","schema":{"type":"string","description":"The report line unique identifier. E.g. RTL001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-report-lines-from-employer":{"get":{"operationId":"finance_payrun_get_report_lines_from_employer","summary":"Gets the report lines from the specified employer","description":"GET /Employer/{EmployerId}/ReportLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-reporting-instruction-from-employer":{"get":{"operationId":"finance_payrun_get_reporting_instruction_from_employer","summary":"Gets the specified reporting instruction from the employer","description":"GET /Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"ReportingInstructionId","in":"query","required":true,"description":"The reporting instruction unique identifier. E.g. SERRPT001","schema":{"type":"string","description":"The reporting instruction unique identifier. E.g. SERRPT001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-reporting-instruction":{"post":{"operationId":"finance_payrun_put_reporting_instruction","summary":"Update a reporting Instruction","description":"PUT /Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","ReportingInstructionId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"ReportingInstructionId":{"type":"string","description":"The reporting instruction unique identifier. E.g. SERRPT001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-reporting-instruction":{"post":{"operationId":"finance_payrun_delete_reporting_instruction","summary":"Deletes a reporting instruction","description":"DELETE /Employer/{EmployerId}/ReportingInstruction/{ReportingInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","ReportingInstructionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"ReportingInstructionId":{"type":"string","description":"The reporting instruction unique identifier. E.g. SERRPT001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-reporting-instructions-from-employer":{"get":{"operationId":"finance_payrun_get_reporting_instructions_from_employer","summary":"Gets the reporting instructions from the specified employer","description":"GET /Employer/{EmployerId}/ReportingInstructions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-reporting-instruction":{"post":{"operationId":"finance_payrun_post_reporting_instruction","summary":"Creates a new Reporting Instruction","description":"POST /Employer/{EmployerId}/ReportingInstructions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-revision-by-number":{"get":{"operationId":"finance_payrun_get_employer_revision_by_number","summary":"Gets the employer by revision number","description":"GET /Employer/{EmployerId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"RevisionNumber","in":"query","required":true,"description":"The revision number. E.g. 1","schema":{"type":"string","description":"The revision number. E.g. 1"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employer-revision-by-number":{"post":{"operationId":"finance_payrun_delete_employer_revision_by_number","summary":"Delete an Employer revision matching the specified revision number.","description":"DELETE /Employer/{EmployerId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","RevisionNumber","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"RevisionNumber":{"type":"string","description":"The revision number. E.g. 1"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-revision-summary-by-number":{"get":{"operationId":"finance_payrun_get_employer_revision_summary_by_number","summary":"Gets the employer summary by revision number","description":"GET /Employer/{EmployerId}/Revision/{RevisionNumber}/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"RevisionNumber","in":"query","required":true,"description":"The revision number. E.g. 1","schema":{"type":"string","description":"The revision number. E.g. 1"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-revisions":{"get":{"operationId":"finance_payrun_get_employer_revisions","summary":"Gets the employer revisions","description":"GET /Employer/{EmployerId}/Revisions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-revision-summaries":{"get":{"operationId":"finance_payrun_get_employer_revision_summaries","summary":"Get all employer revision summaries","description":"GET /Employer/{EmployerId}/Revisions/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-transaction-from-employer":{"get":{"operationId":"finance_payrun_get_rti_transaction_from_employer","summary":"Get the RTI transaction","description":"GET /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"RtiTransactionId","in":"query","required":true,"description":"The RTI transaction unique identifier. E.g. FPS001","schema":{"type":"string","description":"The RTI transaction unique identifier. E.g. FPS001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-rti-transaction":{"post":{"operationId":"finance_payrun_delete_rti_transaction","summary":"Delete the RTI transaction","description":"DELETE /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","RtiTransactionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"RtiTransactionId":{"type":"string","description":"The RTI transaction unique identifier. E.g. FPS001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-transaction-summary-from-employer":{"get":{"operationId":"finance_payrun_get_rti_transaction_summary_from_employer","summary":"Get the RTI transaction summary","description":"GET /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"RtiTransactionId","in":"query","required":true,"description":"The RTI transaction unique identifier. E.g. FPS001","schema":{"type":"string","description":"The RTI transaction unique identifier. E.g. FPS001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-rti-transaction":{"get":{"operationId":"finance_payrun_get_tag_from_rti_transaction","summary":"Get RTI transaction tag","description":"GET /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"RtiTransactionId","in":"query","required":true,"description":"The RTI transaction unique identifier. E.g. FPS001","schema":{"type":"string","description":"The RTI transaction unique identifier. E.g. FPS001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-rti-transaction-tag":{"post":{"operationId":"finance_payrun_put_rti_transaction_tag","summary":"Insert RTI transaction tag","description":"PUT /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","RtiTransactionId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"RtiTransactionId":{"type":"string","description":"The RTI transaction unique identifier. E.g. FPS001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-rti-transaction-tag":{"post":{"operationId":"finance_payrun_delete_rti_transaction_tag","summary":"Delete RTI transaction tag","description":"DELETE /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","RtiTransactionId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"RtiTransactionId":{"type":"string","description":"The RTI transaction unique identifier. E.g. FPS001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-rti-transaction":{"get":{"operationId":"finance_payrun_get_tags_from_rti_transaction","summary":"Get all tags from RTI transaction","description":"GET /Employer/{EmployerId}/RtiTransaction/{RtiTransactionId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"RtiTransactionId","in":"query","required":true,"description":"The RTI transaction unique identifier. E.g. FPS001","schema":{"type":"string","description":"The RTI transaction unique identifier. E.g. FPS001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-transactions-from-employer":{"get":{"operationId":"finance_payrun_get_rti_transactions_from_employer","summary":"Get all RTI transactions for the employer","description":"GET /Employer/{EmployerId}/RtiTransactions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-transaction-summaries-from-employer":{"get":{"operationId":"finance_payrun_get_rti_transaction_summaries_from_employer","summary":"Get all RTI transaction summaries for the employer","description":"GET /Employer/{EmployerId}/RtiTransactions/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-transactions-with-tag":{"get":{"operationId":"finance_payrun_get_rti_transactions_with_tag","summary":"Get RTI transactions with tag","description":"GET /Employer/{EmployerId}/RtiTransactions/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-rti-transaction-tags":{"get":{"operationId":"finance_payrun_get_all_rti_transaction_tags","summary":"Get all RTI transaction tags","description":"GET /Employer/{EmployerId}/RtiTransactions/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-secret":{"get":{"operationId":"finance_payrun_get_employer_secret","summary":"Get employer secret","description":"GET /Employer/{EmployerId}/Secret/{SecretId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SecretId","in":"query","required":true,"description":"The secret unique identifier. E.g ERSEC001","schema":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-employer-secret":{"post":{"operationId":"finance_payrun_put_employer_secret","summary":"Create a new employer secret","description":"PUT /Employer/{EmployerId}/Secret/{SecretId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SecretId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SecretId":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employer-secret":{"post":{"operationId":"finance_payrun_delete_employer_secret","summary":"Deletes employer secret","description":"DELETE /Employer/{EmployerId}/Secret/{SecretId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SecretId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SecretId":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-secrets":{"get":{"operationId":"finance_payrun_get_employer_secrets","summary":"Get all employer secret links","description":"GET /Employer/{EmployerId}/Secrets","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-employer-secret":{"post":{"operationId":"finance_payrun_post_employer_secret","summary":"Create a new employer secret","description":"POST /Employer/{EmployerId}/Secrets","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-sub-contractor-from-employer":{"get":{"operationId":"finance_payrun_get_sub_contractor_from_employer","summary":"Get sub contractor from employer","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-sub-contractor-into-employer":{"post":{"operationId":"finance_payrun_put_sub_contractor_into_employer","summary":"Updates the sub contractor","description":"PUT /Employer/{EmployerId}/SubContractor/{SubContractorId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-sub-contractor":{"post":{"operationId":"finance_payrun_patch_sub_contractor","summary":"Patches the sub contractor","description":"PATCH /Employer/{EmployerId}/SubContractor/{SubContractorId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-sub-contractor":{"post":{"operationId":"finance_payrun_delete_sub_contractor","summary":"Delete an sub contractor","description":"DELETE /Employer/{EmployerId}/SubContractor/{SubContractorId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-instruction-from-sub-contractor":{"get":{"operationId":"finance_payrun_get_cis_instruction_from_sub_contractor","summary":"Get CIS instruction from sub contractor","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"CisInstructionId","in":"query","required":true,"description":"The CIS instruction unique identifier. E.g. CIS001","schema":{"type":"string","description":"The CIS instruction unique identifier. E.g. CIS001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-cis-instruction-into-sub-contractor":{"post":{"operationId":"finance_payrun_put_cis_instruction_into_sub_contractor","summary":"Updates the CIS instruction","description":"PUT /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","CisInstructionId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"CisInstructionId":{"type":"string","description":"The CIS instruction unique identifier. E.g. CIS001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-cis-instruction":{"post":{"operationId":"finance_payrun_patch_cis_instruction","summary":"Patches the CIS instruction","description":"PATCH /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","CisInstructionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"CisInstructionId":{"type":"string","description":"The CIS instruction unique identifier. E.g. CIS001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-cis-instruction":{"post":{"operationId":"finance_payrun_delete_cis_instruction","summary":"Delete a CIS instruction","description":"DELETE /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","CisInstructionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"CisInstructionId":{"type":"string","description":"The CIS instruction unique identifier. E.g. CIS001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-cis-instruction":{"get":{"operationId":"finance_payrun_get_tag_from_cis_instruction","summary":"Get CIS instruction tag","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"CisInstructionId","in":"query","required":true,"description":"The CIS instruction unique identifier. E.g. CIS001","schema":{"type":"string","description":"The CIS instruction unique identifier. E.g. CIS001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-cis-instruction-tag":{"post":{"operationId":"finance_payrun_put_cis_instruction_tag","summary":"Insert CIS instruction tag","description":"PUT /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","CisInstructionId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"CisInstructionId":{"type":"string","description":"The CIS instruction unique identifier. E.g. CIS001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-cis-instruction-tag":{"post":{"operationId":"finance_payrun_delete_cis_instruction_tag","summary":"Delete CIS instruction tag","description":"DELETE /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","CisInstructionId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"CisInstructionId":{"type":"string","description":"The CIS instruction unique identifier. E.g. CIS001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-cis-instruction":{"get":{"operationId":"finance_payrun_get_tags_from_cis_instruction","summary":"Get all tags from the CIS instruction","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstruction/{CisInstructionId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"CisInstructionId","in":"query","required":true,"description":"The CIS instruction unique identifier. E.g. CIS001","schema":{"type":"string","description":"The CIS instruction unique identifier. E.g. CIS001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-instructions-from-sub-contractor":{"get":{"operationId":"finance_payrun_get_cis_instructions_from_sub_contractor","summary":"Get CIS instructions from sub contractor.","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-cis-instruction-into-sub-contractor":{"post":{"operationId":"finance_payrun_post_cis_instruction_into_sub_contractor","summary":"Create a new CIS instruction","description":"POST /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-instructions-with-tag":{"get":{"operationId":"finance_payrun_get_cis_instructions_with_tag","summary":"Get CIS instructions with tag","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-cis-instruction-tags":{"get":{"operationId":"finance_payrun_get_all_cis_instruction_tags","summary":"Get all CIS instruction tags","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisInstructions/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-line-from-sub-contractor":{"get":{"operationId":"finance_payrun_get_cis_line_from_sub_contractor","summary":"Get CIS line from sub contractor","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"CisLineId","in":"query","required":true,"description":"The CIS line unique identifier. E.g. CISLN001","schema":{"type":"string","description":"The CIS line unique identifier. E.g. CISLN001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-cis-line":{"post":{"operationId":"finance_payrun_delete_cis_line","summary":"Delete a CIS line","description":"DELETE /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","CisLineId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"CisLineId":{"type":"string","description":"The CIS line unique identifier. E.g. CISLN001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-cis-line":{"get":{"operationId":"finance_payrun_get_tag_from_cis_line","summary":"Get CIS line tag","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"CisLineId","in":"query","required":true,"description":"The CIS line unique identifier. E.g. CISLN001","schema":{"type":"string","description":"The CIS line unique identifier. E.g. CISLN001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-cis-line-tag":{"post":{"operationId":"finance_payrun_put_cis_line_tag","summary":"Insert CIS line tag","description":"PUT /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","CisLineId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"CisLineId":{"type":"string","description":"The CIS line unique identifier. E.g. CISLN001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-cis-line-tag":{"post":{"operationId":"finance_payrun_delete_cis_line_tag","summary":"Delete CIS line tag","description":"DELETE /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","CisLineId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"CisLineId":{"type":"string","description":"The CIS line unique identifier. E.g. CISLN001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-cis-line":{"get":{"operationId":"finance_payrun_get_tags_from_cis_line","summary":"Get all tags from the CIS line","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLine/{CisLineId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"CisLineId","in":"query","required":true,"description":"The CIS line unique identifier. E.g. CISLN001","schema":{"type":"string","description":"The CIS line unique identifier. E.g. CISLN001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-lines-from-sub-contractor":{"get":{"operationId":"finance_payrun_get_cis_lines_from_sub_contractor","summary":"Get CIS lines from sub contractor.","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-lines-with-tag":{"get":{"operationId":"finance_payrun_get_cis_lines_with_tag","summary":"Get CIS lines with tag","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-cis-line-tags":{"get":{"operationId":"finance_payrun_get_all_cis_line_tags","summary":"Get all CIS line tags","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/CisLines/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-lines-from-sub-contractor":{"get":{"operationId":"finance_payrun_get_journal_lines_from_sub_contractor","summary":"Gets the journal Lines from the specified sub contractor","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/JournalLines","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-sub-contractor-revision-by-number":{"get":{"operationId":"finance_payrun_get_sub_contractor_revision_by_number","summary":"Gets the sub contractor by revision number","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"RevisionNumber","in":"query","required":true,"description":"The revision number. E.g. 1","schema":{"type":"string","description":"The revision number. E.g. 1"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-sub-contractor-revision-by-number":{"post":{"operationId":"finance_payrun_delete_sub_contractor_revision_by_number","summary":"Delete an SubContractor revision matching the specified revision number.","description":"DELETE /Employer/{EmployerId}/SubContractor/{SubContractorId}/Revision/{RevisionNumber}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","RevisionNumber","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"RevisionNumber":{"type":"string","description":"The revision number. E.g. 1"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-sub-contractor-revisions":{"get":{"operationId":"finance_payrun_get_sub_contractor_revisions","summary":"Get all sub contractor revisions","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Revisions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-sub-contractor":{"get":{"operationId":"finance_payrun_get_tag_from_sub_contractor","summary":"Get sub contractor tag","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-sub-contractor-tag":{"post":{"operationId":"finance_payrun_put_sub_contractor_tag","summary":"Insert sub contractor tag","description":"PUT /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-sub-contractor-tag":{"post":{"operationId":"finance_payrun_delete_sub_contractor_tag","summary":"Delete sub contractor tag","description":"DELETE /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-sub-contractor-revision":{"get":{"operationId":"finance_payrun_get_tag_from_sub_contractor_revision","summary":"Get sub contractor revision tag","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tag/{TagId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-sub-contractor":{"get":{"operationId":"finance_payrun_get_tags_from_sub_contractor","summary":"Get all tags from the sub contractor","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-sub-contractor-revision":{"get":{"operationId":"finance_payrun_get_tags_from_sub_contractor_revision","summary":"Get all sub contractor revision tags","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/Tags/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-sub-contractor-by-effective-date":{"get":{"operationId":"finance_payrun_get_sub_contractor_by_effective_date","summary":"Get sub contractor by effective date.","description":"GET /Employer/{EmployerId}/SubContractor/{SubContractorId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"SubContractorId","in":"query","required":true,"description":"The sub contractors' unique identifier. E.g SUB001","schema":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-sub-contractor-revision":{"post":{"operationId":"finance_payrun_delete_sub_contractor_revision","summary":"Delete an sub contractor revision matching the specified revision date.","description":"DELETE /Employer/{EmployerId}/SubContractor/{SubContractorId}/{EffectiveDate}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","SubContractorId","EffectiveDate","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"SubContractorId":{"type":"string","description":"The sub contractors' unique identifier. E.g SUB001"},"EffectiveDate":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-sub-contractors-from-employer":{"get":{"operationId":"finance_payrun_get_sub_contractors_from_employer","summary":"Get sub contractors from employer.","description":"GET /Employer/{EmployerId}/SubContractors","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-sub-contractor-into-employer":{"post":{"operationId":"finance_payrun_post_sub_contractor_into_employer","summary":"Create a new sub contractor","description":"POST /Employer/{EmployerId}/SubContractors","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","Api-Version","body"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-sub-contractors-with-tag":{"get":{"operationId":"finance_payrun_get_sub_contractors_with_tag","summary":"Get sub contractors with tag","description":"GET /Employer/{EmployerId}/SubContractors/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-sub-contractor-tags":{"get":{"operationId":"finance_payrun_get_all_sub_contractor_tags","summary":"Get all sub contractor tags","description":"GET /Employer/{EmployerId}/SubContractors/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-sub-contractors-by-effective-date":{"get":{"operationId":"finance_payrun_get_sub_contractors_by_effective_date","summary":"Get sub contractors from employer at a given effective date.","description":"GET /Employer/{EmployerId}/SubContractors/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-summary":{"get":{"operationId":"finance_payrun_get_employer_summary","summary":"Get employer summary","description":"GET /Employer/{EmployerId}/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-employer":{"get":{"operationId":"finance_payrun_get_tag_from_employer","summary":"Get employer tag","description":"GET /Employer/{EmployerId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-employer-tag":{"post":{"operationId":"finance_payrun_put_employer_tag","summary":"Insert employer tag","description":"PUT /Employer/{EmployerId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employer-tag":{"post":{"operationId":"finance_payrun_delete_employer_tag","summary":"Delete employer tag","description":"DELETE /Employer/{EmployerId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-employer-revision":{"get":{"operationId":"finance_payrun_get_tag_from_employer_revision","summary":"Get employer revision tag","description":"GET /Employer/{EmployerId}/Tag/{TagId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-employer":{"get":{"operationId":"finance_payrun_get_tags_from_employer","summary":"Get all employer tags","description":"GET /Employer/{EmployerId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-employer-revision":{"get":{"operationId":"finance_payrun_get_tags_from_employer_revision","summary":"Get all employer revision tags","description":"GET /Employer/{EmployerId}/Tags/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-third-party-transaction":{"get":{"operationId":"finance_payrun_get_third_party_transaction","summary":"Get a third party transaction","description":"GET /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"ThirdPartyTransactionId","in":"query","required":true,"description":"The third party transaction unique identifier. E.g TP001","schema":{"type":"string","description":"The third party transaction unique identifier. E.g TP001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-third-party-transaction":{"post":{"operationId":"finance_payrun_delete_third_party_transaction","summary":"Delete third party transaction","description":"DELETE /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","ThirdPartyTransactionId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"ThirdPartyTransactionId":{"type":"string","description":"The third party transaction unique identifier. E.g TP001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-third-party-transaction":{"get":{"operationId":"finance_payrun_get_tag_from_third_party_transaction","summary":"Get third party transaction tag","description":"GET /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"ThirdPartyTransactionId","in":"query","required":true,"description":"The third party transaction unique identifier. E.g TP001","schema":{"type":"string","description":"The third party transaction unique identifier. E.g TP001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-third-party-transaction-tag":{"post":{"operationId":"finance_payrun_put_third_party_transaction_tag","summary":"insert third party transaction tag","description":"PUT /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","ThirdPartyTransactionId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"ThirdPartyTransactionId":{"type":"string","description":"The third party transaction unique identifier. E.g TP001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-third-party-transaction-tag":{"post":{"operationId":"finance_payrun_delete_third_party_transaction_tag","summary":"Delete third party transaction tag","description":"DELETE /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","ThirdPartyTransactionId","TagId","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"ThirdPartyTransactionId":{"type":"string","description":"The third party transaction unique identifier. E.g TP001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-third-party-transaction":{"get":{"operationId":"finance_payrun_get_tags_from_third_party_transaction","summary":"Get tags from third party transaction","description":"GET /Employer/{EmployerId}/ThirdPartyTransaction/{ThirdPartyTransactionId}/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"ThirdPartyTransactionId","in":"query","required":true,"description":"The third party transaction unique identifier. E.g TP001","schema":{"type":"string","description":"The third party transaction unique identifier. E.g TP001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-third-party-transactions":{"get":{"operationId":"finance_payrun_get_third_party_transactions","summary":"Get all third party transaction links","description":"GET /Employer/{EmployerId}/ThirdPartyTransactions","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-third-party-transactions-with-tag":{"get":{"operationId":"finance_payrun_get_all_third_party_transactions_with_tag","summary":"Get links to tagged third party transactions","description":"GET /Employer/{EmployerId}/ThirdPartyTransactions/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-third-party-transaction-tags":{"get":{"operationId":"finance_payrun_get_all_third_party_transaction_tags","summary":"Get all third party transaction tags","description":"GET /Employer/{EmployerId}/ThirdPartyTransactions/Tags","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-by-effective-date":{"get":{"operationId":"finance_payrun_get_employer_by_effective_date","summary":"Gets the employer at the specified effective","description":"GET /Employer/{EmployerId}/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-employer-revision":{"post":{"operationId":"finance_payrun_delete_employer_revision","summary":"Delete an Employer revision matching the specified revision date.","description":"DELETE /Employer/{EmployerId}/{EffectiveDate}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EmployerId","EffectiveDate","Api-Version"],"properties":{"EmployerId":{"type":"string","description":"The employers' unique identifier. E.g ER001"},"EffectiveDate":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-summary-by-effective-date":{"get":{"operationId":"finance_payrun_get_employer_summary_by_effective_date","summary":"Get employer summary by effective date.","description":"GET /Employer/{EmployerId}/{EffectiveDate}/Summary","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employers":{"get":{"operationId":"finance_payrun_get_employers","summary":"Gets all employers","description":"GET /Employers","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-employer":{"post":{"operationId":"finance_payrun_post_employer","summary":"Create a new Employer","description":"POST /Employers","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-summaries":{"get":{"operationId":"finance_payrun_get_employer_summaries","summary":"Get employer summaries.","description":"GET /Employers/Summary","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employers-with-tag":{"get":{"operationId":"finance_payrun_get_employers_with_tag","summary":"Get employers with tag","description":"GET /Employers/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-employer-tags":{"get":{"operationId":"finance_payrun_get_all_employer_tags","summary":"Get all employer tags","description":"GET /Employers/Tags","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employers-by-effective-date":{"get":{"operationId":"finance_payrun_get_employers_by_effective_date","summary":"Gets all employers at the specified effective date","description":"GET /Employers/{EffectiveDate}","tags":["finance"],"parameters":[{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-summaries-by-effective-date":{"get":{"operationId":"finance_payrun_get_employer_summaries_by_effective_date","summary":"Get employer summaries at a given effective date.","description":"GET /Employers/{EffectiveDate}/Summary","tags":["finance"],"parameters":[{"name":"EffectiveDate","in":"query","required":true,"description":"The effective date to be applied. E.g 2016-04-06","schema":{"type":"string","description":"The effective date to be applied. E.g 2016-04-06"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-health-check":{"get":{"operationId":"finance_payrun_get_health_check","summary":"Get health check status","description":"GET /Healthcheck","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-batch-jobs":{"get":{"operationId":"finance_payrun_get_batch_jobs","summary":"Get all Batch jobs","description":"GET /Jobs/Batch","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-new-batch-job":{"post":{"operationId":"finance_payrun_post_new_batch_job","summary":"Create new Batch job","description":"POST /Jobs/Batch","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-batch-job":{"post":{"operationId":"finance_payrun_delete_batch_job","summary":"Delete the Batch job","description":"DELETE /Jobs/Batch/{JobId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId","Api-Version"],"properties":{"JobId":{"type":"string","description":"The job unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-batch-job-info":{"get":{"operationId":"finance_payrun_get_batch_job_info","summary":"Get the Batch job information","description":"GET /Jobs/Batch/{JobId}/Info","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-batch-job-progress":{"get":{"operationId":"finance_payrun_get_batch_job_progress","summary":"Get the Batch job progress","description":"GET /Jobs/Batch/{JobId}/Progress","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-batch-job-status":{"get":{"operationId":"finance_payrun_get_batch_job_status","summary":"Get the Batch job status","description":"GET /Jobs/Batch/{JobId}/Status","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-jobs":{"get":{"operationId":"finance_payrun_get_cis_jobs","summary":"Get all CIS jobs","description":"GET /Jobs/Cis","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-new-cis-job":{"post":{"operationId":"finance_payrun_post_new_cis_job","summary":"Create new CIS job","description":"POST /Jobs/Cis","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-cis-job":{"post":{"operationId":"finance_payrun_delete_cis_job","summary":"Delete the CIS job","description":"DELETE /Jobs/Cis/{JobId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId","Api-Version"],"properties":{"JobId":{"type":"string","description":"The job unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-job-info":{"get":{"operationId":"finance_payrun_get_cis_job_info","summary":"Get the CIS job information","description":"GET /Jobs/Cis/{JobId}/Info","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-job-progress":{"get":{"operationId":"finance_payrun_get_cis_job_progress","summary":"Get the CIS job progress","description":"GET /Jobs/Cis/{JobId}/Progress","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-cis-job-status":{"get":{"operationId":"finance_payrun_get_cis_job_status","summary":"Get the CIS job status","description":"GET /Jobs/Cis/{JobId}/Status","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-dps-jobs":{"get":{"operationId":"finance_payrun_get_dps_jobs","summary":"Get all DPS jobs","description":"GET /Jobs/Dps","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-new-dps-job":{"post":{"operationId":"finance_payrun_post_new_dps_job","summary":"Create new DPS job","description":"POST /Jobs/Dps","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-dps-job":{"post":{"operationId":"finance_payrun_delete_dps_job","summary":"Delete the DPS job","description":"DELETE /Jobs/Dps/{JobId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId","Api-Version"],"properties":{"JobId":{"type":"string","description":"The job unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-dps-job-info":{"get":{"operationId":"finance_payrun_get_dps_job_info","summary":"Get the DPS job information","description":"GET /Jobs/Dps/{JobId}/Info","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-dps-job-progress":{"get":{"operationId":"finance_payrun_get_dps_job_progress","summary":"Get the DPS job progress","description":"GET /Jobs/Dps/{JobId}/Progress","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-dps-job-status":{"get":{"operationId":"finance_payrun_get_dps_job_status","summary":"Get the DPS job status","description":"GET /Jobs/Dps/{JobId}/Status","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-jobs":{"get":{"operationId":"finance_payrun_get_employer_jobs","summary":"Gets all jobs relating to the employer.","description":"GET /Jobs/Employer/{EmployerId}","tags":["finance"],"parameters":[{"name":"EmployerId","in":"query","required":true,"description":"The employers' unique identifier. E.g ER001","schema":{"type":"string","description":"The employers' unique identifier. E.g ER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-run-jobs":{"get":{"operationId":"finance_payrun_get_pay_run_jobs","summary":"Get all PayRun jobs","description":"GET /Jobs/PayRuns","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-new-pay-run-job":{"post":{"operationId":"finance_payrun_post_new_pay_run_job","summary":"Create new PayRun job","description":"POST /Jobs/PayRuns","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-pay-run-job":{"post":{"operationId":"finance_payrun_delete_pay_run_job","summary":"Delete the pay run job","description":"DELETE /Jobs/PayRuns/{JobId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId","Api-Version"],"properties":{"JobId":{"type":"string","description":"The job unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-run-job-info":{"get":{"operationId":"finance_payrun_get_pay_run_job_info","summary":"Get the pay run job information","description":"GET /Jobs/PayRuns/{JobId}/Info","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-run-job-progress":{"get":{"operationId":"finance_payrun_get_pay_run_job_progress","summary":"Get the pay run job progress","description":"GET /Jobs/PayRuns/{JobId}/Progress","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-run-job-status":{"get":{"operationId":"finance_payrun_get_pay_run_job_status","summary":"Get the pay run job status","description":"GET /Jobs/PayRuns/{JobId}/Status","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-jobs":{"get":{"operationId":"finance_payrun_get_rti_jobs","summary":"Get all RTI jobs","description":"GET /Jobs/Rti","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-new-rti-job":{"post":{"operationId":"finance_payrun_post_new_rti_job","summary":"Create new RTI job","description":"POST /Jobs/Rti","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-rti-job":{"post":{"operationId":"finance_payrun_delete_rti_job","summary":"Delete the RTI job","description":"DELETE /Jobs/Rti/{JobId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId","Api-Version"],"properties":{"JobId":{"type":"string","description":"The job unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-job-info":{"get":{"operationId":"finance_payrun_get_rti_job_info","summary":"Get the RTI job information","description":"GET /Jobs/Rti/{JobId}/Info","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-job-progress":{"get":{"operationId":"finance_payrun_get_rti_job_progress","summary":"Get the RTI job progress","description":"GET /Jobs/Rti/{JobId}/Progress","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-rti-job-status":{"get":{"operationId":"finance_payrun_get_rti_job_status","summary":"Get the RTI job status","description":"GET /Jobs/Rti/{JobId}/Status","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-third-party-jobs":{"get":{"operationId":"finance_payrun_get_third_party_jobs","summary":"Get all Third Party jobs","description":"GET /Jobs/ThirdParty","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-new-third-party-job":{"post":{"operationId":"finance_payrun_post_new_third_party_job","summary":"Create new Third Party job","description":"POST /Jobs/ThirdParty","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-third-party-job":{"post":{"operationId":"finance_payrun_delete_third_party_job","summary":"Delete the Third Party job","description":"DELETE /Jobs/ThirdParty/{JobId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId","Api-Version"],"properties":{"JobId":{"type":"string","description":"The job unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-third-party-job-info":{"get":{"operationId":"finance_payrun_get_third_party_job_info","summary":"Get the Third Party job information","description":"GET /Jobs/ThirdParty/{JobId}/Info","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-third-party-job-progress":{"get":{"operationId":"finance_payrun_get_third_party_job_progress","summary":"Get the Third Party job progress","description":"GET /Jobs/ThirdParty/{JobId}/Progress","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-third-party-job-status":{"get":{"operationId":"finance_payrun_get_third_party_job_status","summary":"Get the Third Party job status","description":"GET /Jobs/ThirdParty/{JobId}/Status","tags":["finance"],"parameters":[{"name":"JobId","in":"query","required":true,"description":"The job unique identifier.","schema":{"type":"string","description":"The job unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-instruction-template":{"get":{"operationId":"finance_payrun_get_journal_instruction_template","summary":"Gets the Journal instructions template for the application","description":"GET /JournalInstruction/{JournalInstructionId}","tags":["finance"],"parameters":[{"name":"JournalInstructionId","in":"query","required":true,"description":"The journal instruction unique identifier. E.g JI001","schema":{"type":"string","description":"The journal instruction unique identifier. E.g JI001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-journal-instruction-template":{"post":{"operationId":"finance_payrun_put_journal_instruction_template","summary":"Update a Journal Instruction template","description":"PUT /JournalInstruction/{JournalInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JournalInstructionId","Api-Version"],"properties":{"JournalInstructionId":{"type":"string","description":"The journal instruction unique identifier. E.g JI001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-journal-instruction-template":{"post":{"operationId":"finance_payrun_delete_journal_instruction_template","summary":"Deletes a Journal instruction template","description":"DELETE /JournalInstruction/{JournalInstructionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JournalInstructionId","Api-Version"],"properties":{"JournalInstructionId":{"type":"string","description":"The journal instruction unique identifier. E.g JI001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-instruction-templates":{"get":{"operationId":"finance_payrun_get_journal_instruction_templates","summary":"Gets the Journal instructions templates for the application","description":"GET /JournalInstructions","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-journal-instruction-template":{"post":{"operationId":"finance_payrun_post_journal_instruction_template","summary":"Creates a new Journal Instruction template","description":"POST /JournalInstructions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-permission":{"get":{"operationId":"finance_payrun_get_permission","summary":"Gets the permission object","description":"GET /Permission/{PermissionId}","tags":["finance"],"parameters":[{"name":"PermissionId","in":"query","required":true,"description":"The permission unique identifier. E.g PERM001","schema":{"type":"string","description":"The permission unique identifier. E.g PERM001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-permission":{"post":{"operationId":"finance_payrun_put_permission","summary":"Puts permisson object","description":"PUT /Permission/{PermissionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PermissionId","Api-Version"],"properties":{"PermissionId":{"type":"string","description":"The permission unique identifier. E.g PERM001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-permission":{"post":{"operationId":"finance_payrun_patch_permission","summary":"Patch permission object","description":"PATCH /Permission/{PermissionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PermissionId","Api-Version"],"properties":{"PermissionId":{"type":"string","description":"The permission unique identifier. E.g PERM001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-permission":{"post":{"operationId":"finance_payrun_delete_permission","summary":"Deletes the permission object","description":"DELETE /Permission/{PermissionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PermissionId","Api-Version"],"properties":{"PermissionId":{"type":"string","description":"The permission unique identifier. E.g PERM001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-permission":{"get":{"operationId":"finance_payrun_get_tag_from_permission","summary":"Get Permission tag","description":"GET /Permission/{PermissionId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"PermissionId","in":"query","required":true,"description":"The permission unique identifier. E.g PERM001","schema":{"type":"string","description":"The permission unique identifier. E.g PERM001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-permission-tag":{"post":{"operationId":"finance_payrun_put_permission_tag","summary":"Insert Permission tag","description":"PUT /Permission/{PermissionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PermissionId","TagId","Api-Version"],"properties":{"PermissionId":{"type":"string","description":"The permission unique identifier. E.g PERM001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-permission-tag":{"post":{"operationId":"finance_payrun_delete_permission_tag","summary":"Delete Permission tag","description":"DELETE /Permission/{PermissionId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PermissionId","TagId","Api-Version"],"properties":{"PermissionId":{"type":"string","description":"The permission unique identifier. E.g PERM001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-permission":{"get":{"operationId":"finance_payrun_get_tags_from_permission","summary":"Get tags from Permission","description":"GET /Permission/{PermissionId}/Tags","tags":["finance"],"parameters":[{"name":"PermissionId","in":"query","required":true,"description":"The permission unique identifier. E.g PERM001","schema":{"type":"string","description":"The permission unique identifier. E.g PERM001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-users-from-permission":{"get":{"operationId":"finance_payrun_get_users_from_permission","summary":"Gets the users with the specified permission","description":"GET /Permission/{PermissionId}/Users","tags":["finance"],"parameters":[{"name":"PermissionId","in":"query","required":true,"description":"The permission unique identifier. E.g PERM001","schema":{"type":"string","description":"The permission unique identifier. E.g PERM001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-permissions":{"get":{"operationId":"finance_payrun_get_permissions","summary":"Gets all permission objects","description":"GET /Permissions","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-permission":{"post":{"operationId":"finance_payrun_post_permission","summary":"Post permisson object","description":"POST /Permissions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-permissions-with-tag":{"get":{"operationId":"finance_payrun_get_all_permissions_with_tag","summary":"Get links to tagged Permissions","description":"GET /Permissions/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-permission-tags":{"get":{"operationId":"finance_payrun_get_all_permission_tags","summary":"Get all Permission tags","description":"GET /Permissions/Tags","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-query-response":{"post":{"operationId":"finance_payrun_get_query_response","summary":"Get the query result","description":"POST /Query","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-expression-schema":{"get":{"operationId":"finance_payrun_get_journal_expression_schema","summary":"Gets the journal expression data schema","description":"GET /ReferenceData/JournalExpressionDataTable","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-active-pay-instructions-report-output":{"get":{"operationId":"finance_payrun_get_active_pay_instructions_report_output","summary":"Runs the active pay instructions report","description":"GET /Report/ACTPAYINS/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"EmployeeKey","in":"query","required":true,"description":"The employee unique key. E.g. EE001","schema":{"type":"string","description":"The employee unique key. E.g. EE001"}},{"name":"ActiveOn","in":"query","required":false,"description":"The active date to consider. E.g 2017-04-05","schema":{"type":"string","description":"The active date to consider. E.g 2017-04-05"}},{"name":"FromDate","in":"query","required":true,"description":"The lower filter date. E.g 2016-04-06","schema":{"type":"string","description":"The lower filter date. E.g 2016-04-06"}},{"name":"ToDate","in":"query","required":false,"description":"The upper filter date. E.g 2017-04-05","schema":{"type":"string","description":"The upper filter date. E.g 2017-04-05"}},{"name":"Type","in":"query","required":false,"description":"the data type to filter on. E.g. TaxPayInstruction","schema":{"type":"string","description":"the data type to filter on. E.g. TaxPayInstruction"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-aoe-liability-report-ouput":{"get":{"operationId":"finance_payrun_get_aoe_liability_report_ouput","summary":"Runs the AOE liability report","description":"GET /Report/AOELIABILITY/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"TaxPeriod","in":"query","required":false,"description":"The tax period number.","schema":{"type":"string","description":"The tax period number."}},{"name":"TransformDefinitionKey","in":"query","required":false,"description":"The transform definition unique key. E.g. P45-Pdf","schema":{"type":"string","description":"The transform definition unique key. E.g. P45-Pdf"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-dps-message-report-output":{"get":{"operationId":"finance_payrun_get_dps_message_report_output","summary":"Runs the DPS message report","description":"GET /Report/DPSMSG/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"FromDate","in":"query","required":true,"description":"The lower filter date. E.g 2016-04-06","schema":{"type":"string","description":"The lower filter date. E.g 2016-04-06"}},{"name":"ToDate","in":"query","required":false,"description":"The upper filter date. E.g 2017-04-05","schema":{"type":"string","description":"The upper filter date. E.g 2017-04-05"}},{"name":"MessageTypes","in":"query","required":false,"description":"The DPS message types as a CSV list. E.g. P6,P9,SL1,SL2","schema":{"type":"string","description":"The DPS message types as a CSV list. E.g. P6,P9,SL1,SL2"}},{"name":"MessageStatuses","in":"query","required":false,"description":"The DPS message status as a CSV list. E.g. Retrieved,Processed,Blocked,Ignored","schema":{"type":"string","description":"The DPS message status as a CSV list. E.g. Retrieved,Processed,Blocked,Ignored"}},{"name":"StartIndex","in":"query","required":false,"description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1","schema":{"type":"string","description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1"}},{"name":"MaxIndex","in":"query","required":false,"description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100","schema":{"type":"string","description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-employer-summary-report-ouput":{"get":{"operationId":"finance_payrun_get_employer_summary_report_ouput","summary":"Runs the employer summary report","description":"GET /Report/EMPSUM/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"ContextDate","in":"query","required":true,"description":"The date context for the report. E.g. 2018-04-30","schema":{"type":"string","description":"The date context for the report. E.g. 2018-04-30"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-gross-to-net-report-output":{"get":{"operationId":"finance_payrun_get_gross_to_net_report_output","summary":"Runs the gross to net report","description":"GET /Report/GRO2NET/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"TaxPeriod","in":"query","required":false,"description":"The tax period number.","schema":{"type":"string","description":"The tax period number."}},{"name":"StartIndex","in":"query","required":false,"description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1","schema":{"type":"string","description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1"}},{"name":"MaxIndex","in":"query","required":false,"description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100","schema":{"type":"string","description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-holiday-balance-report-output":{"get":{"operationId":"finance_payrun_get_holiday_balance_report_output","summary":"Runs the holiday balance report","description":"GET /Report/HOLBAL/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"HolidayYearEnd","in":"query","required":true,"description":"The holiday year end for the report. E.g. 2018-12-31","schema":{"type":"string","description":"The holiday year end for the report. E.g. 2018-12-31"}},{"name":"EmployeeCodes","in":"query","required":false,"description":"A comma separated list of the employee codes. E.g. EMP001,EMP002","schema":{"type":"string","description":"A comma separated list of the employee codes. E.g. EMP001,EMP002"}},{"name":"StartIndex","in":"query","required":false,"description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1","schema":{"type":"string","description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1"}},{"name":"MaxIndex","in":"query","required":false,"description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100","schema":{"type":"string","description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-journal-report-ouput":{"get":{"operationId":"finance_payrun_get_journal_report_ouput","summary":"Runs the journal report","description":"GET /Report/JOURNAL/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayFrequency","in":"query","required":true,"description":"The pay frequency option. E.g. Monthly","schema":{"type":"string","description":"The pay frequency option. E.g. Monthly"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"TaxPeriod","in":"query","required":false,"description":"The tax period number.","schema":{"type":"string","description":"The tax period number."}},{"name":"LedgerTarget","in":"query","required":true,"description":"Specific to JOURNAL report, a filter used to select the journal lines for the specified ledger target. E.g. [Default]","schema":{"type":"string","description":"Specific to JOURNAL report, a filter used to select the journal lines for the specified ledger target. E.g. [Default]"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-last-pay-date-report-ouput":{"get":{"operationId":"finance_payrun_get_last_pay_date_report_ouput","summary":"Runs the last pay date report","description":"GET /Report/LASTPAYDATE/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"EmployeeKey","in":"query","required":true,"description":"The employee unique key. E.g. EE001","schema":{"type":"string","description":"The employee unique key. E.g. EE001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-net-pay-report-output":{"get":{"operationId":"finance_payrun_get_net_pay_report_output","summary":"Runs the net pay report","description":"GET /Report/NETPAY/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"TaxPeriod","in":"query","required":false,"description":"The tax period number.","schema":{"type":"string","description":"The tax period number."}},{"name":"StartIndex","in":"query","required":false,"description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1","schema":{"type":"string","description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1"}},{"name":"MaxIndex","in":"query","required":false,"description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100","schema":{"type":"string","description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-next-pay-period-dates-report-output":{"get":{"operationId":"finance_payrun_get_next_pay_period_dates_report_output","summary":"Runs the next pay period report","description":"GET /Report/NEXTPERIOD/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-p11-summary-report-output":{"get":{"operationId":"finance_payrun_get_p11_summary_report_output","summary":"Runs the P11 summary report","description":"GET /Report/P11SUM/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"StartIndex","in":"query","required":false,"description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1","schema":{"type":"string","description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1"}},{"name":"MaxIndex","in":"query","required":false,"description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100","schema":{"type":"string","description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-p32-net-report-output":{"get":{"operationId":"finance_payrun_get_p32_net_report_output","summary":"Runs the P32 report","description":"GET /Report/P32/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-p32-summary-net-report-output":{"get":{"operationId":"finance_payrun_get_p32_summary_net_report_output","summary":"Runs the P32 summary report","description":"GET /Report/P32SUM/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-p45-report-output":{"get":{"operationId":"finance_payrun_get_p45_report_output","summary":"Runs the P45 report","description":"GET /Report/P45/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"EmployeeKey","in":"query","required":true,"description":"The employee unique key. E.g. EE001","schema":{"type":"string","description":"The employee unique key. E.g. EE001"}},{"name":"TransformDefinitionKey","in":"query","required":false,"description":"The transform definition unique key. E.g. P45-Pdf","schema":{"type":"string","description":"The transform definition unique key. E.g. P45-Pdf"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-p60-report-output":{"get":{"operationId":"finance_payrun_get_p60_report_output","summary":"Runs the P60 report","description":"GET /Report/P60/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"EmployeeCodes","in":"query","required":false,"description":"A comma separated list of the employee codes. E.g. EMP001,EMP002","schema":{"type":"string","description":"A comma separated list of the employee codes. E.g. EMP001,EMP002"}},{"name":"TransformDefinitionKey","in":"query","required":false,"description":"The transform definition unique key. E.g. P45-Pdf","schema":{"type":"string","description":"The transform definition unique key. E.g. P45-Pdf"}},{"name":"StartIndex","in":"query","required":false,"description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1","schema":{"type":"string","description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1"}},{"name":"MaxIndex","in":"query","required":false,"description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100","schema":{"type":"string","description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-papdis-report-ouput":{"get":{"operationId":"finance_payrun_get_papdis_report_ouput","summary":"Runs the PAPDIS report","description":"GET /Report/PAPDIS/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"PaymentDate","in":"query","required":false,"description":"The payment date context for the report. E.g. 2018-04-30","schema":{"type":"string","description":"The payment date context for the report. E.g. 2018-04-30"}},{"name":"PensionKey","in":"query","required":true,"description":"The pension scheme unique key. E.g. PENSCH001","schema":{"type":"string","description":"The pension scheme unique key. E.g. PENSCH001"}},{"name":"MessageFunctionCode","in":"query","required":true,"description":"Specific to PAPDIS report, specifies the business function that the sender is requesting. If left BLANK it will be assumed to be 0 (Enrol…","schema":{"type":"string","description":"Specific to PAPDIS report, specifies the business function that the sender is requesting. If left BLANK it will be assumed to be 0 (Enrol…"}},{"name":"TransformDefinitionKey","in":"query","required":false,"description":"The transform definition unique key. E.g. P45-Pdf","schema":{"type":"string","description":"The transform definition unique key. E.g. P45-Pdf"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pass-report-ouput":{"get":{"operationId":"finance_payrun_get_pass_report_ouput","summary":"Runs the PASS report","description":"GET /Report/PASS/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"PaymentDate","in":"query","required":false,"description":"The payment date context for the report. E.g. 2018-04-30","schema":{"type":"string","description":"The payment date context for the report. E.g. 2018-04-30"}},{"name":"PensionKey","in":"query","required":true,"description":"The pension scheme unique key. E.g. PENSCH001","schema":{"type":"string","description":"The pension scheme unique key. E.g. PENSCH001"}},{"name":"MessageFunctionCode","in":"query","required":true,"description":"Specific to PAPDIS report, specifies the business function that the sender is requesting. If left BLANK it will be assumed to be 0 (Enrol…","schema":{"type":"string","description":"Specific to PAPDIS report, specifies the business function that the sender is requesting. If left BLANK it will be assumed to be 0 (Enrol…"}},{"name":"IntermediaryId","in":"query","required":true,"description":"Specific to PensionSync PASS report, a unique identifier for the Intermediary who is acting on behalf of the employer.","schema":{"type":"string","description":"Specific to PensionSync PASS report, a unique identifier for the Intermediary who is acting on behalf of the employer."}},{"name":"DocumentId","in":"query","required":true,"description":"Specific to PensionSync PASS report, a document identifier unique for this document within the Intermediary.","schema":{"type":"string","description":"Specific to PensionSync PASS report, a document identifier unique for this document within the Intermediary."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pay-dashboard-payslip-report-ouput":{"get":{"operationId":"finance_payrun_get_pay_dashboard_payslip_report_ouput","summary":"Runs the Pay Dashboard payslips report","description":"GET /Report/PAYDASHBOARD/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"EmployeeCodes","in":"query","required":false,"description":"A comma separated list of the employee codes. E.g. EMP001,EMP002","schema":{"type":"string","description":"A comma separated list of the employee codes. E.g. EMP001,EMP002"}},{"name":"TransformDefinitionKey","in":"query","required":false,"description":"The transform definition unique key. E.g. P45-Pdf","schema":{"type":"string","description":"The transform definition unique key. E.g. P45-Pdf"}},{"name":"StartIndex","in":"query","required":false,"description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1","schema":{"type":"string","description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1"}},{"name":"MaxIndex","in":"query","required":false,"description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100","schema":{"type":"string","description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100"}},{"name":"PaymentDate","in":"query","required":false,"description":"The payment date context for the report. E.g. 2018-04-30","schema":{"type":"string","description":"The payment date context for the report. E.g. 2018-04-30"}},{"name":"PublicationDate","in":"query","required":true,"description":"Specific to the Pay Dashboard report, allows the specification of a future payslip publication date. E.g. 2018-12-31","schema":{"type":"string","description":"Specific to the Pay Dashboard report, allows the specification of a future payslip publication date. E.g. 2018-12-31"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-payslip3-report-output":{"get":{"operationId":"finance_payrun_get_payslip3_report_output","summary":"Runs the verbose payslip report","description":"GET /Report/PAYSLIP3/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"PayScheduleKey","in":"query","required":true,"description":"The pay schedule unique key. E.g. SCH001","schema":{"type":"string","description":"The pay schedule unique key. E.g. SCH001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"EmployeeCodes","in":"query","required":false,"description":"A comma separated list of the employee codes. E.g. EMP001,EMP002","schema":{"type":"string","description":"A comma separated list of the employee codes. E.g. EMP001,EMP002"}},{"name":"TransformDefinitionKey","in":"query","required":false,"description":"The transform definition unique key. E.g. P45-Pdf","schema":{"type":"string","description":"The transform definition unique key. E.g. P45-Pdf"}},{"name":"StartIndex","in":"query","required":false,"description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1","schema":{"type":"string","description":"The element index to begin the report. Used to control paging within large data sets. E.g. 1"}},{"name":"MaxIndex","in":"query","required":false,"description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100","schema":{"type":"string","description":"The highest element index to return from the report. Used to control paging within large data sets. E.g. 100"}},{"name":"PaymentDate","in":"query","required":false,"description":"The payment date context for the report. E.g. 2018-04-30","schema":{"type":"string","description":"The payment date context for the report. E.g. 2018-04-30"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-pension-liability-report-output":{"get":{"operationId":"finance_payrun_get_pension_liability_report_output","summary":"Runs the pension liability report","description":"GET /Report/PENLIABILITY/run","tags":["finance"],"parameters":[{"name":"EmployerKey","in":"query","required":true,"description":"The employer unique key. E.g. ER001","schema":{"type":"string","description":"The employer unique key. E.g. ER001"}},{"name":"TaxYear","in":"query","required":true,"description":"The tax year. E.g. 2017 = 2017/18 year.","schema":{"type":"string","description":"The tax year. E.g. 2017 = 2017/18 year."}},{"name":"PensionKey","in":"query","required":true,"description":"The pension scheme unique key. E.g. PENSCH001","schema":{"type":"string","description":"The pension scheme unique key. E.g. PENSCH001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-report-definition-from-application":{"get":{"operationId":"finance_payrun_get_report_definition_from_application","summary":"Get the report definition","description":"GET /Report/{ReportDefinitionId}","tags":["finance"],"parameters":[{"name":"ReportDefinitionId","in":"query","required":true,"description":"The report definition unique identifier.","schema":{"type":"string","description":"The report definition unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-report-definition":{"post":{"operationId":"finance_payrun_put_report_definition","summary":"Updates a report definition","description":"PUT /Report/{ReportDefinitionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReportDefinitionId","Api-Version","body"],"properties":{"ReportDefinitionId":{"type":"string","description":"The report definition unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-report-definition":{"post":{"operationId":"finance_payrun_delete_report_definition","summary":"Deletes a report definition","description":"DELETE /Report/{ReportDefinitionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReportDefinitionId","Api-Version"],"properties":{"ReportDefinitionId":{"type":"string","description":"The report definition unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-report-output":{"get":{"operationId":"finance_payrun_get_report_output","summary":"Runs the specified report definition","description":"GET /Report/{ReportDefinitionId}/run","tags":["finance"],"parameters":[{"name":"ReportDefinitionId","in":"query","required":true,"description":"The report definition unique identifier.","schema":{"type":"string","description":"The report definition unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-report-definitions-from-application":{"get":{"operationId":"finance_payrun_get_report_definitions_from_application","summary":"Gets all reports","description":"GET /Reports","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-report-definition":{"post":{"operationId":"finance_payrun_post_report_definition","summary":"Create a new report definition","description":"POST /Reports","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-schemas":{"get":{"operationId":"finance_payrun_get_schemas","summary":"Get a list of all available schemas","description":"GET /Schemas","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-schema":{"get":{"operationId":"finance_payrun_get_schema","summary":"Get XSD schema","description":"GET /Schemas/{DtoDataType}","tags":["finance"],"parameters":[{"name":"DtoDataType","in":"query","required":true,"description":"The data transfer object type name. E.g PensionPayInstruction","schema":{"type":"string","description":"The data transfer object type name. E.g PensionPayInstruction"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-application-secret":{"get":{"operationId":"finance_payrun_get_application_secret","summary":"Get Application secret","description":"GET /Secret/{SecretId}","tags":["finance"],"parameters":[{"name":"SecretId","in":"query","required":true,"description":"The secret unique identifier. E.g ERSEC001","schema":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-application-secret":{"post":{"operationId":"finance_payrun_put_application_secret","summary":"Create a new Application secret","description":"PUT /Secret/{SecretId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SecretId","Api-Version"],"properties":{"SecretId":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-application-secret":{"post":{"operationId":"finance_payrun_delete_application_secret","summary":"Deletes Application secret","description":"DELETE /Secret/{SecretId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SecretId","Api-Version"],"properties":{"SecretId":{"type":"string","description":"The secret unique identifier. E.g ERSEC001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-application-secrets":{"get":{"operationId":"finance_payrun_get_application_secrets","summary":"Get all Application secret links","description":"GET /Secrets","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-application-secret":{"post":{"operationId":"finance_payrun_post_application_secret","summary":"Create a new Application secret","description":"POST /Secrets","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-template-model":{"get":{"operationId":"finance_payrun_get_template_model","summary":"Get the object template","description":"GET /Template/{DtoDataType}","tags":["finance"],"parameters":[{"name":"DtoDataType","in":"query","required":true,"description":"The data transfer object type name. E.g PensionPayInstruction","schema":{"type":"string","description":"The data transfer object type name. E.g PensionPayInstruction"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-templates":{"get":{"operationId":"finance_payrun_get_templates","summary":"Get a list of all available data object tempaltes","description":"GET /Templates","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-transform-definition-from-application":{"get":{"operationId":"finance_payrun_get_transform_definition_from_application","summary":"Get the transform definition","description":"GET /Transform/{TransformDefinitionId}","tags":["finance"],"parameters":[{"name":"TransformDefinitionId","in":"query","required":true,"description":"The transform definition unique identifier.","schema":{"type":"string","description":"The transform definition unique identifier."}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-transform-definition":{"post":{"operationId":"finance_payrun_put_transform_definition","summary":"Updates a transform definition","description":"PUT /Transform/{TransformDefinitionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TransformDefinitionId","Api-Version","body"],"properties":{"TransformDefinitionId":{"type":"string","description":"The transform definition unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-transform-definition":{"post":{"operationId":"finance_payrun_delete_transform_definition","summary":"Deletes a transform definition","description":"DELETE /Transform/{TransformDefinitionId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TransformDefinitionId","Api-Version"],"properties":{"TransformDefinitionId":{"type":"string","description":"The transform definition unique identifier."},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-transform-definitions-from-application":{"get":{"operationId":"finance_payrun_get_transform_definitions_from_application","summary":"Gets all transform definitions","description":"GET /Transforms","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-transform-definition":{"post":{"operationId":"finance_payrun_post_transform_definition","summary":"Create a new transform definition","description":"POST /Transforms","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version","body"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-user":{"get":{"operationId":"finance_payrun_get_user","summary":"Gets the user object","description":"GET /User/{UserId}","tags":["finance"],"parameters":[{"name":"UserId","in":"query","required":true,"description":"The user unique identifier. E.g USER001","schema":{"type":"string","description":"The user unique identifier. E.g USER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-user":{"post":{"operationId":"finance_payrun_put_user","summary":"Puts user object","description":"PUT /User/{UserId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserId","Api-Version"],"properties":{"UserId":{"type":"string","description":"The user unique identifier. E.g USER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/patch-user":{"post":{"operationId":"finance_payrun_patch_user","summary":"Patch user object","description":"PATCH /User/{UserId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserId","Api-Version"],"properties":{"UserId":{"type":"string","description":"The user unique identifier. E.g USER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-user":{"post":{"operationId":"finance_payrun_delete_user","summary":"Deletes the user object","description":"DELETE /User/{UserId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserId","Api-Version"],"properties":{"UserId":{"type":"string","description":"The user unique identifier. E.g USER001"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-user-permissions":{"get":{"operationId":"finance_payrun_get_user_permissions","summary":"Gets the user permissions","description":"GET /User/{UserId}/Permissions","tags":["finance"],"parameters":[{"name":"UserId","in":"query","required":true,"description":"The user unique identifier. E.g USER001","schema":{"type":"string","description":"The user unique identifier. E.g USER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tag-from-user":{"get":{"operationId":"finance_payrun_get_tag_from_user","summary":"Get user tag","description":"GET /User/{UserId}/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"UserId","in":"query","required":true,"description":"The user unique identifier. E.g USER001","schema":{"type":"string","description":"The user unique identifier. E.g USER001"}},{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/put-user-tag":{"post":{"operationId":"finance_payrun_put_user_tag","summary":"Insert user tag","description":"PUT /User/{UserId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserId","TagId","Api-Version"],"properties":{"UserId":{"type":"string","description":"The user unique identifier. E.g USER001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/delete-user-tag":{"post":{"operationId":"finance_payrun_delete_user_tag","summary":"Delete user tag","description":"DELETE /User/{UserId}/Tag/{TagId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserId","TagId","Api-Version"],"properties":{"UserId":{"type":"string","description":"The user unique identifier. E.g USER001"},"TagId":{"type":"string","description":"The tag unique identifier. E.g. MyTag"},"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-tags-from-user":{"get":{"operationId":"finance_payrun_get_tags_from_user","summary":"Get tags from user","description":"GET /User/{UserId}/Tags","tags":["finance"],"parameters":[{"name":"UserId","in":"query","required":true,"description":"The user unique identifier. E.g USER001","schema":{"type":"string","description":"The user unique identifier. E.g USER001"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-users":{"get":{"operationId":"finance_payrun_get_users","summary":"Gets all user objects","description":"GET /Users","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/post-user":{"post":{"operationId":"finance_payrun_post_user","summary":"Post user object","description":"POST /Users","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Api-Version"],"properties":{"Api-Version":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-users-with-tag":{"get":{"operationId":"finance_payrun_get_all_users_with_tag","summary":"Get links to tagged users","description":"GET /Users/Tag/{TagId}","tags":["finance"],"parameters":[{"name":"TagId","in":"query","required":true,"description":"The tag unique identifier. E.g. MyTag","schema":{"type":"string","description":"The tag unique identifier. E.g. MyTag"}},{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:payrun/get-all-user-tags":{"get":{"operationId":"finance_payrun_get_all_user_tags","summary":"Get all user tags","description":"GET /Users/Tags","tags":["finance"],"parameters":[{"name":"Api-Version","in":"query","required":true,"description":"The version of the api to target. Omit or set as 'default' to target the current api version.","schema":{"type":"string","default":"default","description":"The version of the api to target. Omit or set as 'default' to target the current api version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}