DocCloud API

GetFileDocumentDtoQuery

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

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

**BaseSingleResponse<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	T	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

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

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

{
	result: 
	{
		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
	}
}