GET api/v2/AR/CustomerPaymentHistory?CustomerId={CustomerId}&PendingOnly={PendingOnly}

Retrieves a customers payment history.

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerId	The customer id for which to retrieve payment history.	string	Required
PendingOnly	Flag to retrieve only pending payments.	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerPayment

Name	Description	Type	Additional information
BatchId	The ID for the Batch this payment was included in.	string	None.
PaymentDate	Date of this payment.	string	None.
TotalPaymentAmt	Total amount of this payment.	decimal number	None.
ReferenceNum	Reference number for this payment.	string	None.
PostedDate	Date this payment was posted.	string	None.
PaymentDetails	The list of invoices this payment was applied to.	Collection of PaymentDetail	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "BatchId": "sample string 1",
    "PaymentDate": "sample string 2",
    "TotalPaymentAmt": 3.0,
    "ReferenceNum": "sample string 4",
    "PostedDate": "sample string 5",
    "PaymentDetails": [
      {
        "InvoiceId": "sample string 1",
        "TotalInvoiceAmt": 1.0,
        "PaymentAmount": 2.0,
        "InvoiceBalance": 1.0,
        "PaymentActionCode": "sample string 3",
        "PaymentActionDesc": "sample string 4",
        "DepositDoc": "sample string 5"
      },
      {
        "InvoiceId": "sample string 1",
        "TotalInvoiceAmt": 1.0,
        "PaymentAmount": 2.0,
        "InvoiceBalance": 1.0,
        "PaymentActionCode": "sample string 3",
        "PaymentActionDesc": "sample string 4",
        "DepositDoc": "sample string 5"
      }
    ]
  },
  {
    "BatchId": "sample string 1",
    "PaymentDate": "sample string 2",
    "TotalPaymentAmt": 3.0,
    "ReferenceNum": "sample string 4",
    "PostedDate": "sample string 5",
    "PaymentDetails": [
      {
        "InvoiceId": "sample string 1",
        "TotalInvoiceAmt": 1.0,
        "PaymentAmount": 2.0,
        "InvoiceBalance": 1.0,
        "PaymentActionCode": "sample string 3",
        "PaymentActionDesc": "sample string 4",
        "DepositDoc": "sample string 5"
      },
      {
        "InvoiceId": "sample string 1",
        "TotalInvoiceAmt": 1.0,
        "PaymentAmount": 2.0,
        "InvoiceBalance": 1.0,
        "PaymentActionCode": "sample string 3",
        "PaymentActionDesc": "sample string 4",
        "DepositDoc": "sample string 5"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerPayment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <CustomerPayment>
    <BatchId>sample string 1</BatchId>
    <PaymentDate>sample string 2</PaymentDate>
    <PaymentDetails>
      <PaymentDetail>
        <DepositDoc>sample string 5</DepositDoc>
        <InvoiceBalance>1</InvoiceBalance>
        <InvoiceId>sample string 1</InvoiceId>
        <PaymentActionCode>sample string 3</PaymentActionCode>
        <PaymentActionDesc>sample string 4</PaymentActionDesc>
        <PaymentAmount>2</PaymentAmount>
        <TotalInvoiceAmt>1</TotalInvoiceAmt>
      </PaymentDetail>
      <PaymentDetail>
        <DepositDoc>sample string 5</DepositDoc>
        <InvoiceBalance>1</InvoiceBalance>
        <InvoiceId>sample string 1</InvoiceId>
        <PaymentActionCode>sample string 3</PaymentActionCode>
        <PaymentActionDesc>sample string 4</PaymentActionDesc>
        <PaymentAmount>2</PaymentAmount>
        <TotalInvoiceAmt>1</TotalInvoiceAmt>
      </PaymentDetail>
    </PaymentDetails>
    <PostedDate>sample string 5</PostedDate>
    <ReferenceNum>sample string 4</ReferenceNum>
    <TotalPaymentAmt>3</TotalPaymentAmt>
  </CustomerPayment>
  <CustomerPayment>
    <BatchId>sample string 1</BatchId>
    <PaymentDate>sample string 2</PaymentDate>
    <PaymentDetails>
      <PaymentDetail>
        <DepositDoc>sample string 5</DepositDoc>
        <InvoiceBalance>1</InvoiceBalance>
        <InvoiceId>sample string 1</InvoiceId>
        <PaymentActionCode>sample string 3</PaymentActionCode>
        <PaymentActionDesc>sample string 4</PaymentActionDesc>
        <PaymentAmount>2</PaymentAmount>
        <TotalInvoiceAmt>1</TotalInvoiceAmt>
      </PaymentDetail>
      <PaymentDetail>
        <DepositDoc>sample string 5</DepositDoc>
        <InvoiceBalance>1</InvoiceBalance>
        <InvoiceId>sample string 1</InvoiceId>
        <PaymentActionCode>sample string 3</PaymentActionCode>
        <PaymentActionDesc>sample string 4</PaymentActionDesc>
        <PaymentAmount>2</PaymentAmount>
        <TotalInvoiceAmt>1</TotalInvoiceAmt>
      </PaymentDetail>
    </PaymentDetails>
    <PostedDate>sample string 5</PostedDate>
    <ReferenceNum>sample string 4</ReferenceNum>
    <TotalPaymentAmt>3</TotalPaymentAmt>
  </CustomerPayment>
</ArrayOfCustomerPayment>