GET api/Payment/clientinvoices

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ViewClientInvoice

Name	Type	Additional information
InvoiceId	globally unique identifier	None.
ClientId	integer	None.
ClientName	string	None.
PSInvoiceId	string	None.
PSInvoiceDate	date	None.
ChargeId	string	None.
AmountDue	decimal number	None.
LastUpdatedPSEventId	string	None.
PSCustomerId	string	None.
PaymentId	globally unique identifier	None.
PaymentAmount	decimal number	None.
PaymentDate	date	None.
TotRefundAmount	decimal number	None.
TotAmount	decimal number	None.
InvoiceStatus	string	None.
FailureMessage	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "InvoiceId": "c679afe4-9b0a-4d9f-9301-60b167bfd1eb",
    "ClientId": 1,
    "ClientName": "sample string 2",
    "PSInvoiceId": "sample string 3",
    "PSInvoiceDate": "2025-09-01T22:04:31.5264093+00:00",
    "ChargeId": "sample string 4",
    "AmountDue": 1.0,
    "LastUpdatedPSEventId": "sample string 5",
    "PSCustomerId": "sample string 6",
    "PaymentId": "d4c64901-1a1d-44bf-9d38-c55cda68279d",
    "PaymentAmount": 1.0,
    "PaymentDate": "2025-09-01T22:04:31.5264093+00:00",
    "TotRefundAmount": 1.0,
    "TotAmount": 1.0,
    "InvoiceStatus": "sample string 8",
    "FailureMessage": "sample string 9"
  },
  {
    "InvoiceId": "c679afe4-9b0a-4d9f-9301-60b167bfd1eb",
    "ClientId": 1,
    "ClientName": "sample string 2",
    "PSInvoiceId": "sample string 3",
    "PSInvoiceDate": "2025-09-01T22:04:31.5264093+00:00",
    "ChargeId": "sample string 4",
    "AmountDue": 1.0,
    "LastUpdatedPSEventId": "sample string 5",
    "PSCustomerId": "sample string 6",
    "PaymentId": "d4c64901-1a1d-44bf-9d38-c55cda68279d",
    "PaymentAmount": 1.0,
    "PaymentDate": "2025-09-01T22:04:31.5264093+00:00",
    "TotRefundAmount": 1.0,
    "TotAmount": 1.0,
    "InvoiceStatus": "sample string 8",
    "FailureMessage": "sample string 9"
  }
]

application/xml, text/xml

Sample:

<ArrayOfViewClientInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdminPortal.Repository">
  <ViewClientInvoice>
    <AmountDue>1</AmountDue>
    <ChargeId>sample string 4</ChargeId>
    <ClientId>1</ClientId>
    <ClientName>sample string 2</ClientName>
    <FailureMessage>sample string 9</FailureMessage>
    <InvoiceId>c679afe4-9b0a-4d9f-9301-60b167bfd1eb</InvoiceId>
    <InvoiceStatus>sample string 8</InvoiceStatus>
    <LastUpdatedPSEventId>sample string 5</LastUpdatedPSEventId>
    <PSCustomerId>sample string 6</PSCustomerId>
    <PSInvoiceDate>2025-09-01T22:04:31.5264093+00:00</PSInvoiceDate>
    <PSInvoiceId>sample string 3</PSInvoiceId>
    <PaymentAmount>1</PaymentAmount>
    <PaymentDate>2025-09-01T22:04:31.5264093+00:00</PaymentDate>
    <PaymentId>d4c64901-1a1d-44bf-9d38-c55cda68279d</PaymentId>
    <TotAmount>1</TotAmount>
    <TotRefundAmount>1</TotRefundAmount>
  </ViewClientInvoice>
  <ViewClientInvoice>
    <AmountDue>1</AmountDue>
    <ChargeId>sample string 4</ChargeId>
    <ClientId>1</ClientId>
    <ClientName>sample string 2</ClientName>
    <FailureMessage>sample string 9</FailureMessage>
    <InvoiceId>c679afe4-9b0a-4d9f-9301-60b167bfd1eb</InvoiceId>
    <InvoiceStatus>sample string 8</InvoiceStatus>
    <LastUpdatedPSEventId>sample string 5</LastUpdatedPSEventId>
    <PSCustomerId>sample string 6</PSCustomerId>
    <PSInvoiceDate>2025-09-01T22:04:31.5264093+00:00</PSInvoiceDate>
    <PSInvoiceId>sample string 3</PSInvoiceId>
    <PaymentAmount>1</PaymentAmount>
    <PaymentDate>2025-09-01T22:04:31.5264093+00:00</PaymentDate>
    <PaymentId>d4c64901-1a1d-44bf-9d38-c55cda68279d</PaymentId>
    <TotAmount>1</TotAmount>
    <TotRefundAmount>1</TotRefundAmount>
  </ViewClientInvoice>
</ArrayOfViewClientInvoice>