Billhighway Cloud API

PaymentApplicationRequest

The following routes are available for this service:
GET	/payments/paymentApplication

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 LineItem:
    chart_of_account_ref_i_d: Optional[str] = None
    chart_of_account_description: Optional[str] = None
    cash_account: Optional[str] = None
    amount: Optional[Decimal] = None
    fee: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionHistory:
    type: Optional[str] = None
    date: Optional[str] = None
    line_items: Optional[List[LineItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserTransaction:
    transaction_i_d: Optional[int] = None
    date: Optional[str] = None
    type: Optional[str] = None
    account_last4: Optional[str] = None
    amount: Optional[Decimal] = None
    unapplied: Optional[Decimal] = None
    unapplied_fee: Optional[Decimal] = None
    return_reason: Optional[str] = None
    return_date: Optional[str] = None
    refund_amount: Optional[Decimal] = None
    line_items: Optional[List[LineItem]] = None
    transaction_history: Optional[List[TransactionHistory]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentApplicationUser:
    group_i_d: Optional[str] = None
    fiscal_year: Optional[int] = None
    user_i_d: Optional[str] = None
    bh_user_i_d: Optional[int] = None
    auto_pay_status: Optional[str] = None
    user_transactions: Optional[List[UserTransaction]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Paging:
    page: Optional[int] = None
    total_pages: Optional[int] = None
    next: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentApplicationResponse:
    is_error: Optional[bool] = None
    users: Optional[List[PaymentApplicationUser]] = None
    error_message: Optional[str] = None
    paging: Optional[Paging] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentApplicationRequest:
    transaction_i_d: Optional[int] = None
    group_i_d: Optional[str] = None
    user_i_d: Optional[str] = None
    bh_user_i_d: Optional[int] = None
    transaction_begin_date: Optional[datetime.datetime] = None
    transaction_end_date: Optional[datetime.datetime] = None
    fiscal_year: Optional[int] = None
    page: Optional[int] = None

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

GET /payments/paymentApplication HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsError: True,
	users: 
	[
		{
			groupID: String,
			fiscalYear: 0,
			userID: String,
			bhUserID: 0,
			autoPayStatus: String,
			userTransactions: 
			[
				{
					transactionID: 0,
					date: String,
					type: String,
					accountLast4: String,
					amount: 0,
					unapplied: 0,
					unappliedFee: 0,
					returnReason: String,
					returnDate: String,
					refundAmount: 0,
					lineItems: 
					[
						{
							chartOfAccountRefID: String,
							chartOfAccountDescription: String,
							cashAccount: String,
							amount: 0,
							fee: 0
						}
					],
					transactionHistory: 
					[
						{
							type: String,
							date: String,
							lineItems: 
							[
								{
									chartOfAccountRefID: String,
									chartOfAccountDescription: String,
									cashAccount: String,
									amount: 0,
									fee: 0
								}
							]
						}
					]
				}
			]
		}
	],
	ErrorMessage: String,
	paging: 
	{
		page: 0,
		totalPages: 0,
		next: String
	}
}