DocCloud API

<back to all web services

CreateInvoiceOrderCommand

Requires Authentication
The following routes are available for this service:
POST/invoice/order
CreateInvoiceOrderCommand Parameters:
NameParameterData TypeRequiredDescription
PositionsbodyList<InvoiceOrderPositionDto>No
DescriptionbodystringNo
CurrencyIdbodyuintNo
CurrencybodystringNo
RecbodyShortRecipientDtoNo
InvoiceOrderPositionDto Parameters:
NameParameterData TypeRequiredDescription
ProductIdformuintNo
InvoicerOrderIdformulongNo
NameformstringNo
CodeformstringNo
QuantityformdecimalNo
UnitIdformuintNo
UnitformstringNo
CurrencyIdformuintNo
CurrencyformstringNo
UnitPriceformdecimalNo
GrossformdecimalNo
NettoformdecimalNo
VatTypeIdformintNo
Vat5formdecimalNo
Vat8formdecimalNo
Vat23formdecimalNo
IsUpdatedformboolNo
IsDeletedformboolNo
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo
ShortRecipientDto Parameters:
NameParameterData TypeRequiredDescription
IdformuintNo
CatIdformuintNo
NameformstringNo
VatIdformstringNo
StreetNameformstringNo
StreetNumberformstringNo
FlatNumberformstringNo
PostalCodeformstringNo
TownformstringNo
CountryIdformintNo
IsoCountryformstringNo
CountryformstringNo
EmailformstringNo
PhoneformstringNo
BankNameformstringNo
BankAccountNbformstringNo
IsActualformboolNo
DefaultCurrencyIdformuintNo
DefaultCurrencyformstringNo
CategoryIdformuintNo
CategoryNameformstringNo
PostOperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
OperationResult Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ResponseStatusformResponseStatusNo
ResultformObjectNo
IsSuccessformboolNo

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 /invoice/order HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	positions: 
	[
		{
			productId: 0,
			invoicerOrderId: 0,
			name: String,
			code: String,
			quantity: 0,
			unitId: 0,
			unit: String,
			currencyId: 0,
			currency: String,
			unitPrice: 0,
			gross: 0,
			netto: 0,
			vatTypeId: 0,
			vat5: 0,
			vat8: 0,
			vat23: 0,
			isUpdated: False,
			isDeleted: False,
			createdById: 0,
			modifiedById: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			id: 0
		}
	],
	description: String,
	currencyId: 0,
	currency: String,
	rec: 
	{
		id: 0,
		catId: 0,
		name: String,
		vatId: String,
		streetName: String,
		streetNumber: String,
		flatNumber: String,
		postalCode: String,
		town: String,
		countryId: 0,
		isoCountry: String,
		country: String,
		email: String,
		phone: String,
		bankName: String,
		bankAccountNb: String,
		isActual: False,
		defaultCurrencyId: 0,
		defaultCurrency: String,
		categoryId: 0,
		categoryName: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	code: FAIL,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	result: {},
	isSuccess: False
}