GET api/Payment/InvoicePayments

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of InvoicePaymentViewModel
NameDescriptionTypeAdditional information
PaymentId

globally unique identifier

None.

InvoiceId

globally unique identifier

None.

PaymentAmount

decimal number

None.

InvoiceChargeId

globally unique identifier

None.

PaymentDate

date

None.

CustomerName

string

None.

PSInvoiceId

string

None.

PSCustomerId

string

None.

ChargeId

string

None.

ClientId

integer

None.

PlanName

string

None.

SubscriptionType

string

None.

PaymentRefundAmount

integer

None.

ClientEmail

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PaymentId": "f97acb70-6d58-4afc-87ef-02d42d60f1fe",
    "InvoiceId": "29ee7c80-558a-4536-bba8-436e1f3c99cf",
    "PaymentAmount": 1.0,
    "InvoiceChargeId": "83fcdd80-7e3b-4af1-8fe3-f8953eb35e41",
    "PaymentDate": "2025-09-01T22:01:47.7719975+00:00",
    "CustomerName": "sample string 2",
    "PSInvoiceId": "sample string 3",
    "PSCustomerId": "sample string 4",
    "ChargeId": "sample string 5",
    "ClientId": 1,
    "PlanName": "sample string 6",
    "SubscriptionType": "sample string 7",
    "PaymentRefundAmount": 1,
    "ClientEmail": "sample string 8"
  },
  {
    "PaymentId": "f97acb70-6d58-4afc-87ef-02d42d60f1fe",
    "InvoiceId": "29ee7c80-558a-4536-bba8-436e1f3c99cf",
    "PaymentAmount": 1.0,
    "InvoiceChargeId": "83fcdd80-7e3b-4af1-8fe3-f8953eb35e41",
    "PaymentDate": "2025-09-01T22:01:47.7719975+00:00",
    "CustomerName": "sample string 2",
    "PSInvoiceId": "sample string 3",
    "PSCustomerId": "sample string 4",
    "ChargeId": "sample string 5",
    "ClientId": 1,
    "PlanName": "sample string 6",
    "SubscriptionType": "sample string 7",
    "PaymentRefundAmount": 1,
    "ClientEmail": "sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfInvoicePaymentViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AdminPortal.Domain.ViewModels">
  <InvoicePaymentViewModel>
    <ChargeId>sample string 5</ChargeId>
    <ClientEmail>sample string 8</ClientEmail>
    <ClientId>1</ClientId>
    <CustomerName>sample string 2</CustomerName>
    <InvoiceChargeId>83fcdd80-7e3b-4af1-8fe3-f8953eb35e41</InvoiceChargeId>
    <InvoiceId>29ee7c80-558a-4536-bba8-436e1f3c99cf</InvoiceId>
    <PSCustomerId>sample string 4</PSCustomerId>
    <PSInvoiceId>sample string 3</PSInvoiceId>
    <PaymentAmount>1</PaymentAmount>
    <PaymentDate>2025-09-01T22:01:47.7719975+00:00</PaymentDate>
    <PaymentId>f97acb70-6d58-4afc-87ef-02d42d60f1fe</PaymentId>
    <PaymentRefundAmount>1</PaymentRefundAmount>
    <PlanName>sample string 6</PlanName>
    <SubscriptionType>sample string 7</SubscriptionType>
  </InvoicePaymentViewModel>
  <InvoicePaymentViewModel>
    <ChargeId>sample string 5</ChargeId>
    <ClientEmail>sample string 8</ClientEmail>
    <ClientId>1</ClientId>
    <CustomerName>sample string 2</CustomerName>
    <InvoiceChargeId>83fcdd80-7e3b-4af1-8fe3-f8953eb35e41</InvoiceChargeId>
    <InvoiceId>29ee7c80-558a-4536-bba8-436e1f3c99cf</InvoiceId>
    <PSCustomerId>sample string 4</PSCustomerId>
    <PSInvoiceId>sample string 3</PSInvoiceId>
    <PaymentAmount>1</PaymentAmount>
    <PaymentDate>2025-09-01T22:01:47.7719975+00:00</PaymentDate>
    <PaymentId>f97acb70-6d58-4afc-87ef-02d42d60f1fe</PaymentId>
    <PaymentRefundAmount>1</PaymentRefundAmount>
    <PlanName>sample string 6</PlanName>
    <SubscriptionType>sample string 7</SubscriptionType>
  </InvoicePaymentViewModel>
</ArrayOfInvoicePaymentViewModel>