GET OrbitalGateway/GetStatementBalance

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
ID	integer	None.
PBEntityKey	integer	None.
EndingBalance	decimal number	None.
MinimumPayment	decimal number	None.
HomeAddress	Address	None.
PaymentsAllowed	boolean	None.
payStatus	StatementPaymentStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "PBEntityKey": 2,
  "EndingBalance": 3.0,
  "MinimumPayment": 4.0,
  "HomeAddress": {
    "PBEntityAddressKey": 1,
    "PBEntityKey": 2,
    "AddressTypeValueId": 3,
    "AddressTypeDesc": "sample string 4",
    "StreetLine1": "sample string 5",
    "StreetLine2": "sample string 6",
    "City": "sample string 7",
    "State": "sample string 8",
    "Zip": "sample string 9",
    "CountryCode": "sample string 10",
    "Country": "sample string 11",
    "OverrideAddressKey": 12,
    "ZipFormatted": "sample string 9"
  },
  "PaymentsAllowed": true,
  "payStatus": 0
}

application/xml, text/xml

Sample:

<StatementOfAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VHCSAPIModels.Models">
  <EndingBalance>3</EndingBalance>
  <HomeAddress>
    <AddressTypeDesc>sample string 4</AddressTypeDesc>
    <AddressTypeValueId>3</AddressTypeValueId>
    <City>sample string 7</City>
    <Country>sample string 11</Country>
    <CountryCode>sample string 10</CountryCode>
    <OverrideAddressKey>12</OverrideAddressKey>
    <PBEntityAddressKey>1</PBEntityAddressKey>
    <PBEntityKey>2</PBEntityKey>
    <State>sample string 8</State>
    <StreetLine1>sample string 5</StreetLine1>
    <StreetLine2>sample string 6</StreetLine2>
    <Zip>sample string 9</Zip>
  </HomeAddress>
  <ID>1</ID>
  <MinimumPayment>4</MinimumPayment>
  <PBEntityKey>2</PBEntityKey>
  <PaymentsAllowed>true</PaymentsAllowed>
  <payStatus>PaymentAllowed</payStatus>
</StatementOfAccount>