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 .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 /paydown2 HTTP/1.1 
Host: extensions.avon.ca 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	beeNumber: 0,
	transactionDate: 0001-01-01T00:00:00,
	source: String,
	salesCenterID: String,
	payments: 
	[
		{
			paymentType: String,
			paymentAmount: 0
		}
	],
	fees: 
	[
		{
			feeSystemKeyword: String,
			feeAmount: 0
		}
	]
}
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
		}
	}
}