DocCloud API

<back to all web services

ListSupplyDemandOrderQuery

Requires Authentication
The following routes are available for this service:
GET/supplydemand/order
ListSupplyDemandOrderQuery Parameters:
NameParameterData TypeRequiredDescription
IAmProviderquerybool?No
NumberquerystringNo
ProviderNamequerystringNo
ProviderVatIdquerystringNo
ClientNamequerystringNo
ClientVatIdquerystringNo
StatusqueryList<int>No
CurrencyIdqueryList<uint>No
GrossFromquerydecimal?No
GrossToquerydecimal?No
NettoFromquerydecimal?No
NettoToquerydecimal?No
PaginatedOrderedRequestBase Parameters:
NameParameterData TypeRequiredDescription
OrderByformstringNo
SortTypeformstringNo
PagesformintNo
AmountformintNo
BaseResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MultipleResultformIList<T>No
TotalformintNo
OffsetformintNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
SupplyDemandOrderDto Parameters:
NameParameterData TypeRequiredDescription
ProviderCompanyIdformuintNo
ClientCompanyIdformuintNo
SupplyDemandIdformulongNo
SupplyDemandOfferIdformulongNo
SupplyDemandOfferNumberformstringNo
StatusformintNo
NumberformstringNo
CurrencyIdformuintNo
CurrencyformstringNo
NettoformdecimalNo
GrossformdecimalNo
PositionsformList<SupplyDemandOrderPositionDto>No
ClientNameformstringNo
ClientVatIdformstringNo
ClientStreetNameformstringNo
ClientStreetNumberformstringNo
ClientFlatNumberformstringNo
ClientPostalCodeformstringNo
ClientTownformstringNo
ClientCountryIdformintNo
ClientCountryformstringNo
ClientEmailformstringNo
ClientPhoneformstringNo
IsReceiverDiffrentformboolNo
ReceiverNameformstringNo
ReceiverVatIdformstringNo
ReceiverStreetNameformstringNo
ReceiverStreetNumberformstringNo
ReceiverFlatNumberformstringNo
ReceiverPostalCodeformstringNo
ReceiverTownformstringNo
ReceiverCountryIdformuint?No
ReceiverCountryformstringNo
ReceiverEmailformstringNo
ReceiverPhoneformstringNo
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo
SupplyDemandOrderPositionDto Parameters:
NameParameterData TypeRequiredDescription
OrderIdformulongNo
DemandPositionIdformulongNo
ProductIdformulongNo
CodeformstringNo
DescriptionformstringNo
QuantityformuintNo
SRPUnitPriceformdecimalNo
UnitPriceformdecimalNo
NettoformdecimalNo
GrossformdecimalNo
VatTypeIdformuintNo
DiscountformdecimalNo
IsDeletedformboolNo

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.

GET /supplydemand/order HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	total: 0,
	offset: 0,
	result: 
	{
		providerCompanyId: 0,
		clientCompanyId: 0,
		supplyDemandId: 0,
		supplyDemandOfferId: 0,
		supplyDemandOfferNumber: String,
		status: 0,
		number: String,
		currencyId: 0,
		currency: String,
		netto: 0,
		gross: 0,
		positions: 
		[
			{
				orderId: 0,
				demandPositionId: 0,
				productId: 0,
				code: String,
				description: String,
				quantity: 0,
				srpUnitPrice: 0,
				unitPrice: 0,
				netto: 0,
				gross: 0,
				vatTypeId: 0,
				discount: 0,
				isDeleted: False,
				createdById: 0,
				modifiedById: 0,
				createdDate: 0001-01-01,
				modifiedDate: 0001-01-01,
				id: 0
			}
		],
		clientName: String,
		clientVatId: String,
		clientStreetName: String,
		clientStreetNumber: String,
		clientFlatNumber: String,
		clientPostalCode: String,
		clientTown: String,
		clientCountryId: 0,
		clientCountry: String,
		clientEmail: String,
		clientPhone: String,
		isReceiverDiffrent: False,
		receiverName: String,
		receiverVatId: String,
		receiverStreetName: String,
		receiverStreetNumber: String,
		receiverFlatNumber: String,
		receiverPostalCode: String,
		receiverTown: String,
		receiverCountryId: 0,
		receiverCountry: String,
		receiverEmail: String,
		receiverPhone: String,
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}