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 .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 /payments/paymentApplication HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentApplicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.PaymentApplication.Response">
  <ErrorMessage>String</ErrorMessage>
  <paging>
    <next>String</next>
    <page>0</page>
    <totalPages>0</totalPages>
  </paging>
  <users>
    <PaymentApplicationUser>
      <autoPayStatus>String</autoPayStatus>
      <bhUserID>0</bhUserID>
      <fiscalYear>0</fiscalYear>
      <groupID>String</groupID>
      <userID>String</userID>
      <userTransactions>
        <UserTransaction>
          <accountLast4>String</accountLast4>
          <amount>0</amount>
          <date>String</date>
          <lineItems>
            <LineItem>
              <amount>0</amount>
              <cashAccount>String</cashAccount>
              <chartOfAccountDescription>String</chartOfAccountDescription>
              <chartOfAccountRefID>String</chartOfAccountRefID>
              <fee>0</fee>
            </LineItem>
          </lineItems>
          <refundAmount>0</refundAmount>
          <returnDate>String</returnDate>
          <returnReason>String</returnReason>
          <transactionHistory>
            <TransactionHistory>
              <date>String</date>
              <lineItems>
                <LineItem>
                  <amount>0</amount>
                  <cashAccount>String</cashAccount>
                  <chartOfAccountDescription>String</chartOfAccountDescription>
                  <chartOfAccountRefID>String</chartOfAccountRefID>
                  <fee>0</fee>
                </LineItem>
              </lineItems>
              <type>String</type>
            </TransactionHistory>
          </transactionHistory>
          <transactionID>0</transactionID>
          <type>String</type>
          <unapplied>0</unapplied>
          <unappliedFee>0</unappliedFee>
        </UserTransaction>
      </userTransactions>
    </PaymentApplicationUser>
  </users>
</PaymentApplicationResponse>