GET api/PaymentClient/GetPaymentListingByAccountID?accountID={accountID}&showInactive={showInactive}

Request Information

URI Parameters

Name	Description	Type	Additional information
accountID		integer	Required
showInactive		boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

PaymentListVM

Name	Type	Additional information
PaymentSummaryList	Collection of PaymentSummaryByAccountID	None.
PaymentToList	Collection of PaymentToForList	None.
CurrencyCharacter	string	None.
NumberOfResults	integer	None.
Response	IResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "PaymentSummaryList": [
    {
      "PaymentID": 1,
      "Amount": 2.0,
      "Description": "sample string 3",
      "Date": "2025-09-02T23:08:29.5290478+00:00",
      "PaymentType": "sample string 4",
      "BankTransactionMethod": "sample string 5",
      "PaymentTo": "sample string 6",
      "Comm": 1.0,
      "Tax_On_Comm": 1.0,
      "InvoiceID": 1,
      "Paid_By": "sample string 7",
      "Client_Transaction_Reference": "sample string 8",
      "Client_Transaction_ID": 1,
      "Accounting_Batch_ID": 1,
      "Accounting_Batch_Date": "2025-09-02T23:08:29.5290478+00:00",
      "Created_By": "sample string 9",
      "CreateTS": "2025-09-02T23:08:29.5290478+00:00",
      "RecoveryIssueDate": "2025-09-02T23:08:29.5290478+00:00",
      "DebtReferalStatus": "sample string 10"
    },
    {
      "PaymentID": 1,
      "Amount": 2.0,
      "Description": "sample string 3",
      "Date": "2025-09-02T23:08:29.5290478+00:00",
      "PaymentType": "sample string 4",
      "BankTransactionMethod": "sample string 5",
      "PaymentTo": "sample string 6",
      "Comm": 1.0,
      "Tax_On_Comm": 1.0,
      "InvoiceID": 1,
      "Paid_By": "sample string 7",
      "Client_Transaction_Reference": "sample string 8",
      "Client_Transaction_ID": 1,
      "Accounting_Batch_ID": 1,
      "Accounting_Batch_Date": "2025-09-02T23:08:29.5290478+00:00",
      "Created_By": "sample string 9",
      "CreateTS": "2025-09-02T23:08:29.5290478+00:00",
      "RecoveryIssueDate": "2025-09-02T23:08:29.5290478+00:00",
      "DebtReferalStatus": "sample string 10"
    }
  ],
  "PaymentToList": [
    {
      "PaymentToID": 1,
      "PaymentTo": "sample string 2"
    },
    {
      "PaymentToID": 1,
      "PaymentTo": "sample string 2"
    }
  ],
  "CurrencyCharacter": "sample string 1",
  "NumberOfResults": 1,
  "Response": null
}

application/xml, text/xml

Sample:

<PaymentListVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Payment">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <CurrencyCharacter>sample string 1</CurrencyCharacter>
  <NumberOfResults>1</NumberOfResults>
  <PaymentSummaryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Payment">
    <d2p1:PaymentSummaryByAccountID>
      <d2p1:Accounting_Batch_Date>2025-09-02T23:08:29.5290478+00:00</d2p1:Accounting_Batch_Date>
      <d2p1:Accounting_Batch_ID>1</d2p1:Accounting_Batch_ID>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:BankTransactionMethod>sample string 5</d2p1:BankTransactionMethod>
      <d2p1:Client_Transaction_ID>1</d2p1:Client_Transaction_ID>
      <d2p1:Client_Transaction_Reference>sample string 8</d2p1:Client_Transaction_Reference>
      <d2p1:Comm>1</d2p1:Comm>
      <d2p1:CreateTS>2025-09-02T23:08:29.5290478+00:00</d2p1:CreateTS>
      <d2p1:Created_By>sample string 9</d2p1:Created_By>
      <d2p1:Date>2025-09-02T23:08:29.5290478+00:00</d2p1:Date>
      <d2p1:DebtReferalStatus>sample string 10</d2p1:DebtReferalStatus>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:InvoiceID>1</d2p1:InvoiceID>
      <d2p1:Paid_By>sample string 7</d2p1:Paid_By>
      <d2p1:PaymentID>1</d2p1:PaymentID>
      <d2p1:PaymentTo>sample string 6</d2p1:PaymentTo>
      <d2p1:PaymentType>sample string 4</d2p1:PaymentType>
      <d2p1:RecoveryIssueDate>2025-09-02T23:08:29.5290478+00:00</d2p1:RecoveryIssueDate>
      <d2p1:Tax_On_Comm>1</d2p1:Tax_On_Comm>
    </d2p1:PaymentSummaryByAccountID>
    <d2p1:PaymentSummaryByAccountID>
      <d2p1:Accounting_Batch_Date>2025-09-02T23:08:29.5290478+00:00</d2p1:Accounting_Batch_Date>
      <d2p1:Accounting_Batch_ID>1</d2p1:Accounting_Batch_ID>
      <d2p1:Amount>2</d2p1:Amount>
      <d2p1:BankTransactionMethod>sample string 5</d2p1:BankTransactionMethod>
      <d2p1:Client_Transaction_ID>1</d2p1:Client_Transaction_ID>
      <d2p1:Client_Transaction_Reference>sample string 8</d2p1:Client_Transaction_Reference>
      <d2p1:Comm>1</d2p1:Comm>
      <d2p1:CreateTS>2025-09-02T23:08:29.5290478+00:00</d2p1:CreateTS>
      <d2p1:Created_By>sample string 9</d2p1:Created_By>
      <d2p1:Date>2025-09-02T23:08:29.5290478+00:00</d2p1:Date>
      <d2p1:DebtReferalStatus>sample string 10</d2p1:DebtReferalStatus>
      <d2p1:Description>sample string 3</d2p1:Description>
      <d2p1:InvoiceID>1</d2p1:InvoiceID>
      <d2p1:Paid_By>sample string 7</d2p1:Paid_By>
      <d2p1:PaymentID>1</d2p1:PaymentID>
      <d2p1:PaymentTo>sample string 6</d2p1:PaymentTo>
      <d2p1:PaymentType>sample string 4</d2p1:PaymentType>
      <d2p1:RecoveryIssueDate>2025-09-02T23:08:29.5290478+00:00</d2p1:RecoveryIssueDate>
      <d2p1:Tax_On_Comm>1</d2p1:Tax_On_Comm>
    </d2p1:PaymentSummaryByAccountID>
  </PaymentSummaryList>
  <PaymentToList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.PaymentTo">
    <d2p1:PaymentToForList>
      <d2p1:PaymentTo>sample string 2</d2p1:PaymentTo>
      <d2p1:PaymentToID>1</d2p1:PaymentToID>
    </d2p1:PaymentToForList>
    <d2p1:PaymentToForList>
      <d2p1:PaymentTo>sample string 2</d2p1:PaymentTo>
      <d2p1:PaymentToID>1</d2p1:PaymentToID>
    </d2p1:PaymentToForList>
  </PaymentToList>
</PaymentListVM>