Employee / Claims

Auto-post claims

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

POST

/sp/approvals/auto-post-claims

Auto-post claims

curl --request POST \
  --url https://api.catch-e.com/sp/approvals/auto-post-claims \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'allowable_funds_balance=0&claim_selection_method=approval-date-earliest&client_id=%3Cstring%3E&disbursement_date=2023-12-25&override_warnings_flag=no&pay_cycle_id=%3Cstring%3E&pay_run_id=%3Cstring%3E&timezone=UTC'

{
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/sp/approvals/auto-post-claims"
    }
  },
  "exceptions": {
    "123456": [
      "Insufficient funds - remaining funds balance 5.00"
    ]
  },
  "processed_claims": [
    100000,
    100001,
    100002
  ]
}

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

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

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

Body

allowable_funds_balancenumberdefault:0

Allowable Funds Balance

claim_selection_methodenum<string>required

Available options: approval-date-earliest, approval-id-smallest, total-smallest, total-largest

client_idstring

Client Id

Maximum string length: 10

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

disbursement_datestring

Single date in ISO format Y-m-d (e.g. 2026-07-21). Bulk requests only match regular pay runs (ad-hoc pay runs are excluded). client_id and pay_cycle_id further narrow the selection. If pay_run_id is also provided, it must match the resolved pay run; otherwise, an overridable warning is raised.

Maximum string length: 10

override_warnings_flagenum<string>default:no

Override warning validation. Defaults to 'no'.

Available options: yes, no

pay_cycle_idstring

Pay Cycle Id

Maximum string length: 10

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

pay_run_idstring

Pay Run Id. Restricts to one pay run - posting is limited to claims on contracts linked to it, that is contracts sharing the pay run's client and pay cycle.

An ad-hoc value raises an overridable warning (proceeds only with override_warnings_flag = yes).

Takes precedence over disbursement_date and over any supplied client_id/pay_cycle_id.

timezonestringdefault:UTC

Claims will be raised in the specified timezone.

The timezone value can be given in several formats, none of which are case sensitive:

As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'.
As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. A leading zero can optionally be used for hours values less than 10;

Maximum string length: 100

Pattern: ^[a-zA-Z0-9\/\:\+\-\_]+$

Response

Success

_linksobject

exceptionsobject

processed_claimsstring[]

Still need help? Ask the team