Add Reverse Credit Note

POST/api/v1/reverse-credit-notes

Submit a credit note on returned goods. In Kenya Revenue Authority eTIMS, use POST {{API_PATH}}/sales/credit-note with salesSttsCd set to '05' to indicate a credit note on returned goods.

Requires x-api-key

http://localhost:8100/api/v1/reverse-credit-notes

How to Submit

Field	Type	Required	Description
original.invcNo	number	Required	Original invoice number.
original.salesSttsCd	string	Optional	Set to '05' for credit note on returned goods.
lineItems	array	Required	Items being credited.
reason	string	Required	Credit note reason code. Use '05' (credit note on returned goods).

Request

{
  "original": {
    "invcNo": 42,
    "trdInvcNo": "INV-2024-001",
    "creditNoteInvcNo": 10042,
    "salesSttsCd": "05",
    "pmtTyCd": "09"
  },
  "reason": "05",
  "regrId": "USR01",
  "regrNm": "Admin",
  "lineItems": [
    {
      "itemCd": "SV0000000Z001",
      "itemNm": "Monthly SaaS Subscription",
      "qtyUnitCd": "U",
      "qty": 1,
      "prc": 5000,
      "taxTyCd": "B",
      "taxblAmt": 4310.34,
      "taxAmt": 689.66,
      "totAmt": 5000
    }
  ]
}

Response

{
  "success": true,
  "message": "Credit note submitted to Kenya Revenue Authority.",
  "data": {
    "cisInvcNo": 45,
    "intrlData": "AbCdEfGhIjKlMnOpQrStUvWxYz...",
    "rcptSign": "XxXxXxXxXxXxXxXxXxXxXxXx...",
    "sdcDateTime": "20240116110000"
  }
}

curl -X POST http://localhost:8100/api/v1/sales/credit-note \\
  -H "x-api-key: YOUR_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "original": { "invcNo": 42, "salesSttsCd": "05", "pmtTyCd": "09" },
    "reason": "05",
    "regrId": "USR01",
    "regrNm": "Admin",
    "lineItems": [{
      "itemCd": "SV0000000Z001",
      "itemNm": "Item",
      "qtyUnitCd": "U",
      "qty": 1,
      "prc": 5000,
      "taxTyCd": "B",
      "taxblAmt": 4310.34,
      "taxAmt": 689.66,
      "totAmt": 5000
    }]
  }'