Data & Automation API: ReserveInterfaceBatchNosWebService

ReserveInterfaceBatchNosWebService

This API replicates legacy web service reserveInterfaceBatchNos.

Supplementary SWAGGER documentation is available here: reserveInterfaceBatchNos

Enable

Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapper_login" control.

Populate this control with a 'web_services' user login and password.
This user will be used to run the API from within code.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on WebServices.

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.test.catch-e.com/web-services/gl/system/reserveInterfaceBatchNos

Headers

Body (form-data)

Response Details

{ "interface_batch_no_start": XXXXXX, "interface_batch_no_end": XXXXX}

| 401 - Unauthorized | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 406 - Not Acceptable | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Cannot honor Accept type specified"}

| The Accept Header must be set as 'application/octet-stream'. Update the Accept Header and try again. |
| 418 - Invalid Credentials | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Invalid Credentials", "status": 418, "detail": "Web services API wrapper credentials have not been configured"}

| You need to enable Web Services Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapperlogin" control. Populate this control with a 'webservices' user login and password. This user will be used to run the API from within code. |
| Input validation errors | | |

For 'interface_batch_nos': Required field is not provided.For 'interface_batch_nos': Value must be greater than 1.For 'interface_batch_nos': Value must be less than 1000.

| 'interfacebatchnos' is a required field. Enter the number of batchnos you wish to reserve. 'interfacebatch_nos' must be a positive number. Enter a value that is between 1 and 1,000. Only 1,000 interface batch nos can be reserved at one time. |
| 422 - Unprocessable Content Input | | |

 "interface_batch_nos": { "isEmpty": "Value is required and can't be empty" }

| You have not passed a value for 'interfacebatchnos'. 'interfacebatchnos' is a required field, enter the number of interfacebatchnos you wish to reserve. | |

 "interface_batch_nos": { "notDigits": "The input must contain only digits" }

| You may have entered a negative number. 'interfacebatchnos' must be a positive number. Enter a value that is 1 or more. | |

 "web_service_error": { "CATCH_E_ERROR_BATCH_NOS_INVALID": "Invalid batch_nos value. Must be a positive integer." }

| You have entered '0'. 'interfacebatchnos' must be a positive number. Enter a value that is 1 or more. |
| 424 - Failed Dependency | | |

 "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Failed Dependency", "status": 422, "detail": "Upstream service temporarily unavailable. Please retry."}

| The API cannot run at this time. This can happen for a various reasons, for example: service resource limits have been exceeded the system is in maintenance mode |

Useful SQL

SELECT idFROM db_sequence_interface_batch_noORDER BY id DESCLIMIT 3;

ReservePaymentNosWebService

This API replicates legacy web service reservePaymentNos.

Supplementary SWAGGER documentation is available here: reservePaymentNos

Enable

Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapper_login" control.

Populate this control with a 'web_services' user login and password.
This user will be used to run the API from within code.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on WebServices.

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

URL Examples

https://api.test.catch-e.com/web-services/gl/system/reservePaymentNos

Headers

Body (form-data)

Response Details

{ "payment_no_start": XXXXXX, "payment_no_end": XXXXX}

| 401 - Unauthorized | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 406 - Not Acceptable | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Cannot honor Accept type specified"}

| The Accept Header must be set as 'application/octet-stream'. Update the Accept Header and try again. |
| 418 - Invalid Credentials | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Invalid Credentials", "status": 418, "detail": "Web services API wrapper credentials have not been configured"}

| You need to enable Web Services Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapperlogin" control. Populate this control with a 'webservices' user login and password. This user will be used to run the API from within code. |
| Input validation errors | | |

For 'payment_nos': Required field is not provided.For 'payment_nos': Value must be greater than 1.For 'payment_nos': Value must be less than 1000.

| 'paymentnos' is a required field. Enter the number of batchnos you wish to reserve. 'payment_nos' must be a positive number. Enter a value that is between 1 and 1,000. Only 1,000 interface batch nos can be reserved at one time. |
| 422 - Unprocessable Content Input | | |

 "payment_nos": { "isEmpty": "Value is required and can't be empty" }

| You have not passed a value for 'paymentnos'. 'paymentnos' is a required field, enter the number of payment_nos you wish to reserve. | |

 "payment_nos": { "notDigits": "The input must contain only digits" }

| You may have entered a negative number. 'payment_nos' must be a positive number. Enter a value that is 1 or more. | |

 "web_service_error": { "CATCH_E_ERROR_BATCH_NOS_INVALID": "Invalid payment_nos value. Must be a positive integer." }

| You have entered '0'. 'payment_nos' must be a positive number. Enter a value that is 1 or more. |
| 424 - Failed Dependency | | |

 "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Failed Dependency", "status": 422, "detail": "Upstream service temporarily unavailable. Please retry."}

| The API cannot run at this time. This can happen for a various reasons, for example: service resource limits have been exceeded the system is in maintenance mode |

Useful SQL

SELECT idFROM db_sequence_payment_noORDER BY id DESCLIMIT 3;

Web service Gl System reserveBatchNos

Synopsis

Reserve a range of batch numbers.

Warning: This web service has been deprecated and can no longer be run.
Use ReserveBatchNosWebService instead.

Input Fields

Input URL Example

https://yourname.catch-e.net.au/services/gl/system/reserveBatchNos?batch_nos=3

Output Fields

Output Example

true 100021 100023

Error Codes

Error Output

CATCHEERRORINVALIDBATCH_NOS

Web service Gl System reservePaymentNos

Warning: This web service has been deprecated and is no longer supported by Catch-e.
You must use ReservePaymentNosWebService instead and contact Catch-e Support if you need assistance with the set-up.

Reserve a range of payment numbers.

Input Fields

Input URL Example

https://yourname.catch-e.net.au/services/gl/system/reservePaymentNos?payment_nos=3

Output Fields

Output Example

true 100021 100023

Error Codes

Error Output

CATCHEERRORPAYMENTNOS_REQUIRED

Useful SQL

SELECT *FROM db_sequence_payment_noORDER BY id DESCLIMIT 3;

SpApprovalsAutoBuildClaimsEventJob

This method listens for subscribed events and triggers the Employee / Claims autoBuildClaims API when an event is received.

The event payload must include a client_id field; otherwise, the job will not execute.

Supplementary SWAGGER documentation is available here: https://api.test.catch-e.com/docs/Event/Jobs/spApprovalsAutoBuildClaimsEventJob(https://api.test.catch-e.com/docs/?urls.primaryName=Event+Jobs#/Event%20%2F%20Jobs/spApprovalsAutoBuildClaimsEventJob|).

Note: This API is not configured for external use. By design it only ever be called by the system.

Permissions

This method requires the Events:ExecuteJob permission to be associated with the executing role.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

Body Sample

Auto Build Claims Event Job

[ { "messageId": "367326e8-a25c-5704-8146-46250ac8fd68", "timestamp": "2025-07-23", "clientId": "demo", "userId": "10824", "environment": "test", "eventType": "receipts.batch.posted", "subscriptionId": "14729133173082438610", "signingCertURL": "https://api.test.catch-e.com/keys/public_key_12345678.pem", "message": { "additionalProp1": {} }}]

Response Details

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 422 - Unprocessable Content | | |

{ "validation_messages": { "subscriptionId": { "noRecordFound": "No record matching the input was found" }, "message": { "posting_class_id": { "isEmpty": "Value is required and can't be empty" }, "client_id": { "isEmpty": "Value is required and can't be empty" } } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}

| Body parameters not found/valid. |

SpApprovalsAutoPostClaimsEventJob

This method listens for subscribed events and triggers the Employee / Claims autoPostClaims API when an event is received.

The event payload must include a client_id field; otherwise, the job will not execute.

Supplementary SWAGGER documentation is available here: https://api.test.catch-e.com/docs/Event/Jobs/spApprovalsAutoPostClaimsEventJob(https://api.test.catch-e.com/docs/?urls.primaryName=Event+Jobs#/Event%20%2F%20Jobs/spApprovalsAutoPostClaimsEventJob|).

Note: This API is not configured for external use. By design it only ever be called by the system.

Permissions

This method requires the Events:ExecuteJob permission to be associated with the executing role.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

Body Sample

Auto Build Claims Event Job

[ { "messageId": "367326e8-a25c-5704-8146-46250ac8fd68", "timestamp": "2025-07-23", "clientId": "demo", "userId": "10824", "environment": "test", "eventType": "receipts.batch.posted", "subscriptionId": "14729133173082438610", "signingCertURL": "https://api.test.catch-e.com/keys/public_key_12345678.pem", "message": { "additionalProp1": {} }}]

Response Details

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 422 - Unprocessable Content | | |

{ "validation_messages": { "subscriptionId": { "noRecordFound": "No record matching the input was found" }, "message": { "posting_class_id": { "isEmpty": "Value is required and can't be empty" }, "client_id": { "isEmpty": "Value is required and can't be empty" } } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}

| Body parameters not found/valid. |