API Reference
API Reference

Send purchase to eTIMS

Description

Sends a specific ETIMS purchase to the ETIMS system, allowing you to trigger either processing or cancellation of the transaction.

Parameters

Path parameter
  • id (integer): The ID of the ETIMS purchase invoice to be sent.
Header parameters
  • X-Workstation (string): The workstation ID from which the request is made. Required for audit and tracking.
  • Accept (string): Specifies the response format. Use application/json.
Body parameter
  • purchase_transaction_status (string): The action to perform. Must be either:
    • PROCESS – to process and send the purchase to ETIMS.
    • CANCELLED – to cancel the purchase transaction in ETIMS.

Example

POST /api/etims/purchases/397/send_to_etims
Accept: application/json
Content-Type: application/json

{
  "purchase_transaction_status": "PROCESS"
}

# or

{
  "purchase_transaction_status": "CANCELLED"
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

(Required) A unique identifier for the ETIMS purchase invoice.

Body Params
string
enum
required

The action to perform: PROCESS to send the purchase, or CANCELLED to cancel it.

Allowed:
Headers
string
required

[REQUIRED] Workstation ID

string
required

Response format. Use application/json.

Responses
200

Request successful.

400

Invalid request payload.

404

Purchase not found.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!