Get a Sale

GET/api/v1/sales/{saleId}

Kenya Revenue Authority eTIMS does not expose a retrieve-sale endpoint, sales are submitted outbound only. To retrieve a specific sale, integrate a database and persist the Kenya Revenue Authority response from POST {{API_PATH}}/sales. The saleId corresponds to your invcNo or the Kenya Revenue Authority-assigned cisInvcNo.

Requires x-api-key

http://localhost:8100/api/v1/sales/{saleId}

Path Parameters

FieldTypeRequiredDescription
saleIdstringRequiredYour invoice number (invcNo) or the Kenya Revenue Authority cumulative invoice number (cisInvcNo).

Database Integration Pattern

After each call to POST {{API_PATH}}/sales, store the full request and response in your database keyed by invcNo.

Response

{
  "success": true,
  "data": {
    "invcNo": "INV-2024-001",
    "cisInvcNo": 43,
    "salesDt": "20240115",
    "totAmt": 5000,
    "intrlData": "AbCdEfGhIjKlMnOpQrStUvWxYz...",
    "rcptSign": "XxXxXxXxXxXxXxXxXxXxXxXx...",
    "sdcDateTime": "20240115103045"
  }
}
curl http://localhost:8100/api/v1/sales/INV-2024-001 \\
  -H "x-api-key: YOUR_API_KEY"