POST api/PurchaseHistories
Request Information
URI Parameters
None.
Body Parameters
PurchaseHistory| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
None. |
|
| PurchaseDate | date |
None. |
|
| ClientId | string |
None. |
|
| TotalAmount | decimal number |
None. |
|
| TotalAmountPaid | decimal number |
None. |
|
| TransactionRef | string |
None. |
|
| TransactionType | integer |
None. |
|
| TransactionId | integer |
None. |
|
| Success | boolean |
None. |
|
| Reason | string |
None. |
|
| TransactionSource | integer |
None. |
|
| TransactionFeesAmount | decimal number |
None. |
|
| VatAmount | decimal number |
None. |
|
| MerchantAmount | decimal number |
None. |
|
| BonaitVat | decimal number |
None. |
|
| TransactionName | string |
None. |
|
| MerchantUserId | string |
None. |
|
| VendorId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": 1,
"PurchaseDate": "2025-12-11T10:58:19.438775+02:00",
"ClientId": "sample string 2",
"TotalAmount": 1.1,
"TotalAmountPaid": 1.1,
"TransactionRef": "sample string 3",
"TransactionType": 1,
"TransactionId": 1,
"Success": true,
"Reason": "sample string 5",
"TransactionSource": 6,
"TransactionFeesAmount": 7.1,
"VatAmount": 8.1,
"MerchantAmount": 9.1,
"BonaitVat": 10.1,
"TransactionName": "sample string 11",
"MerchantUserId": "sample string 12",
"VendorId": 1
}
application/xml, text/xml
Sample:
<PurchaseHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BonaMarketAPI.Database"> <BonaitVat>10.1</BonaitVat> <ClientId>sample string 2</ClientId> <MerchantAmount>9.1</MerchantAmount> <MerchantUserId>sample string 12</MerchantUserId> <PurchaseDate>2025-12-11T10:58:19.438775+02:00</PurchaseDate> <Reason>sample string 5</Reason> <Success>true</Success> <TotalAmount>1.1</TotalAmount> <TotalAmountPaid>1.1</TotalAmountPaid> <TransactionFeesAmount>7.1</TransactionFeesAmount> <TransactionId>1</TransactionId> <TransactionName>sample string 11</TransactionName> <TransactionRef>sample string 3</TransactionRef> <TransactionSource>6</TransactionSource> <TransactionType>1</TransactionType> <VatAmount>8.1</VatAmount> <VendorId>1</VendorId> <id>1</id> </PurchaseHistory>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PurchaseHistory| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
None. |
|
| PurchaseDate | date |
None. |
|
| ClientId | string |
None. |
|
| TotalAmount | decimal number |
None. |
|
| TotalAmountPaid | decimal number |
None. |
|
| TransactionRef | string |
None. |
|
| TransactionType | integer |
None. |
|
| TransactionId | integer |
None. |
|
| Success | boolean |
None. |
|
| Reason | string |
None. |
|
| TransactionSource | integer |
None. |
|
| TransactionFeesAmount | decimal number |
None. |
|
| VatAmount | decimal number |
None. |
|
| MerchantAmount | decimal number |
None. |
|
| BonaitVat | decimal number |
None. |
|
| TransactionName | string |
None. |
|
| MerchantUserId | string |
None. |
|
| VendorId | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"PurchaseDate": "2025-12-11T10:58:19.438775+02:00",
"ClientId": "sample string 2",
"TotalAmount": 1.1,
"TotalAmountPaid": 1.1,
"TransactionRef": "sample string 3",
"TransactionType": 1,
"TransactionId": 1,
"Success": true,
"Reason": "sample string 5",
"TransactionSource": 6,
"TransactionFeesAmount": 7.1,
"VatAmount": 8.1,
"MerchantAmount": 9.1,
"BonaitVat": 10.1,
"TransactionName": "sample string 11",
"MerchantUserId": "sample string 12",
"VendorId": 1
}
application/xml, text/xml
Sample:
<PurchaseHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BonaMarketAPI.Database"> <BonaitVat>10.1</BonaitVat> <ClientId>sample string 2</ClientId> <MerchantAmount>9.1</MerchantAmount> <MerchantUserId>sample string 12</MerchantUserId> <PurchaseDate>2025-12-11T10:58:19.438775+02:00</PurchaseDate> <Reason>sample string 5</Reason> <Success>true</Success> <TotalAmount>1.1</TotalAmount> <TotalAmountPaid>1.1</TotalAmountPaid> <TransactionFeesAmount>7.1</TransactionFeesAmount> <TransactionId>1</TransactionId> <TransactionName>sample string 11</TransactionName> <TransactionRef>sample string 3</TransactionRef> <TransactionSource>6</TransactionSource> <TransactionType>1</TransactionType> <VatAmount>8.1</VatAmount> <VendorId>1</VendorId> <id>1</id> </PurchaseHistory>