EMUN1 ASP.NET

<back to all web services

QueryCreditMemoRequests

The following routes are available for this service:
All Verbs/service/QueryCreditMemoRequests
QueryCreditMemoRequests Parameters:
NameParameterData TypeRequiredDescription
SearchquerystringNo
InvoiceIdquerystringNo
RetailerIdquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CreditMemoRequest Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
InvoiceIdformstringNo
RefIdformstringNo
OriginalRefIdformstringNo
ReasonformstringNo
CustomerServiceAreaIdformstringNo
CreatedOnformDateTimeNo
CreatedByformstringNo
StatusformstringNo
ExportedformboolNo
Custom1formstringNo
Custom2formstringNo
Custom3formstringNo
LinesformList<CreditMemoRequestLine>No
GrandTotalformdecimalNo
EntityBase<K> Parameters:
NameParameterData TypeRequiredDescription
IdformKNo
CreditMemoRequestLine Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
RequestIdformstringNo
InvoiceLineNumberformstringNo
ReasonCodeformstringNo
AttachmentUrlformstringNo
CommentformstringNo
QuantityformintNo
QtyReturnedformintNo
PriceformdecimalNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}