NAV

<back to all web services

FinancialTransactionsGet

The following routes are available for this service:
GET/financial-transactions/{BeeNumberCustomer}/{TransactionSequence}
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 FinancialTransactionsGetViewModel:
    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
    transaction_b_i_d_s_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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialTransactionsGetResponse(GetResponse[FinancialTransactionsGetViewModel]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialTransactionsGet(IGet):
    bee_number_customer: Optional[Decimal] = None
    transaction_sequence: Optional[int] = None


TEntity = TypeVar('TEntity')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetResponse(Generic[TEntity]):
    item: Optional[TEntity] = None
    response_status: Optional[ResponseStatus] = None

Python FinancialTransactionsGet DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /financial-transactions/{BeeNumberCustomer}/{TransactionSequence} HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancialTransactionsGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <Item>
    <AccountType>String</AccountType>
    <BeeNumberCustomer>0</BeeNumberCustomer>
    <BonusAmount>0</BonusAmount>
    <Campaign>String</Campaign>
    <CurrentBalance>0</CurrentBalance>
    <CustomerCount>0</CustomerCount>
    <CustomerPrice>0</CustomerPrice>
    <DiscountPercentage>0</DiscountPercentage>
    <FederalTaxAmount1>0</FederalTaxAmount1>
    <FederalTaxAmount2>0</FederalTaxAmount2>
    <FreeAmount>0</FreeAmount>
    <InvoiceNumber>String</InvoiceNumber>
    <LocalTaxAmount>0</LocalTaxAmount>
    <NetSalesAmount>0</NetSalesAmount>
    <OperatorId>String</OperatorId>
    <OrderNumber>String</OrderNumber>
    <PRCPromotionCode>String</PRCPromotionCode>
    <PaymentAmount>0</PaymentAmount>
    <RetailSalesAmount>0</RetailSalesAmount>
    <State>String</State>
    <TaxArea>String</TaxArea>
    <TaxIndicator>String</TaxIndicator>
    <TaxRate>0</TaxRate>
    <TransactionAmount>0</TransactionAmount>
    <TransactionBIDSCode>String</TransactionBIDSCode>
    <TransactionBalanceAmount>0</TransactionBalanceAmount>
    <TransactionCode>String</TransactionCode>
    <TransactionId>String</TransactionId>
    <TransactionTime>0001-01-01T00:00:00</TransactionTime>
  </Item>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</FinancialTransactionsGetResponse>