GET api/clients/{clientId}/Faring/TransactionHistory?startDate={startDate}&endDate={endDate}&transactionType={transactionType}

Gets client's account transaction history.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientId

integer

Required

startDate

date

None.

endDate

date

None.

transactionType

TransactionType

None.

Body Parameters

None.

Response Information

Resource Description

The client's account transactions.

Collection of ClientAccountTransaction
NameDescriptionTypeAdditional information
ClientId

The ID of the client.

integer

None.

TransactionAmount

The transaction amount. Debits will be negative.

decimal number

None.

AccountBalance

The account balance

decimal number

None.

TransactionDate

The time of the transaction.

date

None.

TransactionType

The transaction type

TransactionType

None.

Comments

Any comments associated with this transaction.

string

None.

BookingId

The booking ID of the transaction

integer

None.

TransactionId

The ID of the transaction.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "clientId": 1,
    "transactionAmount": 1.0,
    "accountBalance": 1.0,
    "transactionDate": "2021-06-24T02:42:29.3265175-06:00",
    "transactionType": 0,
    "comments": "sample string 2",
    "bookingId": 1,
    "transactionId": 3
  },
  {
    "clientId": 1,
    "transactionAmount": 1.0,
    "accountBalance": 1.0,
    "transactionDate": "2021-06-24T02:42:29.3265175-06:00",
    "transactionType": 0,
    "comments": "sample string 2",
    "bookingId": 1,
    "transactionId": 3
  }
]

application/xml, text/xml

Sample:
<ArrayOfClientAccountTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <ClientAccountTransaction>
    <AccountBalance>1</AccountBalance>
    <BookingId>1</BookingId>
    <ClientId>1</ClientId>
    <Comments>sample string 2</Comments>
    <TransactionAmount>1</TransactionAmount>
    <TransactionDate>2021-06-24T02:42:29.3265175-06:00</TransactionDate>
    <TransactionId>3</TransactionId>
    <TransactionType>Unknown</TransactionType>
  </ClientAccountTransaction>
  <ClientAccountTransaction>
    <AccountBalance>1</AccountBalance>
    <BookingId>1</BookingId>
    <ClientId>1</ClientId>
    <Comments>sample string 2</Comments>
    <TransactionAmount>1</TransactionAmount>
    <TransactionDate>2021-06-24T02:42:29.3265175-06:00</TransactionDate>
    <TransactionId>3</TransactionId>
    <TransactionType>Unknown</TransactionType>
  </ClientAccountTransaction>
</ArrayOfClientAccountTransaction>