GET api/SIMS/GetClientTransactionHistoryByTranTypeAndRef?tranType={tranType}&tranRef={tranRef}&companyKey={companyKey}

Gets the client transaction history according to the transaction type and reference

Request Information

URI Parameters

NameDescriptionTypeAdditional information
tranType

The transaction type to get the history for

 string

Required
tranRef

The reference to get the history for

 string

Required
companyKey

The company key if the service is connected to multiple SIMS companies (Optional)

 string

Default value is

Body Parameters

N/A


Response Information

Resource Description

Client transaction history according to the transaction type and reference

Collection of SimsTransactionDetails
NameDescriptionTypeAdditional information
ClientCode

The code of the client to which the transaction belongs to

 string

N/A
TransactionDate

The date of the transaction

 date

N/A
TransactionType

The type of transaction: CS – Cash Sales, CR – Cash Returns and IN - Invoice

 string

N/A
TransactionReference

The Transaction Reference is made up of two parts; the first 6 characters specify a unique number for the transaction, while the last two characters specify the website ID (by default this ID is usually "WB"). (e.g. 000001WB)

 string

N/A
SystemReference

The unique system reference used to keep track of the transaction in the interfacing system.

 string

N/A
StockCode

The code of the stock card being sold/returned. This stock code must already exist in the SIMS database.

 string

N/A
Quantity

The quantity of the item

 decimal number

N/A
UnitPrice

The unit price of the item

 decimal number

N/A
LineDiscount

The line discount

 decimal number

N/A
LineVat

The line VAT

 decimal number

N/A
FreeQuantity

The free quantity

 decimal number

N/A

Response Formats

application/json, text/json

Sample: 
[
  {
    "ClientCode": "sample string 1",
    "TransactionDate": "2025-12-26T22:53:39.1674926",
    "TransactionType": "sample string 3",
    "TransactionReference": "sample string 4",
    "SystemReference": "sample string 5",
    "StockCode": "sample string 6",
    "Quantity": 7.0,
    "UnitPrice": 8.0,
    "LineDiscount": 9.0,
    "LineVat": 10.0,
    "FreeQuantity": 11.0
  },
  {
    "ClientCode": "sample string 1",
    "TransactionDate": "2025-12-26T22:53:39.1674926",
    "TransactionType": "sample string 3",
    "TransactionReference": "sample string 4",
    "SystemReference": "sample string 5",
    "StockCode": "sample string 6",
    "Quantity": 7.0,
    "UnitPrice": 8.0,
    "LineDiscount": 9.0,
    "LineVat": 10.0,
    "FreeQuantity": 11.0
  }
]