Billhighway Cloud API

PaymentApplicationRequest

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


export class LineItem
{
    public chartOfAccountRefID?: string;
    public chartOfAccountDescription?: string;
    public cashAccount?: string;
    public amount?: number;
    public fee?: number;

    public constructor(init?: Partial<LineItem>) { (Object as any).assign(this, init); }
}

export class TransactionHistory
{
    public type?: string;
    public date?: string;
    public lineItems?: LineItem[];

    public constructor(init?: Partial<TransactionHistory>) { (Object as any).assign(this, init); }
}

export class UserTransaction
{
    public transactionID?: number;
    public date?: string;
    public type?: string;
    public accountLast4?: string;
    public amount?: number;
    public unapplied?: number;
    public unappliedFee?: number;
    public returnReason?: string;
    public returnDate?: string;
    public refundAmount?: number;
    public lineItems?: LineItem[];
    public transactionHistory?: TransactionHistory[];

    public constructor(init?: Partial<UserTransaction>) { (Object as any).assign(this, init); }
}

export class PaymentApplicationUser
{
    public groupID?: string;
    public fiscalYear?: number;
    public userID?: string;
    public bhUserID?: number;
    public autoPayStatus?: string;
    public userTransactions?: UserTransaction[];

    public constructor(init?: Partial<PaymentApplicationUser>) { (Object as any).assign(this, init); }
}

export class Paging
{
    public page?: number;
    public totalPages?: number;
    public next?: string;

    public constructor(init?: Partial<Paging>) { (Object as any).assign(this, init); }
}

export class PaymentApplicationResponse
{
    public IsError?: boolean;
    public users?: PaymentApplicationUser[];
    public ErrorMessage?: string;
    public paging?: Paging;

    public constructor(init?: Partial<PaymentApplicationResponse>) { (Object as any).assign(this, init); }
}

export class PaymentApplicationRequest
{
    public transactionID?: number;
    public groupID?: string;
    public userID?: string;
    public bhUserID?: number;
    public transactionBeginDate?: string;
    public transactionEndDate?: string;
    public fiscalYear?: number;
    public page?: number;

    public constructor(init?: Partial<PaymentApplicationRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>