All Verbs | /service/QueryClaimLines/{InvoiceId}/{RequestId} | ||
---|---|---|---|
All Verbs | /service/QueryClaimLines | ||
All Verbs | /service/QueryCreditMemoLines/{InvoiceId}/{RequestId} | ||
All Verbs | /service/QueryCreditMemoLines |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RequestId | path | string | No | |
InvoiceId | path | string | No | |
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 |
---|---|---|---|---|
Position | form | int | No | |
ProductId | form | string | No | |
Description | form | string | No | |
QtyOrdered | form | int | No | |
QtyShipped | form | int | No | |
Price | form | decimal | No | |
UOM | form | string | No | |
Id | 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 | |
OrderedTotal | form | decimal | No | |
ShippedTotal | form | decimal | No | |
Subtotal | 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/QueryClaimLines/{InvoiceId}/{RequestId} HTTP/1.1
Host: www.bernhardt.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
requestId: String,
invoiceId: String,
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: [ { position: 0, productId: String, description: String, qtyOrdered: 0, qtyShipped: 0, price: 0, uom: String, id: String, invoiceLineNumber: String, reasonCode: String, attachmentUrl: String, comment: String, quantity: 0, qtyReturned: 0, orderedTotal: 0, shippedTotal: 0, subtotal: 0 } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }