Web Services

Reserve a sequence of payment nos

Reserve a sequence of payment nos.

POST

/web-services/gl/system/reservePaymentNos

curl --request POST \
  --url https://api.catch-e.com/web-services/gl/system/reservePaymentNos \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'payment_nos=123'

{
  "payment_no_end": 100001,
  "payment_no_start": 100000
}

This method requires the WebServices 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

Body

payment_nosintegerrequired

The number of payment_nos to reserve (increment the gl_controls payment_no by this amount)

Required range: 1 <= x <= 1000

Response

Success

bodyobject

Still need help? Ask the team