ReserveInterfaceBatchNosWebService

ReserveInterfaceBatchNosWebService

Legacy web service replication for reserving interface batch numbers.

Supplementary SWAGGER documentation: reserveInterfaceBatchNos

Setup

Go to Setup / Reference Data and find gbcontrols "apiwebserviceswrapper_login" control. Populate with 'web_services' user login and password for API use.

Permissions

To run this API, nominated 'web-services' role needs permission.

If not actively using, leave off for better security.

Go to Roles / APIs and check on WebServices.

Authentication

Authenticate with the API before running this API.

HTTP Method

POST

URL Examples

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

Headers

Key

Value

Notes

Mandatory

Accept

application/vnd.catch-e-api.v1+json

Required setting

Yes

Body (form-data)

Key

Value

Notes

Mandatory

interface_batch_nos

integer

Number of Interface Batch Nos to reserve. Range: 1-1,000 at a time.

Yes

Response - 201 Created

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

Response - 401 Unauthorized

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

You have not authenticated or token_timeout has passed. Authenticate again.

Response - 403 Forbidden

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

You do not have permissions. Go to System Roles, enter 'web_services', navigate to Roles / APIs and check permissions.

Response - 406 Not Acceptable

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

Accept Header must be set as application/vnd.catch-e-api.v1+json. Update and try again.

Response - 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" }

Enable Web Services. Go to Setup / Reference Data and find apiwebserviceswrapper_login control. Populate with 'web_services' user login and password.

Response - 422 Unprocessable Entity

interface_batch_nos field empty:

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

interface_batch_nos is required field. Enter number to reserve.

Negative number:

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

You may have entered negative number. interface_batch_nos must be positive. Enter value 1 or more.

Zero value:

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

You entered '0'. interface_batch_nos must be positive. Enter value 1 or more.

Input Validation Errors

Error

Notes

interface_batch_nos: Required field not provided

Enter number of interface_batch_nos to reserve

interface_batch_nos: Value must be greater than 1

Must be positive number

interface_batch_nos: Value must be less than 1000

Only 1,000 interface batch nos can be reserved at one time

Response - 424 Failed Dependency

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

API cannot run at this time. Service resource limits exceeded or system in maintenance mode.

Useful SQL

SELECT id FROM db_sequence_interface_batch_no ORDER BY id DESC LIMIT 3;

ReservePaymentNosWebService

Legacy web service replication for reserving payment numbers.

Supplementary SWAGGER documentation: reservePaymentNos

Setup

Go to Setup / Reference Data and find gbcontrols "apiwebserviceswrapper_login" control. Populate with 'web_services' user login and password for API use.

Permissions

To run this API, nominated 'web-services' role needs permission.

If not actively using, leave off for better security.

Go to Roles / APIs and check on WebServices.

Authentication

Authenticate with the API before running this API.

HTTP Method

POST

URL Examples

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

Headers

Key

Value

Notes

Mandatory

Accept

application/vnd.catch-e-api.v1+json

Required setting

Yes

Body (form-data)

Key

Value

Notes

Mandatory

payment_nos

integer

Number of Payment Nos to reserve. Range: 1-1,000 at a time.

Yes

Response - 201 Created

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

Response - 401 Unauthorized

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

You have not authenticated or token_timeout has passed. Authenticate again.

Response - 403 Forbidden

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

You do not have permissions. Go to System Roles, enter 'web_services', navigate to Roles / APIs and check permissions.

Response - 406 Not Acceptable

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

Accept Header must be set as application/vnd.catch-e-api.v1+json. Update and try again.

Response - 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" }

Enable Web Services. Go to Setup / Reference Data and find apiwebserviceswrapper_login control. Populate with 'web_services' user login and password.

Response - 422 Unprocessable Entity

payment_nos field empty:

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

payment_nos is required field. Enter number to reserve.

Negative number:

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

You may have entered negative number. payment_nos must be positive. Enter value 1 or more.

Zero value:

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

You entered '0'. payment_nos must be positive. Enter value 1 or more.

Input Validation Errors

Error

Notes

payment_nos: Required field not provided

Enter number of payment_nos to reserve

payment_nos: Value must be greater than 1

Must be positive number

payment_nos: Value must be less than 1000

Only 1,000 payment nos can be reserved at one time

Response - 424 Failed Dependency

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

API cannot run at this time. Service resource limits exceeded or system in maintenance mode.

Useful SQL

SELECT id FROM db_sequence_payment_no ORDER BY id DESC LIMIT 3;

Web Service GL System reserveBatchNos (Deprecated)

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

Reserve range of batch numbers.

Input Fields

Query String

Key

Format Notes

Mandatory

batch_nos

integer

Number of batch_nos to reserve

Yes

URL Example

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

Output Fields

XML

Element

Format Notes

Mandatory

return_status

bool

TRUE on success

Yes

batch_no_start

integer

Reserved batch_no start

Yes

batch_no_end

integer

Reserved batch_no end

Yes

Output Example

true 100021 100023

Error Codes

  • CATCH_E_ERROR_BATCH_NOS_REQUIRED

  • CATCH_E_ERROR_BATCH_NOS_INVALID

  • CATCH_E_ERROR_RESERVE_BATCH_NOS_FAILURE

  • CATCH_E_ERROR_TOO_MANY_REQUESTS

Error Output

CATCH_E_ERROR_INVALID_BATCH_NOS

Web Service GL System reservePaymentNos (Deprecated)

Warning: This web service deprecated and no longer supported by Catch-e. Use ReservePaymentNosWebService instead and contact Catch-e Support if assistance needed with setup.

Reserve range of payment numbers.

Input Fields

Query String

Key

Format Notes

Mandatory

payment_nos

integer

Number of payment_nos to reserve

Yes

URL Example

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

Output Fields

XML

Element

Format Notes

Mandatory

return_status

bool

TRUE on success

Yes

payment_no_start

integer

Reserved payment_no start

Yes

payment_no_end

integer

Reserved payment_no end

Yes

Output Example

true 100021 100023

Error Codes

  • CATCH_E_ERROR_PAYMENT_NOS_REQUIRED

  • CATCH_E_ERROR_PAYMENT_NOS_INVALID

  • CATCH_E_ERROR_RESERVE_PAYMENT_NOS_FAILURE

  • CATCH_E_ERROR_TOO_MANY_REQUESTS

Error Output

CATCH_E_ERROR_PAYMENT_NOS_REQUIRED

Useful SQL

SELECT * FROM db_sequence_payment_no ORDER BY id DESC LIMIT 3;

SpApprovalsAutoBuildClaimsEventJob

Listens for subscribed events and triggers Employee / Claims autoBuildClaims API when event received.

Event payload must include client_id field; otherwise job will not execute.

Supplementary SWAGGER documentation: api.catch-e.com/docs/?urls.primaryName=Event+Jobs#/Event%20%2F%20Jobs/spApprovalsAutoBuildClaimsEventJob

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

Permissions

Requires Events:ExecuteJob permission for executing role.

HTTP Method

POST

Body Sample

[ { "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.catch-e.com/keys/public_key_12345678.pem", "message": { "additionalProp1": {} } } ]

Response - 204 OK

No response given. Job executed successfully.

Response - 401 Unauthorized

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

You have not authenticated or token_timeout has passed. Authenticate again.

Response - 403 Forbidden

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

You do not have permissions. Go to System Roles, enter 'web_services', navigate to Roles / APIs and check permissions.

Response - 422 Unprocessable Entity

{ "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

Listens for subscribed events and triggers Employee / Claims autoPostClaims API when event received.

Event payload must include client_id field; otherwise job will not execute.

Supplementary SWAGGER documentation: api.catch-e.com/docs/?urls.primaryName=Event+Jobs#/Event%20%2F%20Jobs/spApprovalsAutoPostClaimsEventJob

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

Permissions

Requires Events:ExecuteJob permission for executing role.

HTTP Method

POST

Body Sample

[ { "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.catch-e.com/keys/public_key_12345678.pem", "message": { "additionalProp1": {} } } ]

Response - 204 OK

No response given. Job executed successfully.

Response - 401 Unauthorized

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

You have not authenticated or token_timeout has passed. Authenticate again.

Response - 403 Forbidden

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

You do not have permissions. Go to System Roles, enter 'web_services', navigate to Roles / APIs and check permissions.

Response - 422 Unprocessable Entity

{ "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.