POST api/RefundHistories

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
id	integer	None.
PurchaseDate	date	None.
ClientId	string	None.
TotalAmount	decimal number	None.
TotalAmountPaid	decimal number	None.
TransactionRef	string	None.
TransactionId	integer	None.
Success	boolean	None.
DateCreated	date	None.
RefundDate	date	None.
RefundedBy	string	None.
NewTransactionId	integer	None.
NewTransactionRef	string	None.
AmountRefunded	decimal number	None.
VendorId	integer	None.
StockId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "PurchaseDate": "2025-12-11T10:58:19.5484412+02:00",
  "ClientId": "sample string 2",
  "TotalAmount": 1.1,
  "TotalAmountPaid": 1.1,
  "TransactionRef": "sample string 3",
  "TransactionId": 1,
  "Success": true,
  "DateCreated": "2025-12-11T10:58:19.5484412+02:00",
  "RefundDate": "2025-12-11T10:58:19.5484412+02:00",
  "RefundedBy": "sample string 6",
  "NewTransactionId": 1,
  "NewTransactionRef": "sample string 7",
  "AmountRefunded": 8.1,
  "VendorId": 1,
  "StockId": 1
}

application/xml, text/xml

Sample:

<RefundHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BonaMarketAPI.Database">
  <AmountRefunded>8.1</AmountRefunded>
  <ClientId>sample string 2</ClientId>
  <DateCreated>2025-12-11T10:58:19.5484412+02:00</DateCreated>
  <NewTransactionId>1</NewTransactionId>
  <NewTransactionRef>sample string 7</NewTransactionRef>
  <PurchaseDate>2025-12-11T10:58:19.5484412+02:00</PurchaseDate>
  <RefundDate>2025-12-11T10:58:19.5484412+02:00</RefundDate>
  <RefundedBy>sample string 6</RefundedBy>
  <StockId>1</StockId>
  <Success>true</Success>
  <TotalAmount>1.1</TotalAmount>
  <TotalAmountPaid>1.1</TotalAmountPaid>
  <TransactionId>1</TransactionId>
  <TransactionRef>sample string 3</TransactionRef>
  <VendorId>1</VendorId>
  <id>1</id>
</RefundHistory>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RefundHistory

Name	Type	Additional information
id	integer	None.
PurchaseDate	date	None.
ClientId	string	None.
TotalAmount	decimal number	None.
TotalAmountPaid	decimal number	None.
TransactionRef	string	None.
TransactionId	integer	None.
Success	boolean	None.
DateCreated	date	None.
RefundDate	date	None.
RefundedBy	string	None.
NewTransactionId	integer	None.
NewTransactionRef	string	None.
AmountRefunded	decimal number	None.
VendorId	integer	None.
StockId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "PurchaseDate": "2025-12-11T10:58:19.5484412+02:00",
  "ClientId": "sample string 2",
  "TotalAmount": 1.1,
  "TotalAmountPaid": 1.1,
  "TransactionRef": "sample string 3",
  "TransactionId": 1,
  "Success": true,
  "DateCreated": "2025-12-11T10:58:19.5484412+02:00",
  "RefundDate": "2025-12-11T10:58:19.5484412+02:00",
  "RefundedBy": "sample string 6",
  "NewTransactionId": 1,
  "NewTransactionRef": "sample string 7",
  "AmountRefunded": 8.1,
  "VendorId": 1,
  "StockId": 1
}

application/xml, text/xml

Sample:

<RefundHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BonaMarketAPI.Database">
  <AmountRefunded>8.1</AmountRefunded>
  <ClientId>sample string 2</ClientId>
  <DateCreated>2025-12-11T10:58:19.5484412+02:00</DateCreated>
  <NewTransactionId>1</NewTransactionId>
  <NewTransactionRef>sample string 7</NewTransactionRef>
  <PurchaseDate>2025-12-11T10:58:19.5484412+02:00</PurchaseDate>
  <RefundDate>2025-12-11T10:58:19.5484412+02:00</RefundDate>
  <RefundedBy>sample string 6</RefundedBy>
  <StockId>1</StockId>
  <Success>true</Success>
  <TotalAmount>1.1</TotalAmount>
  <TotalAmountPaid>1.1</TotalAmountPaid>
  <TransactionId>1</TransactionId>
  <TransactionRef>sample string 3</TransactionRef>
  <VendorId>1</VendorId>
  <id>1</id>
</RefundHistory>