GET Payment/GetPayment?CustomerID={CustomerID}&PaymentDate={PaymentDate}&PaymentStartDate={PaymentStartDate}&PaymentEndDate={PaymentEndDate}&PaymentAmount={PaymentAmount}&PaymentLocationID={PaymentLocationID}&PaymentType={PaymentType}&PrePayYesNo={PrePayYesNo}&InvoiceNumber={InvoiceNumber}
Returns payment information.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| CustomerID |
The ID of the Agvance customer to get the price for. (optional) |
string |
Default value is string.Empty |
| PaymentDate |
Date payment was made. If payment date is specified, then payment start and end dates will be ignored. Format MM-dd-yyyy (optional) |
string |
Default value is string.Empty |
| PaymentStartDate |
Start date of payment to return. Format MM-dd-yyyy (optional) |
string |
Default value is string.Empty |
| PaymentEndDate |
End date of payment to return. Format MM-dd-yyyy (optional) |
string |
Default value is string.Empty |
| PaymentAmount |
Amount paid this payment. (optional) |
string |
Default value is string.Empty |
| PaymentLocationID |
Location where the payment was created. (optional) |
string |
Default value is string.Empty |
| PaymentType |
PaymentType comes from one of the payment methods (Cash, Check, Credit Card, etc.). (optional) |
string |
Default value is string.Empty |
| PrePayYesNo |
Accepts either "Yes" or "No". (optional) |
string |
Default value is string.Empty |
| InvoiceNumber |
Invoice number for the list of payments to be returned. (optional) |
string |
Default value is string.Empty |
Body Parameters
Response Information
Resource Description
Returns payment information.
AgvPayment| Name | Description | Type | Additional Information |
|---|---|---|---|
| Status |
Status of the API call. |
string | |
| Message |
Message of the API call. |
string | |
| ErrorList |
List of error messages of the API call. |
Collection of string | |
| WarningList |
List of warning messages of the API call. |
Collection of string | |
| Count |
Count of how many Payments. |
string | |
| PaymentRecords |
JSON dictionary of PaymentRecords. |
Collection of clsAPIPayment |
Response Formats
application/json, text/json
{
"Status": "sample string 1",
"Message": "sample string 2",
"ErrorList": [
"sample string 1",
"sample string 2"
],
"WarningList": [
"sample string 1",
"sample string 2"
],
"Count": "2",
"PaymentRecords": [
{
"PaymentDate": "sample string 1",
"PaymentLocation": "sample string 2",
"PaymentNumber": "sample string 3",
"PaymentRecordHeaderDetails": null,
"PaymentRecordPayMethodDetails": [],
"PaymentRecordLineItemDetails": []
},
{
"PaymentDate": "sample string 1",
"PaymentLocation": "sample string 2",
"PaymentNumber": "sample string 3",
"PaymentRecordHeaderDetails": null,
"PaymentRecordPayMethodDetails": [],
"PaymentRecordLineItemDetails": []
}
]
}