NAV

<back to all web services

Paydown2

The following routes are available for this service:
POST/paydown2
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 PaydownResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaydownPayment:
    payment_type: Optional[str] = None
    payment_amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaydownPaymentFee:
    fee_system_keyword: Optional[str] = None
    fee_amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Paydown2(IPost):
    bee_number: Optional[Decimal] = None
    transaction_date: Optional[datetime.datetime] = None
    source: Optional[str] = None
    sales_center_i_d: Optional[str] = None
    payments: Optional[List[PaydownPayment]] = None
    fees: Optional[List[PaydownPaymentFee]] = None

Python Paydown2 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.

POST /paydown2 HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Paydown2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <BeeNumber>0</BeeNumber>
  <Fees>
    <PaydownPaymentFee>
      <FeeAmount>0</FeeAmount>
      <FeeSystemKeyword>String</FeeSystemKeyword>
    </PaydownPaymentFee>
  </Fees>
  <Payments>
    <PaydownPayment>
      <PaymentAmount>0</PaymentAmount>
      <PaymentType>String</PaymentType>
    </PaydownPayment>
  </Payments>
  <SalesCenterID>String</SalesCenterID>
  <Source>String</Source>
  <TransactionDate>0001-01-01T00:00:00</TransactionDate>
</Paydown2>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaydownResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <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>
</PaydownResponse>