| GET | /financial-transactions/{BeeNumberCustomer} |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialTransactionsGetListViewModel:
bee_number_customer: Optional[Decimal] = None
transaction_time: Optional[datetime.datetime] = None
transaction_id: Optional[str] = None
campaign: Optional[str] = None
transaction_code: Optional[str] = None
order_number: Optional[str] = None
invoice_number: Optional[str] = None
retail_sales_amount: Optional[Decimal] = None
federal_tax_amount1: Optional[Decimal] = None
federal_tax_amount2: Optional[Decimal] = None
local_tax_amount: Optional[Decimal] = None
transaction_amount: Optional[Decimal] = None
payment_amount: Optional[Decimal] = None
transaction_balance_amount: Optional[Decimal] = None
customer_price: Optional[Decimal] = None
free_amount: Optional[Decimal] = None
bonus_amount: Optional[Decimal] = None
discount_percentage: Optional[Decimal] = None
customer_count: Optional[Decimal] = None
prc_promotion_code: Optional[str] = None
account_type: Optional[str] = None
state: Optional[str] = None
tax_area: Optional[str] = None
tax_rate: Optional[Decimal] = None
tax_indicator: Optional[str] = None
net_sales_amount: Optional[Decimal] = None
current_balance: Optional[Decimal] = None
operator_id: Optional[str] = None
transaction_b_i_d_s_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialTransactionsGetListResponse(GetListResponse[FinancialTransactionsGetListViewModel]):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialTransactionsGetList(IGet):
bee_number_customer: Optional[Decimal] = None
start_time: Optional[datetime.datetime] = None
end_time: Optional[datetime.datetime] = None
TEntity = TypeVar('TEntity')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetListResponse(Generic[TEntity]):
items: Optional[List[TEntity]] = None
response_status: Optional[ResponseStatus] = None
Python FinancialTransactionsGetList DTOs
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.
GET /financial-transactions/{BeeNumberCustomer} HTTP/1.1
Host: extensions.avon.ca
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
items:
[
{
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,
transactionBalanceAmount: 0,
customerPrice: 0,
freeAmount: 0,
bonusAmount: 0,
discountPercentage: 0,
customerCount: 0,
prcPromotionCode: String,
accountType: String,
state: String,
taxArea: String,
taxRate: 0,
taxIndicator: String,
netSalesAmount: 0,
currentBalance: 0,
operatorId: String,
transactionBIDSCode: String
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}