GET api/CustomerDetails/GetPaymentHistory?APiToken={APiToken}&CustomerID={CustomerID}&PageNumber={PageNumber}&PageSize={PageSize}

Api to get Payment History

Request Information

URI Parameters

Name	Type	Additional information
APiToken	string	None.
CustomerID	integer	None.
PageNumber	integer	None.
PageSize	integer	None.

Body Parameters

None.

Response Information

Resource Description

CustomerPaymentHistoryDataModel

Name	Type	Additional information
PaymentHistory	Collection of CustomerPaymentHistoryDM	None.
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "paymentHistory": [
    {
      "invoicePaymentID": 1,
      "invoiceID": 2,
      "invoiceCode": "sample string 3",
      "paidAmount": 4.0,
      "addedDate": "2025-07-17T05:29:33.3367965+00:00",
      "paymentRef": "sample string 6",
      "paymentMethod": "sample string 7",
      "companyName": "sample string 8",
      "customerCode": "sample string 9",
      "emailID": "sample string 10",
      "addedByName": "sample string 11",
      "recordCount": 12
    },
    {
      "invoicePaymentID": 1,
      "invoiceID": 2,
      "invoiceCode": "sample string 3",
      "paidAmount": 4.0,
      "addedDate": "2025-07-17T05:29:33.3367965+00:00",
      "paymentRef": "sample string 6",
      "paymentMethod": "sample string 7",
      "companyName": "sample string 8",
      "customerCode": "sample string 9",
      "emailID": "sample string 10",
      "addedByName": "sample string 11",
      "recordCount": 12
    }
  ],
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CustomerPaymentHistoryDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel">
  <Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</Code>
  <Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message>
  <ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</ReturnID>
  <Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful>
  <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</TotalRecord>
  <PaymentHistory>
    <CustomerPaymentHistoryDM>
      <AddedByName>sample string 11</AddedByName>
      <AddedDate>2025-07-17T05:29:33.3367965+00:00</AddedDate>
      <CompanyName>sample string 8</CompanyName>
      <CustomerCode>sample string 9</CustomerCode>
      <EmailID>sample string 10</EmailID>
      <InvoiceCode>sample string 3</InvoiceCode>
      <InvoiceID>2</InvoiceID>
      <InvoicePaymentID>1</InvoicePaymentID>
      <PaidAmount>4</PaidAmount>
      <PaymentMethod>sample string 7</PaymentMethod>
      <PaymentRef>sample string 6</PaymentRef>
      <RecordCount>12</RecordCount>
    </CustomerPaymentHistoryDM>
    <CustomerPaymentHistoryDM>
      <AddedByName>sample string 11</AddedByName>
      <AddedDate>2025-07-17T05:29:33.3367965+00:00</AddedDate>
      <CompanyName>sample string 8</CompanyName>
      <CustomerCode>sample string 9</CustomerCode>
      <EmailID>sample string 10</EmailID>
      <InvoiceCode>sample string 3</InvoiceCode>
      <InvoiceID>2</InvoiceID>
      <InvoicePaymentID>1</InvoicePaymentID>
      <PaidAmount>4</PaidAmount>
      <PaymentMethod>sample string 7</PaymentMethod>
      <PaymentRef>sample string 6</PaymentRef>
      <RecordCount>12</RecordCount>
    </CustomerPaymentHistoryDM>
  </PaymentHistory>
</CustomerPaymentHistoryDataModel>

multipart/form-data

Sample:

<CustomerPaymentHistoryDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMMS_V2.Core.DataModel"><Code xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">4</Code><Message xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">sample string 2</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">1</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">5</TotalRecord><PaymentHistory><CustomerPaymentHistoryDM><AddedByName>sample string 11</AddedByName><AddedDate>2025-07-17T05:29:33.3367965+00:00</AddedDate><CompanyName>sample string 8</CompanyName><CustomerCode>sample string 9</CustomerCode><EmailID>sample string 10</EmailID><InvoiceCode>sample string 3</InvoiceCode><InvoiceID>2</InvoiceID><InvoicePaymentID>1</InvoicePaymentID><PaidAmount>4</PaidAmount><PaymentMethod>sample string 7</PaymentMethod><PaymentRef>sample string 6</PaymentRef><RecordCount>12</RecordCount></CustomerPaymentHistoryDM><CustomerPaymentHistoryDM><AddedByName>sample string 11</AddedByName><AddedDate>2025-07-17T05:29:33.3367965+00:00</AddedDate><CompanyName>sample string 8</CompanyName><CustomerCode>sample string 9</CustomerCode><EmailID>sample string 10</EmailID><InvoiceCode>sample string 3</InvoiceCode><InvoiceID>2</InvoiceID><InvoicePaymentID>1</InvoicePaymentID><PaidAmount>4</PaidAmount><PaymentMethod>sample string 7</PaymentMethod><PaymentRef>sample string 6</PaymentRef><RecordCount>12</RecordCount></CustomerPaymentHistoryDM></PaymentHistory></CustomerPaymentHistoryDataModel>