Sales

Server

Sales

This section covers signing sales invoices (single and bulk), signing sales credit notes, retrieving the signed credit note status, and fetching sales transactions from eTIMS.

Sign sales invoice

POST

https://api-dev.slade360edi.com/erp

/api/etims/sign_sales_invoice

Levies (e.g. catering levy): for a line that attracts a levy, add a levies field set to the levy's name, e.g. "levies": "Catering Levy" (see the second item in the example). It is charged on top of VAT and is not reported to KRA as tax.

Example — 1,000 (VAT-incl.) × 5 at 16% VAT + 2% levy:

Component	Calculation	Amount
Net	5,000 ÷ 1.18	4,237.29
Catering levy	4,237.29 × 2%	84.75
VAT (to KRA)	5,000 − 4,237.29 − 84.75	677.96
Total		5,000.00

Sign sales invoice › Headers

X-Workstation

string · required · style: simple

[REQUIRED] Workstation ID

Example: X-Workstation

Accept

string · required · style: simple

Returns response in json format

Example: application/json

Sign sales invoice › Request Body

reference_number

string · required

customer_pin

string · required

partner_name

string · required

sales_type

string · required

customer_reference

string · required

ItemDetail[] · required

Sign sales invoice › Responses

200

No data returned

POST/api/etims/sign_sales_invoice

curl https://api-dev.slade360edi.com/erp/api/etims/sign_sales_invoice \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-Workstation: <string>' \
  --header 'Accept: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "reference_number": "INV-1222234",
  "customer_pin": "",
  "partner_name": "Test partner",
  "sales_type": "",
  "customer_reference": "211",
  "itemDetails": [
    {
      "product_name": "Testing Product 2",
      "unit_price": 100,
      "discount": 0,
      "quantity": 1,
      "uom": "pcs",
      "tax_code": "A"
    }
  ]
}'

Example Request Body

{
  "reference_number": "INV-1222234",
  "customer_pin": "",
  "partner_name": "Test partner",
  "sales_type": "",
  "customer_reference": "211",
  "itemDetails": [
    {
      "product_name": "Testing Product 2",
      "unit_price": 100,
      "discount": 0,
      "quantity": 1,
      "uom": "pcs",
      "tax_code": "A"
    }
  ]
}

json

application/json

Example Responses

No example specified for this content type

Bulk Sign Sales Invoices

POST

https://api-dev.slade360edi.com/erp

/api/etims/bulk_sign_sales_invoice

Submits a batch of sales invoices to be signed in a single request. The signing is processed asynchronously and the optional callback_url will be notified with the outcome when the job completes.

Bulk Sign Sales Invoices › Headers

X-Workstation

string · required · style: simple

[REQUIRED] Workstation ID

Example: X-Workstation

Accept

string · required · style: simple

Returns response in json format

Example: application/json

Bulk Sign Sales Invoices › Request Body

BulkSignSalesInvoiceEntry[] · required

List of invoices to sign in bulk

callback_url

string · uri

Optional URL that will be called once the bulk signing job completes

Bulk Sign Sales Invoices › Responses

Bulk signing request accepted; processing continues asynchronously and results are delivered to callback_url when available.

message

string

POST/api/etims/bulk_sign_sales_invoice

curl https://api-dev.slade360edi.com/erp/api/etims/bulk_sign_sales_invoice \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-Workstation: <string>' \
  --header 'Accept: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "invoices": [
    {
      "itemDetails": [
        {
          "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
          "product_name": "Testing Product 2",
          "unit_price": 100,
          "discount": 0,
          "quantity": 1,
          "tax_code": "A",
          "levy": "Catering"
        }
      ],
      "reference_number": "INV-1222234",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "customer_pin": "",
      "customer_slade_code": "",
      "id_number": "",
      "customer_reference": "211",
      "partner_name": "Test partner",
      "sales_type": "credit",
      "invoice_date": "2019-08-24T14:15:22Z"
    }
  ],
  "callback_url": "http://example.com"
}'

Example Request Body

{
  "invoices": [
    {
      "itemDetails": [
        {
          "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
          "product_name": "Testing Product 2",
          "unit_price": 100,
          "discount": 0,
          "quantity": 1,
          "tax_code": "A",
          "levy": "Catering"
        }
      ],
      "reference_number": "INV-1222234",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "customer_pin": "",
      "customer_slade_code": "",
      "id_number": "",
      "customer_reference": "211",
      "partner_name": "Test partner",
      "sales_type": "credit",
      "invoice_date": "2019-08-24T14:15:22Z"
    }
  ],
  "callback_url": "http://example.com"
}

json

application/json

Example Responses

{
  "message": "Bulk invoice signing process has started."
}

json

application/json

Sign sales credit note

POST

https://api-dev.slade360edi.com/erp

/api/etims/sign_sales_credit_note

Sign sales credit note › Headers

Accept

string · required · style: simple

X-Workstation

string · required · style: simple

Sign sales credit note › Request Body

invoice_reference

string · required

refund_reason

string · required

amount

number · required

Item[] · required

Sign sales credit note › Responses

200

No data returned

POST/api/etims/sign_sales_credit_note

curl https://api-dev.slade360edi.com/erp/api/etims/sign_sales_credit_note \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: <string>' \
  --header 'X-Workstation: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "invoice_reference": "INV-1222234",
  "refund_reason": "06",
  "amount": 50,
  "items": [
    {
      "item_name": "Testing Product 2",
      "quantity": 1,
      "amount": 50
    }
  ]
}'

Example Request Body

{
  "invoice_reference": "INV-1222234",
  "refund_reason": "06",
  "amount": 50,
  "items": [
    {
      "item_name": "Testing Product 2",
      "quantity": 1,
      "amount": 50
    }
  ]
}

json

application/json

Example Responses

No example specified for this content type

Get Signed Credit Note Status

GET

https://api-dev.slade360edi.com/erp

/api/etims/credit_note_signed_status

Description

Retrieves the SCU (Sales Control Unit) response for a signed credit note — i.e. the eTIMS signing status and control details returned by KRA after the credit note was signed.

Get Signed Credit Note Status › query Parameters

invoice_reference

string · required

format

string · enum

Enum values:

json

Get Signed Credit Note Status › Headers

X-Workstation

string · required

Get Signed Credit Note Status › Responses

200

Signed credit note status returned

invoice_reference

string

object[]

GET/api/etims/credit_note_signed_status

curl 'https://api-dev.slade360edi.com/erp/api/etims/credit_note_signed_status?invoice_reference=90000142026' \
  --header 'X-Workstation: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "invoice_reference": "800029393326",
  "signed_credit_notes": [
    {
      "invoice_reference": "90000142026",
      "scu_invoice_number": "KRACU0300001820/31037",
      "scu_receipt_number": 8934,
      "signature_link": "https://etims-sbx.kra.go.ke/common/link/etims/receipt/indexEtimsReceiptData?Data=P051410ICMDNWTFQQIM7OKT",
      "scu_id": "KRACU0300001820",
      "scu_mrc_number": "KRA00263541",
      "scu_receipt_signature": "ICMDNWTFQQIM7OKT",
      "scu_internal_data": "QABQUMXRDL4YEI5ISEBDQHJRDY",
      "scu_receipt_timestamp": "2025-08-06T10:28:01+03:00"
    }
  ]
}

json

application/json

Fetch sales transactions

GET

https://api-dev.slade360edi.com/erp

/api/etims/sales_transactions

Description

Fetches sales transactions from KRA (eTIMS) for the user's branch. Use the optional date query parameters to bound the results.

Query parameters

Priority	Key	Type	Description
Optional	start_date	date (YYYY-MM-DD)	Inclusive lower bound. Defaults to today when omitted.
Optional	end_date	date (YYYY-MM-DD)	Inclusive upper bound.

Required

X-Workstation - [REQUIRED] The workstation ID of the user.

Fetch sales transactions › query Parameters

start_date

string · date · style: form

Inclusive lower bound (YYYY-MM-DD). Defaults to today when omitted.

Example: 2025-07-01

end_date

string · date · style: form

Inclusive upper bound (YYYY-MM-DD).

Example: 2025-07-05

Fetch sales transactions › Headers

Accept

string · required · style: simple

Returns the response in JSON format

Example: application/json

X-Workstation

string · required · style: simple

[REQUIRED] Workstation ID

Example: X-Workstation

Fetch sales transactions › Responses

200

object[]

invoice_number

integer

reference

string

type

string | null

status

string | null

sale_date

string | null · date-time

customer_pin

string | null

customer_name

string | null

total_amount

string

total_tax_amount

string

receipt_number

integer | null

receipt_signature

string | null

Customers Purchases

Sign sales invoice

POST

https://api-dev.slade360edi.com/erp

/api/etims/sign_sales_invoice

Example — 1,000 (VAT-incl.) × 5 at 16% VAT + 2% levy:

Component	Calculation	Amount
Net	5,000 ÷ 1.18	4,237.29
Catering levy	4,237.29 × 2%	84.75
VAT (to KRA)	5,000 − 4,237.29 − 84.75	677.96
Total		5,000.00

Sign sales invoice › Headers

X-Workstation

string · required · style: simple

[REQUIRED] Workstation ID

Example: X-Workstation

Accept

string · required · style: simple

Returns response in json format

Example: application/json

Sign sales invoice › Request Body

reference_number

string · required

customer_pin

string · required

partner_name

string · required

sales_type

string · required

customer_reference

string · required

ItemDetail[] · required

Sign sales invoice › Responses

200

No data returned

Bulk Sign Sales Invoices

POST

https://api-dev.slade360edi.com/erp

/api/etims/bulk_sign_sales_invoice

Submits a batch of sales invoices to be signed in a single request. The signing is processed asynchronously and the optional callback_url will be notified with the outcome when the job completes.

Bulk Sign Sales Invoices › Headers

X-Workstation

string · required · style: simple

[REQUIRED] Workstation ID

Example: X-Workstation

Accept

string · required · style: simple

Returns response in json format

Example: application/json

Bulk Sign Sales Invoices › Request Body

BulkSignSalesInvoiceEntry[] · required

List of invoices to sign in bulk

callback_url

string · uri

Optional URL that will be called once the bulk signing job completes

Bulk Sign Sales Invoices › Responses

Bulk signing request accepted; processing continues asynchronously and results are delivered to callback_url when available.

message

string

Sign sales credit note

POST

https://api-dev.slade360edi.com/erp

/api/etims/sign_sales_credit_note

Sign sales credit note › Headers

Accept

string · required · style: simple

X-Workstation

string · required · style: simple

Sign sales credit note › Request Body

invoice_reference

string · required

refund_reason

string · required

amount

number · required

Item[] · required

Sign sales credit note › Responses

200

No data returned

Get Signed Credit Note Status

GET

https://api-dev.slade360edi.com/erp

/api/etims/credit_note_signed_status

Description

Retrieves the SCU (Sales Control Unit) response for a signed credit note — i.e. the eTIMS signing status and control details returned by KRA after the credit note was signed.

Get Signed Credit Note Status › query Parameters

invoice_reference

string · required

format

string · enum

Enum values:

json

Get Signed Credit Note Status › Headers

X-Workstation

string · required

Get Signed Credit Note Status › Responses

200

Signed credit note status returned

invoice_reference

string

object[]

Fetch sales transactions

GET

https://api-dev.slade360edi.com/erp

/api/etims/sales_transactions

Description

Fetches sales transactions from KRA (eTIMS) for the user's branch. Use the optional date query parameters to bound the results.

Query parameters

Priority	Key	Type	Description
Optional	start_date	date (YYYY-MM-DD)	Inclusive lower bound. Defaults to today when omitted.
Optional	end_date	date (YYYY-MM-DD)	Inclusive upper bound.

Required

X-Workstation - [REQUIRED] The workstation ID of the user.

Fetch sales transactions › query Parameters

start_date

string · date · style: form

Inclusive lower bound (YYYY-MM-DD). Defaults to today when omitted.

Example: 2025-07-01

end_date

string · date · style: form

Inclusive upper bound (YYYY-MM-DD).

Example: 2025-07-05

Fetch sales transactions › Headers

Accept

string · required · style: simple

Returns the response in JSON format

Example: application/json

X-Workstation

string · required · style: simple

[REQUIRED] Workstation ID

Example: X-Workstation

Fetch sales transactions › Responses

200

object[]

invoice_number

integer

reference

string

type

string | null

status

string | null

sale_date

string | null · date-time

customer_pin

string | null

customer_name

string | null

total_amount

string

total_tax_amount

string

receipt_number

integer | null

receipt_signature

string | null