All Verbs | /service/QueryInvoicePayments |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
PaymentId | form | string | No | |
InvoiceNumber | form | string | No | |
AmountPaid | form | decimal | No | |
AmountOwed | form | decimal | No | |
PaymentType | form | string | No | |
Token | form | string | No | |
DateEntered | form | DateTime | No | |
Last4 | form | string | No | |
TransactionNo | form | string | No | |
EMUNTransactionNo | form | string | No | |
OriginalPaymentID | form | string | No | |
InvoiceNumbers | form | string | No | |
Exported | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/QueryInvoicePayments HTTP/1.1
Host: www.bernhardt.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { id: String, invoiceNumber: String, transactionNo: String, emunTransactionNo: String, amountPaid: 0, amountOwed: 0, type: String, token: String, dateEntered: 0001-01-01, invoiceDate: 0001-01-01, last4: String, paymentType: String, exported: False, retailerId: String, companyName: String, invoiceNumbers: String } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }