All Verbs | /service/QueryCreditMemoRequests |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
InvoiceId | query | string | No | |
RetailerId | 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 | |
InvoiceId | form | string | No | |
RefId | form | string | No | |
OriginalRefId | form | string | No | |
Reason | form | string | No | |
CustomerServiceAreaId | form | string | No | |
CreatedOn | form | DateTime | No | |
CreatedBy | form | string | No | |
Status | form | string | No | |
Exported | form | bool | No | |
Custom1 | form | string | No | |
Custom2 | form | string | No | |
Custom3 | form | string | No | |
Lines | form | List<CreditMemoRequestLine> | No | |
GrandTotal | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | K | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
RequestId | form | string | No | |
InvoiceLineNumber | form | string | No | |
ReasonCode | form | string | No | |
AttachmentUrl | form | string | No | |
Comment | form | string | No | |
Quantity | form | int | No | |
QtyReturned | form | int | No | |
Price | form | decimal | 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/QueryCreditMemoRequests HTTP/1.1
Host: www.bernhardt.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
invoiceId: String,
retailerId: 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: [ { companyName: String, id: String, invoiceId: String, refId: String, originalRefId: String, reason: String, customerServiceAreaId: String, createdOn: 0001-01-01, createdBy: String, status: String, exported: False, custom1: String, custom2: String, custom3: String, lines: [ { id: String, requestId: String, invoiceLineNumber: String, reasonCode: String, attachmentUrl: String, comment: String, quantity: 0, qtyReturned: 0, price: 0 } ], grandTotal: 0 } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }