Employee / Claims

Un-post a salary-packaged claim

Un-posts a salary-packaged claim (approval), replicating the legacy GUI un-post behaviour and additionally propagating the change to sp_employee_transactions in real time.

POST

/sp/approvals/unpost-claims/{approval_id}

curl --request POST \
  --url https://api.catch-e.com/sp/approvals/unpost-claims/{approval_id} \
  --header 'Authorization: <api-key>'

{
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/sp/approvals/unpost-claims/100001"
    }
  },
  "approval_id": "100001",
  "branch_executed": "posted",
  "fm_approvals_updated": 1,
  "fm_maintenance_updated": 2,
  "gl_transactions_soft_deleted": 2,
  "previous_status_flag": "posted",
  "sp_employee_transactions_updated": 2
}

The endpoint is available for approvals whose contract resolves to a posting map group of 'salary-packaged'.

The endpoint is idempotent: if the approval is already in the 'active' state (never posted, or already un-posted), a 200 response is returned with a no-op summary and zero rows updated, rather than an error. This permits safe retries after a transient failure.

This method requires the EmployeeClaims:UnPost permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

approval_idstringrequired

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

Response

Success

_linksobject

approval_idstring

branch_executedenum<string>

Available options: posted, history-only, no-op

fm_approvals_updatedinteger

fm_maintenance_updatedinteger

gl_transactions_soft_deletedinteger

previous_status_flagenum<string>

Available options: posted, history-only, active

sp_employee_transactions_updatedinteger

Still need help? Ask the team