DocCloud API

<back to all web services

ListCostInvoicePositionQuery

Requires Authentication
The following routes are available for this service:
GET/costinvoice/positionList cost invoice positions
ListCostInvoicePositionQuery Parameters:
NameParameterData TypeRequiredDescription
NamequerystringNo
PaginatedOrderedRequestBase Parameters:
NameParameterData TypeRequiredDescription
OrderByformstringNo
SortTypeformstringNo
PagesformintNo
AmountformintNo
BaseResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MultipleResultformIList<T>No
TotalformintNo
OffsetformintNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
CostInvoicePositionDto Parameters:
NameParameterData TypeRequiredDescription
ProductIdformuintNo
CodeformstringNo
NameformstringNo
UnitPriceformdecimalNo
UnitIdformuintNo
UnitformstringNo
QuantityformdecimalNo
CurrencyIdformuintNo
CurrencyformstringNo
NettoformdecimalNo
VatTypeIdformintNo
Vat5formdecimalNo
Vat8formdecimalNo
Vat23formdecimalNo
RecalculateVatformboolNo
GrossformdecimalNo
CategoryIdformuintNo
CategoryNameformstringNo
TaxableKindIdformuintNo
TaxableKindNameformstringNo
TaxableTypeIdformuintNo
TaxableTypeNameformstringNo
IsTaxableIdformintNo
IsTaxableNameformstringNo
InvoiceIdformulongNo
IsDeletedformboolNo
PosCorrIdformulongNo
IsBeforeformboolNo
IsUpdatedformboolNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo

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 /costinvoice/position 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: 
	{
		productId: 0,
		code: String,
		name: String,
		unitPrice: 0,
		unitId: 0,
		unit: String,
		quantity: 0,
		currencyId: 0,
		currency: String,
		netto: 0,
		vatTypeId: 0,
		vat5: 0,
		vat8: 0,
		vat23: 0,
		recalculateVat: False,
		gross: 0,
		categoryId: 0,
		categoryName: String,
		taxableKindId: 0,
		taxableKindName: String,
		taxableTypeId: 0,
		taxableTypeName: String,
		isTaxableId: 0,
		isTaxableName: String,
		invoiceId: 0,
		isDeleted: False,
		posCorrId: 0,
		isBefore: False,
		isUpdated: False,
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}