All Verbs | /service/CreateCreditMemoRequest | ||
---|---|---|---|
All Verbs | /service/CreateClaim |
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 | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | 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 | |
Product | form | JsonObject | No | |
ProductId | form | string | No | |
ProductDescription | form | string | No | |
Price | form | decimal | 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 | |
Meta | form | Dictionary<string, string> | No | |
Tags | form | Dictionary<string, HashSet<String>> | No | |
GrandTotal | form | decimal | 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/CreateCreditMemoRequest HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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,
product:
{
String: "String"
},
productId: String,
productDescription: String,
price: 0
}
],
meta:
{
String: String
},
tags:
{
String:
[
String
]
},
grandTotal: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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, product: { String: "String" }, productId: String, productDescription: String, price: 0 } ], meta: { String: String }, tags: { String: [ String ] }, grandTotal: 0 }