DocCloud API

InvoiceUpdateCommand

The following routes are available for this service:
PUT	/invoice	Update Invoice

**InvoiceUpdateCommand** Parameters:
Name	Parameter	Data Type	Required
Id	body	ulong	No
TypeId	body	uint	No
TypeName	body	string	No
InvSrcId	body	uint	No
InvSrcNumber	body	string	No
SchemaId	body	uint	No
Number	body	string	No
OrderNumber	body	string	No
Town	body	string	No
CreationDate	body	DateTime	No
SellDate	body	DateTime	No
PaymentDueDate	body	DateTime	No
IsFromOcr	body	bool	No
PaymentTypeId	body	uint	No
PaymentType	body	string	No
PaymentTerms	body	ushort	No
CategoryId	body	uint	No
CategoryName	body	string	No
JpkItemCodeId	body	int	No
JpkItemCodeCode	body	string	No
JpkItemCodeName	body	string	No
ListJpkProcedure	body	List<InvoiceJpkProcedureDto>	No
JpkDocTypeId	body	int	No
JpkDocTypeCode	body	string	No
JpkDocTypeName	body	string	No
SellBankId	body	uint	No
SellBankName	body	string	No
SellBankAccountNb	body	string	No
Swift	body	string	No
Recipient	body	ShortRecipientDto	No
IsReceiverDiffrent	body	bool	No
Receiver	body	ShortRecipientDto	No
InvoicePosition	body	List<InvoicePositionDto>	No
BasePrice	body	decimal	No
Discount	body	decimal	No
CurrencyId	body	uint	No
Currency	body	string	No
Netto	body	decimal	No
Vat5	body	decimal	No
Vat8	body	decimal	No
Vat23	body	decimal	No
VatBase	body	decimal	No
Gross	body	decimal	No
Paid	body	decimal	No
ToPaid	body	decimal	No
IsMarkedClear	body	bool	No
Status	body	string	No
IsPaymentDivided	body	bool	No
IsReverseCharged	body	bool	No
SupplierName	body	string	No
RecipientName	body	string	No
MarginReasonId	body	uint	No
MarginReason	body	string	No
PrivateNote	body	string	No
Remarks	body	string	No
AdditionalRemarks	body	string	No
Code	body	string	No
CodeAvailability	body	string	No
InvoiceOrderId	body	ulong	No
Attachments	body	List<FileDocumentDto>	No

**InvoiceJpkProcedureDto** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	No
Name	form	string	No

**BaseKeyDto** Parameters:
Name	Parameter	Data Type	Required
CreatedById	form	uint	No
ModifiedById	form	uint	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
Id	form	uint	No

**ShortRecipientDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	uint	No
CatId	form	uint	No
Name	form	string	No
VatId	form	string	No
StreetName	form	string	No
StreetNumber	form	string	No
FlatNumber	form	string	No
PostalCode	form	string	No
Town	form	string	No
CountryId	form	int	No
IsoCountry	form	string	No
Country	form	string	No
Email	form	string	No
Phone	form	string	No
BankName	form	string	No
BankAccountNb	form	string	No
IsActual	form	bool	No
DefaultCurrencyId	form	uint	No
DefaultCurrency	form	string	No
CategoryId	form	uint	No
CategoryName	form	string	No

**InvoicePositionDto** Parameters:
Name	Parameter	Data Type	Required
ProductId	form	uint	No
PosCorrId	form	ulong	No
InvoiceId	form	ulong	No
Name	form	string	No
Code	form	string	No
Quantity	form	decimal	No
UnitId	form	uint	No
Unit	form	string	No
CurrencyId	form	uint	No
Currency	form	string	No
UnitPrice	form	decimal	No
Gross	form	decimal	No
Netto	form	decimal	No
VatTypeId	form	int	No
Vat5	form	decimal	No
Vat8	form	decimal	No
Vat23	form	decimal	No
IsBefore	form	bool	No
IsUpdated	form	bool	No
IsDeleted	form	bool	No

**FileDocumentDto** Parameters:
Name	Parameter	Data Type	Required
ObjectTypeId	form	int	No
ObjectTypeName	form	string	No
ObjectId	form	ulong	No
FileName	form	string	No
FileGuid	form	string	No
FileSize	form	long	No
FileType	form	string	No
ParentFolderId	form	ulong?	No
StatusId	form	uint	No
StatusName	form	string	No
OcrStatus	form	FileOcrStatus	No
OcrResponse	form	OcrRecognisedDocument	No
ProcessId	form	string	No
CostInvoiceId	form	ulong	No
InvoiceId	form	ulong	No

**BaseKeyLongDto** Parameters:
Name	Parameter	Data Type	Required
CreatedById	form	uint	No
ModifiedById	form	uint	No
CreatedDate	form	DateTime	No
ModifiedDate	form	DateTime	No
Id	form	ulong	No

**FileOcrStatus** Enum:
Name	Value
None	0
SubmittedForProcessing	1
SentForProcessing	2
ProcessingInProgress	3
Completed	4
Error	5
NotAvailableYet	100
NotAvailableYetFirstRetry	101
NotAvailableYetSecondRetry	102
NotAvailableYetThirdRetry	103
NotAvailableYetFourthRetry	104
NotAvailableYetFifthRetry	105

**OcrRecognisedDocument** Parameters:
Name	Parameter	Data Type	Required
NrInvoice	form	string	No
BankAccount	form	string	No
BankName	form	string	No
DateOfIssue	form	string	No
SaleDate	form	string	No
DateOfPayment	form	string	No
SellerNip	form	string	No
SellerName	form	string	No
SellerStreetName	form	string	No
SellerStreetNr	form	string	No
SellerLocalNr	form	string	No
SellerPlace	form	string	No
SellerZipCode	form	string	No
BuyerNip	form	string	No
BuyerName	form	string	No
BuyerStreetName	form	string	No
BuyerStreetNr	form	string	No
BuyerLocalNr	form	string	No
BuyerPlace	form	string	No
BuyerZipCode	form	string	No
SummaryNetto	form	string	No
SummaryVat	form	string	No
SummaryGross	form	string	No
Positions	form	ICollection<OcrRecognisedPosition>	No

**OcrRecognisedPosition** Parameters:
Name	Parameter	Data Type	Required
Lp	form	string	No
Name	form	string	No
Unit	form	string	No
Gross	form	string	No
Netto	form	string	No
Vat	form	string	No
VatValue	form	string	No
Quantity	form	string	No
NettoPrice	form	string	No
GrossPrice	form	string	No

**PostOperationResult<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	T	No

**OperationResult** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
ResponseStatus	form	ResponseStatus	No
Result	form	Object	No
IsSuccess	form	bool	No

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.

PUT /invoice HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	typeId: 0,
	typeName: String,
	invSrcId: 0,
	invSrcNumber: String,
	schemaId: 0,
	number: String,
	orderNumber: String,
	town: String,
	creationDate: 0001-01-01,
	sellDate: 0001-01-01,
	paymentDueDate: 0001-01-01,
	isFromOcr: False,
	paymentTypeId: 0,
	paymentType: String,
	paymentTerms: 0,
	categoryId: 0,
	categoryName: String,
	jpkItemCodeId: 0,
	jpkItemCodeCode: String,
	jpkItemCodeName: String,
	listJpkProcedure: 
	[
		{
			code: String,
			name: String,
			createdById: 0,
			modifiedById: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			id: 0
		}
	],
	jpkDocTypeId: 0,
	jpkDocTypeCode: String,
	jpkDocTypeName: String,
	sellBankId: 0,
	sellBankName: String,
	sellBankAccountNb: String,
	swift: String,
	recipient: 
	{
		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
	},
	isReceiverDiffrent: False,
	receiver: 
	{
		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
	},
	invoicePosition: 
	[
		{
			productId: 0,
			posCorrId: 0,
			invoiceId: 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,
			isBefore: False,
			isUpdated: False,
			isDeleted: False,
			createdById: 0,
			modifiedById: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			id: 0
		}
	],
	basePrice: 0,
	discount: 0,
	currencyId: 0,
	currency: String,
	netto: 0,
	vat5: 0,
	vat8: 0,
	vat23: 0,
	vatBase: 0,
	gross: 0,
	paid: 0,
	toPaid: 0,
	isMarkedClear: False,
	status: String,
	isPaymentDivided: False,
	isReverseCharged: False,
	supplierName: String,
	recipientName: String,
	marginReasonId: 0,
	marginReason: String,
	privateNote: String,
	remarks: String,
	additionalRemarks: String,
	code: String,
	codeAvailability: String,
	invoiceOrderId: 0,
	attachments: 
	[
		{
			objectTypeId: 0,
			objectTypeName: String,
			objectId: 0,
			fileName: String,
			fileGuid: String,
			fileSize: 0,
			fileType: String,
			parentFolderId: 0,
			statusId: 0,
			statusName: String,
			ocrStatus: 0,
			ocrResponse: 
			{
				nrInvoice: String,
				bankAccount: String,
				bankName: String,
				dateOfIssue: String,
				saleDate: String,
				dateOfPayment: String,
				sellerNip: String,
				sellerName: String,
				sellerStreetName: String,
				sellerStreetNr: String,
				sellerLocalNr: String,
				sellerPlace: String,
				sellerZipCode: String,
				buyerNip: String,
				buyerName: String,
				buyerStreetName: String,
				buyerStreetNr: String,
				buyerLocalNr: String,
				buyerPlace: String,
				buyerZipCode: String,
				summaryNetto: String,
				summaryVat: String,
				summaryGross: String
			},
			processId: String,
			costInvoiceId: 0,
			invoiceId: 0,
			createdById: 0,
			modifiedById: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			id: 0
		}
	]
}

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
}