Employee / Payments

Auto-post payments

This method requires the EmployeePayments:Create permission to be associated with your role.

POST

/sp/payments/auto-post-payments

Auto-post payments

curl --request POST \
  --url 'https://api.catch-e.com/sp/payments/auto-post-payments?timezone=UTC' \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'bank_account_id=%3Cstring%3E&common_day=1&dated_to_method=run-date&delivery=email&run_date_offset=123'

{
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/sp/payments/auto-post-payments"
    }
  },
  "control_total": 1000,
  "dated_to_date": "2021-01-01",
  "exceptions": {
    "123456": [
      "Cannot process Payment Structure 123456 Payment Period No 1 Item No 1 as current balance is not positive"
    ],
    "123457": [
      "Cannot process Payment Structure 345678 Payment Period No 3 Item No 1 due to insufficient funds'"
    ]
  },
  "processed_contracts": [
    100000
  ]
}

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

Query Parameters

timezonestringquerydefault:UTC

Payments will be processed 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\/\:\+\-\_]+$

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

bank_account_idstring

(Optional) Bank Account Id

Maximum string length: 10

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

common_dayenum<string>

(Optional) Common day

Available options: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, eom

dated_to_methodenum<string>required

Available options: run-date, common-day, run-date-plus

deliveryenum<string>required

Delivery

Available options: email, post

run_date_offsetinteger

(Optional) Run date offset

Required range: 1 <= x <= 31

Response

Success

_linksobject

control_totalnumber

dated_to_datestring

exceptionsobject

processed_contractsstring[]

Still need help? Ask the team