| POST | /financial-transactions |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BeeNumberCustomer | body | decimal? | No | |
| TransactionTime | body | DateTime? | No | |
| TransactionId | body | string | No | |
| Campaign | body | string | No | |
| TransactionCode | body | string | No | |
| OrderNumber | body | string | No | |
| InvoiceNumber | body | string | No | |
| RetailSalesAmount | body | decimal? | No | |
| FederalTaxAmount1 | body | decimal? | No | |
| FederalTaxAmount2 | body | decimal? | No | |
| LocalTaxAmount | body | decimal? | No | |
| TransactionAmount | body | decimal? | No | |
| PaymentAmount | body | decimal? | No | |
| CustomerPrice | body | decimal? | No | |
| FreeAmount | body | decimal? | No | |
| BonusAmount | body | decimal? | No | |
| DiscountPercentage | body | decimal? | No | |
| CustomerCount | body | decimal? | No | |
| PricePromotionCode | body | string | No | |
| AccountType | body | string | No | |
| State | body | string | No | |
| TaxArea | body | string | No | |
| TaxRate | body | decimal? | No | |
| TaxIndicator | body | string | No | |
| NetSalesAmount | body | decimal? | No | |
| CurrentBalance | body | decimal? | No | |
| TransactionBIDSCode | body | string | No | |
| TransactionBillSeq | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| CSTFinancialTransactionsGuid | form | decimal? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /financial-transactions HTTP/1.1
Host: extensions.avon.ca
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
beeNumberCustomer: 0,
transactionTime: 0001-01-01T00:00:00,
transactionId: String,
campaign: String,
transactionCode: String,
orderNumber: String,
invoiceNumber: String,
retailSalesAmount: 0,
federalTaxAmount1: 0,
federalTaxAmount2: 0,
localTaxAmount: 0,
transactionAmount: 0,
paymentAmount: 0,
customerPrice: 0,
freeAmount: 0,
bonusAmount: 0,
discountPercentage: 0,
customerCount: 0,
pricePromotionCode: String,
accountType: String,
state: String,
taxArea: String,
taxRate: 0,
taxIndicator: String,
netSalesAmount: 0,
currentBalance: 0,
transactionBIDSCode: String,
transactionBillSeq: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
cstFinancialTransactionsGuid: 0
}