NAV

<back to all web services

FinancialTransactionsCreate

The following routes are available for this service:
POST/financial-transactions
FinancialTransactionsCreate Parameters:
NameParameterData TypeRequiredDescription
BeeNumberCustomerbodydecimal?No
TransactionTimebodyDateTime?No
TransactionIdbodystringNo
CampaignbodystringNo
TransactionCodebodystringNo
OrderNumberbodystringNo
InvoiceNumberbodystringNo
RetailSalesAmountbodydecimal?No
FederalTaxAmount1bodydecimal?No
FederalTaxAmount2bodydecimal?No
LocalTaxAmountbodydecimal?No
TransactionAmountbodydecimal?No
PaymentAmountbodydecimal?No
CustomerPricebodydecimal?No
FreeAmountbodydecimal?No
BonusAmountbodydecimal?No
DiscountPercentagebodydecimal?No
CustomerCountbodydecimal?No
PricePromotionCodebodystringNo
AccountTypebodystringNo
StatebodystringNo
TaxAreabodystringNo
TaxRatebodydecimal?No
TaxIndicatorbodystringNo
NetSalesAmountbodydecimal?No
CurrentBalancebodydecimal?No
TransactionBIDSCodebodystringNo
TransactionBillSeqbodystringNo
FinancialTransactionsCreateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CSTFinancialTransactionsGuidformdecimal?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}