GET api/Payments?AccountNum={AccountNum}&UtilityId={UtilityId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AccountNum

integer

Required

UtilityId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Payment
NameDescriptionTypeAdditional information
PaymentId

integer

None.

LegacyPaymentId

integer

None.

AccountId

integer

None.

AccountNum

integer

None.

UtilityId

integer

None.

PaymentDate

date

None.

PaymentMethodId

integer

None.

PaymentAmount

decimal number

None.

FeesAmount

decimal number

None.

Posted

string

Max length: 1

AuthNum

string

Max length: 50

CheckNum

string

Max length: 50

Notes

string

Max length: 255

DateCreated

date

None.

DateUpdated

date

None.

CreatedBy

integer

None.

UpdatedBy

integer

None.

PaymentMethod

string

None.

ReceivedBy

string

None.

CreditCardType

string

None.

NameOnCard

string

None.

CardNumber

string

None.

ExpDate

string

None.

CVV

string

None.

RoutingNumber

string

None.

AccountNumber

string

None.

ACHCheckNumber

string

None.

ACHBankName

string

None.

PostingDetails

Collection of PaymentPostingDetail

None.

AccountNumList

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PaymentId": 1,
    "LegacyPaymentId": 1,
    "AccountId": 2,
    "AccountNum": 3,
    "UtilityId": 4,
    "PaymentDate": "2020-08-07T02:44:21.587438+00:00",
    "PaymentMethodId": 5,
    "PaymentAmount": 6.0,
    "FeesAmount": 7.0,
    "Posted": "sample string 8",
    "AuthNum": "sample string 9",
    "CheckNum": "sample string 10",
    "Notes": "sample string 11",
    "DateCreated": "2020-08-07T02:44:21.587438+00:00",
    "DateUpdated": "2020-08-07T02:44:21.587438+00:00",
    "CreatedBy": 1,
    "UpdatedBy": 1,
    "PaymentMethod": "sample string 12",
    "ReceivedBy": "sample string 13",
    "CreditCardType": "sample string 14",
    "NameOnCard": "sample string 15",
    "CardNumber": "sample string 16",
    "ExpDate": "sample string 17",
    "CVV": "sample string 18",
    "RoutingNumber": "sample string 19",
    "AccountNumber": "sample string 20",
    "ACHCheckNumber": "sample string 21",
    "ACHBankName": "sample string 22",
    "PostingDetails": [
      {
        "BillId": 1,
        "DatePosted": "2020-08-07T02:44:21.587438+00:00",
        "AmtPosted": 3.0,
        "GLCode": "sample string 4",
        "Description": "sample string 5"
      },
      {
        "BillId": 1,
        "DatePosted": "2020-08-07T02:44:21.587438+00:00",
        "AmtPosted": 3.0,
        "GLCode": "sample string 4",
        "Description": "sample string 5"
      }
    ],
    "AccountNumList": [
      1,
      2
    ]
  },
  {
    "PaymentId": 1,
    "LegacyPaymentId": 1,
    "AccountId": 2,
    "AccountNum": 3,
    "UtilityId": 4,
    "PaymentDate": "2020-08-07T02:44:21.587438+00:00",
    "PaymentMethodId": 5,
    "PaymentAmount": 6.0,
    "FeesAmount": 7.0,
    "Posted": "sample string 8",
    "AuthNum": "sample string 9",
    "CheckNum": "sample string 10",
    "Notes": "sample string 11",
    "DateCreated": "2020-08-07T02:44:21.587438+00:00",
    "DateUpdated": "2020-08-07T02:44:21.587438+00:00",
    "CreatedBy": 1,
    "UpdatedBy": 1,
    "PaymentMethod": "sample string 12",
    "ReceivedBy": "sample string 13",
    "CreditCardType": "sample string 14",
    "NameOnCard": "sample string 15",
    "CardNumber": "sample string 16",
    "ExpDate": "sample string 17",
    "CVV": "sample string 18",
    "RoutingNumber": "sample string 19",
    "AccountNumber": "sample string 20",
    "ACHCheckNumber": "sample string 21",
    "ACHBankName": "sample string 22",
    "PostingDetails": [
      {
        "BillId": 1,
        "DatePosted": "2020-08-07T02:44:21.587438+00:00",
        "AmtPosted": 3.0,
        "GLCode": "sample string 4",
        "Description": "sample string 5"
      },
      {
        "BillId": 1,
        "DatePosted": "2020-08-07T02:44:21.587438+00:00",
        "AmtPosted": 3.0,
        "GLCode": "sample string 4",
        "Description": "sample string 5"
      }
    ],
    "AccountNumList": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APL.Models">
  <Payment>
    <ACHBankName>sample string 22</ACHBankName>
    <ACHCheckNumber>sample string 21</ACHCheckNumber>
    <AccountId>2</AccountId>
    <AccountNum>3</AccountNum>
    <AccountNumList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </AccountNumList>
    <AccountNumber>sample string 20</AccountNumber>
    <AuthNum>sample string 9</AuthNum>
    <CVV>sample string 18</CVV>
    <CardNumber>sample string 16</CardNumber>
    <CheckNum>sample string 10</CheckNum>
    <CreatedBy>1</CreatedBy>
    <CreditCardType>sample string 14</CreditCardType>
    <DateCreated>2020-08-07T02:44:21.587438+00:00</DateCreated>
    <DateUpdated>2020-08-07T02:44:21.587438+00:00</DateUpdated>
    <ExpDate>sample string 17</ExpDate>
    <FeesAmount>7</FeesAmount>
    <LegacyPaymentId>1</LegacyPaymentId>
    <NameOnCard>sample string 15</NameOnCard>
    <Notes>sample string 11</Notes>
    <PaymentAmount>6</PaymentAmount>
    <PaymentDate>2020-08-07T02:44:21.587438+00:00</PaymentDate>
    <PaymentId>1</PaymentId>
    <PaymentMethod>sample string 12</PaymentMethod>
    <PaymentMethodId>5</PaymentMethodId>
    <Posted>sample string 8</Posted>
    <PostingDetails>
      <PaymentPostingDetail>
        <AmtPosted>3</AmtPosted>
        <BillId>1</BillId>
        <DatePosted>2020-08-07T02:44:21.587438+00:00</DatePosted>
        <Description>sample string 5</Description>
        <GLCode>sample string 4</GLCode>
      </PaymentPostingDetail>
      <PaymentPostingDetail>
        <AmtPosted>3</AmtPosted>
        <BillId>1</BillId>
        <DatePosted>2020-08-07T02:44:21.587438+00:00</DatePosted>
        <Description>sample string 5</Description>
        <GLCode>sample string 4</GLCode>
      </PaymentPostingDetail>
    </PostingDetails>
    <ReceivedBy>sample string 13</ReceivedBy>
    <RoutingNumber>sample string 19</RoutingNumber>
    <UpdatedBy>1</UpdatedBy>
    <UtilityId>4</UtilityId>
  </Payment>
  <Payment>
    <ACHBankName>sample string 22</ACHBankName>
    <ACHCheckNumber>sample string 21</ACHCheckNumber>
    <AccountId>2</AccountId>
    <AccountNum>3</AccountNum>
    <AccountNumList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </AccountNumList>
    <AccountNumber>sample string 20</AccountNumber>
    <AuthNum>sample string 9</AuthNum>
    <CVV>sample string 18</CVV>
    <CardNumber>sample string 16</CardNumber>
    <CheckNum>sample string 10</CheckNum>
    <CreatedBy>1</CreatedBy>
    <CreditCardType>sample string 14</CreditCardType>
    <DateCreated>2020-08-07T02:44:21.587438+00:00</DateCreated>
    <DateUpdated>2020-08-07T02:44:21.587438+00:00</DateUpdated>
    <ExpDate>sample string 17</ExpDate>
    <FeesAmount>7</FeesAmount>
    <LegacyPaymentId>1</LegacyPaymentId>
    <NameOnCard>sample string 15</NameOnCard>
    <Notes>sample string 11</Notes>
    <PaymentAmount>6</PaymentAmount>
    <PaymentDate>2020-08-07T02:44:21.587438+00:00</PaymentDate>
    <PaymentId>1</PaymentId>
    <PaymentMethod>sample string 12</PaymentMethod>
    <PaymentMethodId>5</PaymentMethodId>
    <Posted>sample string 8</Posted>
    <PostingDetails>
      <PaymentPostingDetail>
        <AmtPosted>3</AmtPosted>
        <BillId>1</BillId>
        <DatePosted>2020-08-07T02:44:21.587438+00:00</DatePosted>
        <Description>sample string 5</Description>
        <GLCode>sample string 4</GLCode>
      </PaymentPostingDetail>
      <PaymentPostingDetail>
        <AmtPosted>3</AmtPosted>
        <BillId>1</BillId>
        <DatePosted>2020-08-07T02:44:21.587438+00:00</DatePosted>
        <Description>sample string 5</Description>
        <GLCode>sample string 4</GLCode>
      </PaymentPostingDetail>
    </PostingDetails>
    <ReceivedBy>sample string 13</ReceivedBy>
    <RoutingNumber>sample string 19</RoutingNumber>
    <UpdatedBy>1</UpdatedBy>
    <UtilityId>4</UtilityId>
  </Payment>
</ArrayOfPayment>