DocCloud API

GetInvoiceQuery

The following routes are available for this service:
GET	/invoice/{Id}	Get invoice by it's id.

**GetInvoiceQuery** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	ulong	No

**BaseSingleResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	T	No

**InvoiceDto** Parameters:
Name	Parameter	Data Type	Required
TypeId	form	uint	No
TypeName	form	string	No
SchemaId	form	uint	No
InvSrcId	form	uint	No
InvSrcNumber	form	string	No
Number	form	string	No
OrderNumber	form	string	No
Town	form	string	No
CreationDate	form	DateTime	No
SellDate	form	DateTime	No
PaymentDueDate	form	DateTime	No
IsFromOcr	form	bool	No
PaymentTypeId	form	uint	No
PaymentType	form	string	No
PaymentTerms	form	ushort	No
CategoryId	form	uint	No
CategoryName	form	string	No
JpkItemCodeId	form	int	No
JpkItemCodeCode	form	string	No
JpkItemCodeName	form	string	No
ListJpkProcedureId	form	List<uint>	No
ListJpkProcedure	form	List<InvoiceJpkProcedureDto>	No
JpkDocTypeId	form	int	No
JpkDocTypeCode	form	string	No
JpkDocTypeName	form	string	No
SellName	form	string	No
SellVatId	form	string	No
SellStreetName	form	string	No
SellStreetNumber	form	string	No
SellFlatNumber	form	string	No
SellPostalCode	form	string	No
SellTown	form	string	No
SellBankName	form	string	No
SellBankAccountNb	form	string	No
RecId	form	uint	No
RecTypeId	form	uint	No
RecCatId	form	uint	No
RecName	form	string	No
RecVatId	form	string	No
RecStreetName	form	string	No
RecStreetNumber	form	string	No
RecFlatNumber	form	string	No
RecPostalCode	form	string	No
RecTown	form	string	No
RecCountryId	form	int	No
RecIsoCountry	form	string	No
RecCountry	form	string	No
RecEmail	form	string	No
RecPhone	form	string	No
RecBankName	form	string	No
RecBankAccountNb	form	string	No
RecIsActual	form	bool	No
IsReceiverDiffrent	form	bool	No
ReceiverId	form	uint?	No
ReceiverTypeId	form	uint?	No
ReceiverCatId	form	uint?	No
ReceiverName	form	string	No
ReceiverVatId	form	string	No
ReceiverStreetName	form	string	No
ReceiverStreetNumber	form	string	No
ReceiverFlatNumber	form	string	No
ReceiverPostalCode	form	string	No
ReceiverTown	form	string	No
ReceiverCountryId	form	int?	No
ReceiverIsoCountry	form	string	No
ReceiverCountry	form	string	No
ReceiverEmail	form	string	No
ReceiverPhone	form	string	No
ReceiverBankName	form	string	No
ReceiverBankAccountNb	form	string	No
Swift	form	string	No
ReceiverIsActual	form	bool?	No
InvoicePosition	form	List<InvoicePositionDto>	No
BasePrice	form	decimal	No
Discount	form	decimal	No
CurrencyId	form	uint	No
Currency	form	string	No
Netto	form	decimal	No
NettoAdvFinal	form	decimal	No
Vat5	form	decimal	No
Vat8	form	decimal	No
Vat23	form	decimal	No
Vat	form	decimal	No
VatBase	form	decimal	No
Gross	form	decimal	No
Paid	form	decimal	No
ToPaid	form	decimal	No
RateDate	form	DateTime	No
Rate	form	decimal	No
StatusId	form	int	No
Status	form	string	No
IsPaymentDivided	form	bool	No
IsReverseCharged	form	bool	No
SupplierName	form	string	No
RecipientName	form	string	No
MarginReasonId	form	uint	No
MarginReason	form	string	No
PrivateNote	form	string	No
Remarks	form	string	No
AdditionalRemarks	form	string	No
InvoicesDependent	form	List<InvoiceDependDto>	No
InvoiceOrderId	form	ulong	No
IsMarkedClear	form	bool	No
Attachments	form	List<FileDocumentDto>	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

**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

**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

**InvoiceDependDto** Parameters:
Name	Parameter	Data Type	Required
InvoiceId	form	ulong	No
InvoiceSrcId	form	ulong	No
InvoiceSrcNumber	form	string	No
InvoiceSrcSellDate	form	DateTime	No
InvoiceSrcNetto	form	decimal	No
InvoiceSrcVat5	form	decimal	No
InvoiceSrcVat8	form	decimal	No
InvoiceSrcVat23	form	decimal	No
InvoiceSrcGross	form	decimal	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

**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

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 /invoice/{Id} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		typeId: 0,
		typeName: String,
		schemaId: 0,
		invSrcId: 0,
		invSrcNumber: String,
		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,
		listJpkProcedureId: 
		[
			0
		],
		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,
		sellName: String,
		sellVatId: String,
		sellStreetName: String,
		sellStreetNumber: String,
		sellFlatNumber: String,
		sellPostalCode: String,
		sellTown: String,
		sellBankName: String,
		sellBankAccountNb: String,
		recId: 0,
		recTypeId: 0,
		recCatId: 0,
		recName: String,
		recVatId: String,
		recStreetName: String,
		recStreetNumber: String,
		recFlatNumber: String,
		recPostalCode: String,
		recTown: String,
		recCountryId: 0,
		recIsoCountry: String,
		recCountry: String,
		recEmail: String,
		recPhone: String,
		recBankName: String,
		recBankAccountNb: String,
		recIsActual: False,
		isReceiverDiffrent: False,
		receiverId: 0,
		receiverTypeId: 0,
		receiverCatId: 0,
		receiverName: String,
		receiverVatId: String,
		receiverStreetName: String,
		receiverStreetNumber: String,
		receiverFlatNumber: String,
		receiverPostalCode: String,
		receiverTown: String,
		receiverCountryId: 0,
		receiverIsoCountry: String,
		receiverCountry: String,
		receiverEmail: String,
		receiverPhone: String,
		receiverBankName: String,
		receiverBankAccountNb: String,
		swift: String,
		receiverIsActual: False,
		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,
		nettoAdvFinal: 0,
		vat5: 0,
		vat8: 0,
		vat23: 0,
		vat: 0,
		vatBase: 0,
		gross: 0,
		paid: 0,
		toPaid: 0,
		rateDate: 0001-01-01,
		rate: 0,
		statusId: 0,
		status: String,
		isPaymentDivided: False,
		isReverseCharged: False,
		supplierName: String,
		recipientName: String,
		marginReasonId: 0,
		marginReason: String,
		privateNote: String,
		remarks: String,
		additionalRemarks: String,
		invoicesDependent: 
		[
			{
				invoiceId: 0,
				invoiceSrcId: 0,
				invoiceSrcNumber: String,
				invoiceSrcSellDate: 0001-01-01,
				invoiceSrcNetto: 0,
				invoiceSrcVat5: 0,
				invoiceSrcVat8: 0,
				invoiceSrcVat23: 0,
				invoiceSrcGross: 0,
				createdById: 0,
				modifiedById: 0,
				createdDate: 0001-01-01,
				modifiedDate: 0001-01-01,
				id: 0
			}
		],
		invoiceOrderId: 0,
		isMarkedClear: False,
		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
			}
		],
		createdById: 0,
		modifiedById: 0,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		id: 0
	}
}