{"id":42713,"date":"2024-05-20T05:20:38","date_gmt":"2024-05-20T05:20:38","guid":{"rendered":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/?post_type=ht_kb&p=42713"},"modified":"2024-05-20T06:36:33","modified_gmt":"2024-05-20T06:36:33","slug":"api-do-uslugi-comarch-ocr-archiwalne","status":"publish","type":"ht_kb","link":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/dokumentacja\/api-do-uslugi-comarch-ocr-archiwalne\/","title":{"rendered":"API do us\u0142ugi Comarch OCR (archiwum)"},"content":{"rendered":"

\n

<\/span>Spis tre\u015bci<\/div>

\n

Przetwarzanie dokumentu (POST)<\/a><\/li>\n<\/ul>\n<\/div><\/div>\n<\/div>\n\n\n\n\n\t\n\n\t\n\t

Us\u0142uga<\/th> Adres<\/th>\n<\/tr>\n<\/thead>\n

Comarch OCR<\/td> https:\/\/www.erp.comarch.pl\/OCR\/<\/td>\n<\/tr>\n

Comarch OCR API<\/td>

https:\/\/ocr.erp.comarch.pl\/v1.0\/api\/<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Informacja<\/div>

W celu korzystania z us\u0142ugi Comarch OCR nale\u017cy odblokowa\u0107 komunikacj\u0119 do adres\u00f3w *.erp.comarch.pl na porcie 443 (SSL).<\/div><\/div><\/section>\n

W pierwszym kroku nale\u017cy zalogowa\u0107 si\u0119 w aplikacji Comarch OCR<\/a> i wygenerowa\u0107 klucze dost\u0119powe.<\/p>\n

Metody<\/h2>\n
<\/a><\/p>\n

Tworzenie sesji u\u017cytkownika\u00a0(POST)<\/h3>\n

Adres: https:\/\/ocr.erp.comarch.pl\/v1.0\/api\/sessions\/post<\/a><\/p>\n

W nag\u0142\u00f3wku zapytania nale\u017cy do\u0142\u0105czy\u0107 nast\u0119puj\u0105ce dane uwierzytelniaj\u0105ce:<\/p>\n\n\n\n\n\t\n\n\t\n\t
Klucz<\/th> Warto\u015b\u0107<\/th>\n<\/tr>\n<\/thead>\n
authKey<\/td> Klucz wygenerowany w panelu do zarz\u0105dzania Comarch OCR<\/td>\n<\/tr>\n
authSecret<\/td> Sekret wygenerowany w panelu do zarz\u0105dzania Comarch OCR<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n
Opis struktury JSON odpowiedzi<\/p>\n\n\n\n\n\t\n\n\t
Property<\/th> Opis<\/th>\n<\/tr>\n<\/thead>\n
sessionToken<\/td> Token sesji<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n
Przyk\u0142adowa odpowied\u017a JSON<\/p>\n
{ \n\"sessionToken\": \"00000000-0000-0000-0000-000000000000\"\" \n} \n<\/code><\/p>\n
Mo\u017cliwe kody odpowiedzi HTTP:<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\tKod<\/th> Znaczenie<\/th>\n<\/tr>\n<\/thead>\n 200<\/td> Poprawnie wygenerowano token sesji.<\/td>\n<\/tr>\n 400<\/td> Brak wymaganych parametr\u00f3w w nag\u0142\u00f3wku \u017c\u0105dania lub b\u0142\u0119dne dane.<\/td>\n<\/tr>\n 403<\/td> Wymagane jest u\u017cycie SSL<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/a><\/p>\nUsuwanie sesji u\u017cytkownika\u00a0(DELETE)<\/h3>\nAdres: https:\/\/ocr.erp.comarch.pl\/v1.0\/api\/sessions\/delete<\/a><\/p>\n <\/p>\n W nag\u0142\u00f3wku zapytania nale\u017cy do\u0142\u0105czy\u0107 nast\u0119puj\u0105ce warto\u015bci:<\/p>\n\n\n\n\n\t\n\n\tKlucz<\/th> Warto\u015b\u0107<\/th>\n<\/tr>\n<\/thead>\n authToken<\/td> Token sesji<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n\n\n\n\t\n\n\t\n\t\n\tKod<\/th> Znaczenie<\/th>\n<\/tr>\n<\/thead>\n 204<\/td> Sesja poprawnie zako\u0144czona<\/td>\n<\/tr>\n 400<\/td> Brak tokenu sesji w nag\u0142\u00f3wku \u017c\u0105dania.<\/td>\n<\/tr>\n 403<\/td> Wymagane jest u\u017cycie SSL<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n<\/a><\/p>\nPrzetwarzanie dokumentu\u00a0(POST)<\/h3>\nAdres: https:\/\/ocr.erp.comarch.pl\/v1.0\/api\/invoice\/post<\/a><\/p>\n <\/p>\n Opis struktury JSON zapytania<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\tProperty<\/th> Opis<\/th>\n<\/tr>\n<\/thead>\n Data<\/td> Plik o rozszerzeniu *.jpg, *.png, *bmp lub *.pdf w postaci binarnej<\/td>\n<\/tr>\n InvoiceGuid<\/td> Opcjonalne - GUID<\/td>\n<\/tr>\n Filename<\/td> Nazwa pliku wraz z rozszerzeniem<\/td>\n<\/tr>\n ReturnData<\/td> Opcjonalne - informacja czy us\u0142uga ma zwr\u00f3ci\u0107 pliki dla przetworzonych dokument\u00f3w, warto\u015b\u0107 parametru 1 \u2013 pliki s\u0105 do\u0142\u0105czone do odpowiedzi<\/td>\n<\/tr>\n RecognitionLanguageOption<\/td> Opcjonalny - j\u0119zyk rozpoznawania dokumentu, \n0 - j. polski (je\u015bli na fakturze zostanie rozpoznany j\u0119zyk angielski, rozpoznanie nast\u0105pi jak dla faktur angielskich), \n1 - j. niemiecki, \n2 - j. francuski, \n3 - j. angielski \n-1 \u2013 rozpoznanie na podstawie j\u0119zyka wykrytego na dokumencie \n(domy\u015blnie - j. polski)<\/td>\n<\/tr>\n BarCodeRecognition<\/td> Opcjonalny - informacja czy nale\u017cy rozpoznawa\u0107 kody kreskowe da dokumentach, opcja wymaga ustawienia ExportFormat=1, 0 - nie rozpoznaje kod\u00f3w, 1 - rozpoznaje kody, 2 - \u0142\u0105czy strony na podstawie rozpoznanych kod\u00f3w<\/td>\n<\/tr>\n OneInvoiceFile<\/td> Opcjonalny - informacja jak nale\u017cy \u0142\u0105czy\u0107 strony w przes\u0142anym pliku, 0 - \u0142\u0105czenie stron w dokumenty na podstawie danych zawartych na stronach, 1 - jeden przes\u0142any plik to jeden dokument<\/td>\n<\/tr>\n DefaultPaymentForm<\/td> Opcjonalny \u2013 domy\u015blna forma p\u0142atno\u015bci jaka ma zosta\u0107 zwr\u00f3cona w przypadku nie wykrycia formy p\u0142atno\u015bci na dokumencie (np. \u201egot\u00f3wka\u201d)<\/td>\n<\/tr>\n Language<\/td> Opcjonalny \u2013 informacja w jakim j\u0119zyku maj\u0105 byc zwr\u00f3cone komunikaty, 0 - j. polski, 1 - j. niemiecki (domy\u015blnie - j. polski)<\/td>\n<\/tr>\n PagesToRecognize<\/td> Opcjonalny \u2013 informacja kt\u00f3re strony w pliku maj\u0105 zosta\u0107 rozpoznane (np. \"1-3,5\")<\/td>\n<\/tr>\n RawRecognitionText<\/td> \nOpcjonalny \u2013 informacja czy ma zosta\u0107 zwr\u00f3cona oryginalna, niezmieniona tre\u015b\u0107 wykryta na stronie, 0 - brak oryginalnej tre\u015bci, 1 - oryginalna tre\u015b\u0107 zostanie zwr\u00f3cona <\/td>\n<\/tr>\n PaymentMethodMapping<\/td> Opcjonalny \u2013 tylko dla dokument\u00f3w w j\u0119zyku angielskim, informacja czy forma p\u0142atno\u015bci ma zosta\u0107 mapowana na podstawow\u0105 form\u0119 p\u0142atno\u015bci (got\u00f3wka, przedp\u0142ata, karta, przelew), 0 - brak mapowania, 1 - mapowanie <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\nW nag\u0142\u00f3wku zapytania nale\u017cy do\u0142\u0105czy\u0107 nast\u0119puj\u0105ce warto\u015bci:<\/p>\n\n\n\n\n\t\n\n\tKlucz<\/th> Warto\u015b\u0107<\/th>\n<\/tr>\n<\/thead>\n authToken<\/td> Token sesji<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\nSchemat zapytania:<\/p>\n {\r\n\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"type\": \"object\",\r\n\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"properties\": {\r\n\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"Data\": {\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"type\": [\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"string\"\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ]\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"InvoiceGuid\": {\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"type\": [\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"string\"\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ]\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Filename\": {\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"type\": [\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"string\"\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ]\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \" ReturnData\": {\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"type\": [\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"integer\"\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ]\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 },\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \" RecognitionLanguageOption \": {\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"type\": [\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"integer\"\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ]\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0},\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \" BarCodeRecognition \": {\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"type\": [\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"integer\"\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ]\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n \u00a0\u00a0\u00a0\u00a0\u00a0 },\r\n \u00a0\u00a0\u00a0\u00a0\u00a0 \"required\": [\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Data\",\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \"Filename\",\r\n \u00a0\u00a0\u00a0\u00a0\u00a0 ]<\/pre>\n <\/p>\n Opis struktury JSON odpowiedzi<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\tProperty<\/th> Opis<\/th>\n<\/tr>\n<\/thead>\n ExportString<\/td> Odpowied\u017a w formacie JSON<\/td>\n<\/tr>\n Message<\/td> Komunikat o wyniku przetwarzania dokumentu przez us\u0142ug\u0119<\/td>\n<\/tr>\n Code<\/td> Kod odpowiedzi<\/td>\n<\/tr>\n Status<\/td> Status odpowiedzi<\/td>\n<\/tr>\n AdditionalMessage<\/td> Dodatkowa informacja o pozosta\u0142ych dokumentach, gdy w pakiecie pozosta\u0142o 10 lub mniej dokument\u00f3w<\/td>\n<\/tr>\n UriToDownload<\/td> Adres URL do strony sp\u00f3jnej z kodem odpowiedzi<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\nSchemat odpowiedzi:<\/p>\n \r\n{ \r\n \"type\": \"object\", \r\n \"properties\": { \r\n \"ExportString\": { \r\n \"type\": [ \r\n \"string\", \r\n \"null\" \r\n ] \r\n }, \r\n \"Message\": { \r\n \"type\": [ \r\n \"string\", \r\n \"null\" \r\n ] \r\n }, \r\n \"Code\": { \r\n \"type\": \"integer\" \r\n }, \r\n \"Status\": { \r\n \"type\": \"integer\" \r\n }, \r\n \"AdditionalMessage\": { \r\n \"type\": [ \r\n \"string\", \r\n \"null\" \r\n ] \r\n }, \r\n \"UriToDownload\": { \r\n \"type\": [ \r\n \"string\", \r\n \"null\" \r\n ] \r\n } \r\n }, \r\n \"required\": [ \r\n \"ExportString\", \r\n \"Message\", \r\n \"Code\", \r\n \"Status\", \r\n \"AdditionalMessage\", \r\n \"UriToDownload\" \r\n ] \r\n} \r\n\r\n<\/pre>\nStruktura przyk\u0142adowego pliku w formacie JSON zawartego w odpowiedzi z serwera us\u0142ugi Comarch OCR.<\/p>\n \r\n[\r\n {\r\n \"Fields\": {\r\n \"DocumentNumber\": \"12\/03\/2019\", - numer faktury\r\n \"DateOfIssue\": \"2018-11-08\", - data wystawienia\r\n \"DateOfSale\": \"2018-11-08\", - data sprzeda\u017cy\r\n \"DueDate\": \"2018-11-08\", - data p\u0142atno\u015bci\r\n \"PaymentForm\": \"got\u00f3wka\", - spos\u00f3b p\u0142atno\u015bci\r\n \"BankAccountNumber\": \"11100110011001100110011001\" - numer rachunku\r\n },\r\n \"IsCorrection\": true, - informacja czy faktura jest korekt\u0105\r\n \"CorrectedDocumentNumber\": \"11\/03\/2019\", - numer dokumentu korygowanego\r\n \"Language\": \"PL\", - j\u0119zyk rozpoznany na dokumencie\r\n \"NumberOfPagesLeft\": 123, - liczba stron, kt\u00f3re pozosta\u0142y do wykorzystania w pakiecie\r\n \"SellerContractor\": { - dane sprzedawcy\r\n \"TIN\": \"1111111111\",\r\n \"CompanyName\": \"PRZYK\u0141ADOWA SP\u00d3\u0141KA Z OGRANICZON\u0104 ODPOWIEDZIALNO\u015aCI\u0104\",\r\n \"Street\": \"ul. \u017byczkowskiego\",\r\n \"StreetNumber\": \"\",\r\n \"ApartmentsNumber\": \"12\",\r\n \"PostCode\": \"11-111\",\r\n \"PostOffice\": \"Krak\u00f3w\",\r\n \"City\": \"Krak\u00f3w\",\r\n \"Voivodeship\": \"MA\u0141OPOLSKIE\",\r\n \"ActiveVATTaxpayer\": true\r\n },\r\n \"BuyerContractor\": { - dane nabywcy\r\n \"TIN\": \"1111111111\",\r\n \"CompanyName\": \"PRZYK\u0141ADOWA SP\u00d3\u0141KA Z OGRANICZON\u0104 ODPOWIEDZIALNO\u015aCI\u0104\",\r\n \"Street\": \"ul. \u017byczkowskiego\",\r\n \"StreetNumber\": \"\",\r\n \"ApartmentsNumber\": \"12\",\r\n \"PostCode\": \"11-111\",\r\n \"PostOffice\": \"Krak\u00f3w\",\r\n \"City\": \"Krak\u00f3w\",\r\n \"Voivodeship\": \"MA\u0141OPOLSKIE\",\r\n \"ActiveVATTaxpayer \": true\r\n },\r\n \"Currency\": \"PLN\", - symbol waluty, je\u017celi puste to oznacza, \u017ce waluta PLN\r\n \"VatPositions\": [ - pozycje tabeli VAT\r\n {\r\n \"VatRate\": 23,\r\n \"Subtotal\": -62.52,\r\n \"VAT\": -14.38,\r\n \"Total\": -76.9,\r\n \"VatStatus\": 0 \u2013 0 \u2013 opodatkowana, 1- zwolniona, 2- nie podlega\r\n }\r\n ],\r\n \"PageProperties\": {\r\n \"FirstPageNumber\": 1, - informacja na kt\u00f3rej stronie pliku pdf znajduje si\u0119 dokument\r\n \"DocumentLength\": 1, - informacja ile stron posiada dokument\r\n \"PageRotation\": 0 - informacja o ile stopni zgodnie z ruchem wskaz\u00f3wek zegara nale\u017cy obr\u00f3ci\u0107 dokument w formacie .pdf, aby by\u0142 wy\u015bwietlany poprawnie\r\n }\r\n\r\n \"ProductItems\": [ - pozycje tabeli produkt\u00f3w\r\n {\r\n \"Name\": \"Produkt 1\",\r\n \"Unit\": \"szt\",\r\n \"ProductCode\": \"123456789012\",\r\n \"Count\": 2,\r\n \"NettoUnitPrice\": 31.26,\r\n \"BruttoUnitPrice \": 39.8,\r\n \"Netto\": 62.52,\r\n \"Brutto\": 79.6,\r\n \"VatRate\": 0.23,\r\n \"VatAmount\": 14.38 \r\n}\r\n ], \r\n \"Attachment\": \"JVBERi0xLjQKJdP0zOEKMSAwIG9iago8\u2026\", - plik binarny przetworzonego dokumentu w formacie base64\r\n \"Barcode\": { - rozpoznany na dokumencie kod kreskowy\r\n \"Text\": 1, - odczytany numer\r\n \"Type\": \"EAN8\" - rodzaj kodu kreskowego\r\n }\r\n \"JpkCodes\": [ - kody JPK_V7 wyst\u0119puj\u0105ce na fakturze\r\n {\r\n \"Code\": \"GTU_01\",\r\n\r\n<\/pre>\nStruktura przyk\u0142adowego pliku w formacie JSON dla faktur w j\u0119zyku niemieckim zawartego w odpowiedzi z serwera us\u0142ugi Comarch OCR. ( dla RecognitionLanguageOption=1)<\/em><\/p>\n \r\n{\r\n \"Fields\": {\r\n \"DocumentNumber\": \"12\/03\/2019\", - numer faktury\r\n \"DateOfIssue\": \"2018-11-08\", - data wystawienia\r\n \"GrossPrice\": \"52,50\", - kwota brutto\r\n \"UstIDNumber\": \"79865412\", - numer identyfikacyjny sprzedawcy\r\n \"OrderNumber\": \"A123456789\", - numer identyfikacyjny sprzedawcy\r\n \"PurchaseOrderNumber \": \"B123456789\", - numer identyfikacyjny sprzedawcy\r\n \"TaxIdentificationNumber\": \"B123456789\", - Steuernummer sprzedawcy\r\n \"Reference\": \"0110454\", - referencja z kodu QR\r\n \"AdditionalInformation\": \"0110454\", - dodatkowe informacje z kodu QR\r\n \"BillInformation\": \"052375900000000000001765321\", - informacje o rachunku z kodu QR\r\n \"EsrCode\": \"001104549>052375900000000000001765321+ 0110454\", - kod ESR\r\n \"EsrReference\": \"052375900000000000001765321\", - referencja z kodu ESR\r\n \"EsrSubscriberNumber\": \"0110454\", - numer subskrybenta z kodu ESR\r\n },\r\n \"BuyerContractor\": { - dane nabywcy\r\n \"CompanyName\": \"Comarch\",\r\n \"Street\": \"Maximilianstra\u00dfe\",\r\n \"StreetNumber\": \"12\",\r\n \"ApartmentsNumber\": \"10\",\r\n \"PostCode\": \"01010\",\r\n \"City\": \"M\u00fcnchen \",\r\n },\r\n \"SellerContractor\": { - dane sprzedawcy, gdy nie rozpoznano UstIDNumber\r\n \"CompanyName\": \"Comarch\",\r\n \"Street\": \"Friedrichtra\u00dfe\",\r\n \"StreetNumber\": \"24\",\r\n \"ApartmentsNumber\": \"20\",\r\n \"PostCode\": \"02020\",\r\n \"City\": \"M\u00fcnchen \",\r\n },\r\n\r\n \"Currency\": \"EUR\", \r\n \"Language\": \"DE\", - j\u0119zyk rozpoznany na dokumencie\r\n \"NumberOfPagesLeft\": 123, - liczba stron, kt\u00f3re pozosta\u0142y do wykorzystania w pakiecie\r\n \"PageProperties\": {\r\n \"FirstPageNumber\": 1, - informacja na kt\u00f3rej stronie pliku pdf znajduje si\u0119 dokument\r\n \"DocumentLength\": 1, - informacja ile stron posiada dokument\r\n \"PageRotation\": 0 - informacja o ile stopni zgodnie z ruchem wskaz\u00f3wek zegara nale\u017cy obr\u00f3ci\u0107 dokument w formacie .pdf, aby by\u0142 wy\u015bwietlany poprawnie\r\n }\r\n \"Attachment\": \"JVBERi0xLjQKJdP0zOEKMSAwIG9iago8\u2026\", - plik binarny przetworzonego dokumentu w formacie base64\r\n }\r\n]\r\n\r\n<\/pre>\nStruktura przyk\u0142adowego pliku w formacie JSON dla faktur w j\u0119zyku francuskim zawartego w odpowiedzi z serwera us\u0142ugi Comarch OCR. (dla RecognitionLanguageOption=2)<\/em><\/p>\n \r\n[\r\n {\r\n \"Fields\": {\r\n \"DocumentNumber\": \"12\/03\/2019\", - numer faktury\r\n \"DateOfIssue\": \"2018-11-08\", - data wystawienia\r\n \"DateOfSale\": \"2018-11-08\", - data sprzeda\u017cy\r\n \"DueDate\": \"2018-11-08\", - data p\u0142atno\u015bci\r\n },\r\n \"BuyerContractor\": { - dane nabywcy\r\n \"CompanyName\": \"Comarch\",\r\n \"Street\": \" Rue Paul Langevin \",\r\n \"StreetNumber\": \"12\",\r\n \"ApartmentsNumber\": \"10\",\r\n \"PostCode\": \"01010\",\r\n \"City\": \"Paris\",\r\n },\r\n \"BuyerContractor\": { - dane nabywcy\r\n \"CompanyName\": \"Comarch\",\r\n \"Street\": \"Rue Paul Langevin\",\r\n \"StreetNumber\": \"12\",\r\n \"ApartmentsNumber\": \"10\",\r\n \"PostCode\": \"01010\",\r\n \"City\": \"Paris\",\r\n },\r\n \"Currency\": \"EUR\", - symbol waluty\r\n \"Language\": \"FR\", - j\u0119zyk rozpoznany na dokumencie\r\n \"NumberOfPagesLeft\": 123, - liczba stron, kt\u00f3re pozosta\u0142y do wykorzystania w pakiecie\r\n \"VatPositions\": [ - pozycje tabeli VAT\r\n {\r\n \"VatRate\": 23,\r\n \"Subtotal\": -62.52,\r\n \"VAT\": -14.38,\r\n \"Total\": -76.9,\r\n \"VatStatus\": 0 \u2013 0 \u2013 opodatkowana, 1- zwolniona, 2- nie podlega\r\n }\r\n ],\r\n \"PageProperties\": {\r\n \"FirstPageNumber\": 1, - informacja na kt\u00f3rej stronie pliku pdf znajduje si\u0119 dokument\r\n \"DocumentLength\": 1, - informacja ile stron posiada dokument\r\n \"PageRotation\": 0 - informacja o ile stopni zgodnie z ruchem wskaz\u00f3wek zegara nale\u017cy obr\u00f3ci\u0107 dokument w formacie .pdf, aby by\u0142 wy\u015bwietlany poprawnie\r\n }\r\n\r\n \"ProductItems\": [ - pozycje tabeli produkt\u00f3w\r\n {\r\n \"Name\": \"Produit 1\",\r\n \"Unit\": \"pcs\",\r\n \"ProductCode\": \"123456789012\",\r\n \"Count\": 2,\r\n \"NettoUnitPrice\": 31.26,\r\n \"BruttoUnitPrice \": 39.8,\r\n \"Netto\": 62.52,\r\n \"Brutto\": 79.6,\r\n \"VatRate\": 0.23,\r\n \"VatAmount\": 14.38 \r\n}\r\n ], \r\n \"Attachment\": \"JVBERi0xLjQKJdP0zOEKMSAwIG9iago8\u2026\", - plik binarny przetworzonego dokumentu w formacie base64\r\n }\r\n]\r\n\r\n<\/pre>\nOg\u00f3lny opis mo\u017cliwych scenariuszy odpowiedzi z serwera us\u0142ugi Comarch OCR<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\tCode<\/th> Status<\/th> Opis<\/th> Dodatkowe informacje<\/th>\n<\/tr>\n<\/thead>\n Dowolny<\/td> 1<\/td> Informacja<\/td> <\/td>\n<\/tr>\n Dowolny<\/td> 2<\/td> Ostrze\u017cenie<\/td> Nale\u017cy sprawdzi\u0107 czy co\u015b si\u0119 znajduje w AdditionalMessage lub UriToDownload<\/td>\n<\/tr>\n Dowolny<\/td> 3<\/td> B\u0142\u0105d<\/td> Nale\u017cy sprawdzi\u0107 czy co\u015b si\u0119 znajduje w AdditionalMessage lub UriToDownload<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\nSzczeg\u00f3\u0142owy opis mo\u017cliwych scenariusz\u00f3w odpowiedzi z serwera us\u0142ugi Comarch OCR<\/p>\n\n\n\n\n\t\n\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\n\tCode<\/th> Status<\/th> Opis<\/th> Dodatkowe informacje<\/th>\n<\/tr>\n<\/thead>\n 1<\/td> 1<\/td> Dokument rozpoznany prawid\u0142owo.<\/td> <\/td>\n<\/tr>\n 1<\/td> 2<\/td> Dokument rozpoznany prawid\u0142owo.<\/td> Klientowi pozosta\u0142o w pakiecie 10 lub mniej dokument\u00f3w, szczeg\u00f3\u0142owa informacja w AdditionalMessage, link do sklepu Comarch znajduje si\u0119 w UriToDownload.<\/td>\n<\/tr>\n 2<\/td> 1<\/td> Dokument rozpoznany cz\u0119\u015bciowo lub b\u0142\u0119dnie.<\/td> <\/td>\n<\/tr>\n 2<\/td> 2<\/td> Dokument rozpoznany cz\u0119\u015bciowo lub b\u0142\u0119dnie.<\/td> Klientowi pozosta\u0142o w pakiecie 10 lub mniej dokument\u00f3w, szczeg\u00f3\u0142owa informacja w AdditionalMessage, link do sklepu Comarch znajduje si\u0119 w UriToDownload.<\/td>\n<\/tr>\n 3<\/td> 3<\/td> Dokument nierozpoznany.<\/td> <\/td>\n<\/tr>\n 4<\/td> 3<\/td> Funkcja niedost\u0119pna.<\/td> <\/td>\n<\/tr>\n 5<\/td> 3<\/td> Przerwa techniczna.<\/td> <\/td>\n<\/tr>\n 6<\/td> 3<\/td> Niepoprawne zapytanie.<\/td> <\/td>\n<\/tr>\n 7<\/td> 3<\/td> Niepoprawny numer klucza.<\/td> <\/td>\n<\/tr>\n 8<\/td> 3<\/td> Brak podpisanej klauzuli RODO.<\/td> Link do formularza z umow\u0105 znajduje si\u0119 w UriToDownload.<\/td>\n<\/tr>\n 9<\/td> 3<\/td> Brak wykupionego pakietu przez klienta.<\/td> Link do sklepu Comarch znajduje si\u0119 w UriToDownload.<\/td>\n<\/tr>\n 10<\/td> 3<\/td> Wykorzystany pakiet dokument\u00f3w.<\/td> Link do sklepu Comarch znajduje si\u0119 w UriToDownload.<\/td>\n<\/tr>\n 11<\/td> 3<\/td> Klient zaznaczy\u0142 dokument w kt\u00f3rym jest wi\u0119cej stron ni\u017c pozosta\u0142o w pakiecie.<\/td> Link do sklepu Comarch znajduje si\u0119 w UriToDownload.<\/td>\n<\/tr>\n 12<\/td> 3<\/td> Rozmiar pojedynczej strony przekracza obs\u0142ugiwany limit.<\/td> <\/td>\n<\/tr>\n 13<\/td> 3<\/td> Klient zosta\u0142 zablokowany ze wzgl\u0119du na brak op\u0142aconego pakietu.<\/td> <\/td>\n<\/tr>\n 14<\/td> 3<\/td> B\u0142\u0119dny token sesji. (W przypadku korzystania z OCR API)<\/td> <\/td>\n<\/tr>\n 15<\/td> 3<\/td> Brak dost\u0119pu do API OCR (W przypadku korzystania z OCR API)<\/td> <\/td>\n<\/tr>\n 17<\/td> 3<\/td> Nierozpoznany j\u0119zyk na dokumencie (W przypadku korzystania z OCR API)<\/td> <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\nW przypadku odpowiedzi z serwera z Code innym ni\u017c wymienione w tabeli powy\u017cej nale\u017cy wy\u015bwietli\u0107 informacj\u0119 zgodnie ze Statusem. <\/strong><\/p>\n Komunikat tej informacji znajduje si\u0119 w Message lub AdditionalMessage, i ewentualny link w UriToDownload.<\/strong><\/p>\n Przyk\u0142adowe zapytanie JSON<\/p>\n { \n\"Data\": \"[DANE BINARNE]\", \n\"InvoiceGuid\":\"dce8b807-2846-4816-a24b-12d7eca140ed\", \n\"Filename\":\"255430.pdf\", \n}<\/code><\/p>\n Przyk\u0142adowa odpowied\u017a JSON \n{ \n\"ExportString\": \"[ODPOWIED\u0179 W FORMACIE JSON]\", \n\"Message\": \"Rozpoznano dokument 255430.pdf.\", \n\"Code\": 1, \n\"Status\": 2, \n\"AdditionalMessage\": \"W bezp\u0142atnym pakiecie Demo OCR zosta\u0142o jeszcze 7 dokument\u00f3w do \nwykorzystania. Kliknij w ten komunikat, aby przej\u015b\u0107 do Sklepu Comarch i kupi\u0107 \nodpowiedni Pakiet Comarch OCR.\", \n\"UriToDownload\": \"https:\/\/sklep.comarch.pl\/produkty\/ocr,2,16251\" \n}<\/code><\/p>\n","protected":false},"excerpt":{"rendered":" W pierwszym kroku nale\u017cy zalogowa\u0107 si\u0119 w aplikacji Comarch OCR i wygenerowa\u0107 klucze dost\u0119powe. Metody Tworzenie sesji u\u017cytkownika\u00a0(POST) Adres: https:\/\/ocr.erp.comarch.pl\/v1.0\/api\/sessions\/post W nag\u0142\u00f3wku zapytania nale\u017cy do\u0142\u0105czy\u0107 nast\u0119puj\u0105ce dane uwierzytelniaj\u0105ce: Opis struktury JSON odpowiedzi Przyk\u0142adowa odpowied\u017a JSON { „sessionToken”: „00000000-0000-0000-0000-000000000000″” } Mo\u017cliwe kody odpowiedzi HTTP: Usuwanie sesji u\u017cytkownika\u00a0(DELETE) Adres: https:\/\/ocr.erp.comarch.pl\/v1.0\/api\/sessions\/delete W nag\u0142\u00f3wku zapytania nale\u017cy do\u0142\u0105czy\u0107 […]<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","meta":{"_ht_kb_usefulness":0,"_ht_kb_post_views_count":1835,"_ht_kb_article_order":0,"_ht_kb_reading_time":10,"footnotes":""},"ht_kb_category":[544],"ht_kb_tag":[],"class_list":["post-42713","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-api-archiwum"],"_links":{"self":[{"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/ht_kb\/42713","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/ht_kb"}],"about":[{"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/comments?post=42713"}],"version-history":[{"count":5,"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/ht_kb\/42713\/revisions"}],"predecessor-version":[{"id":42729,"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/ht_kb\/42713\/revisions\/42729"}],"wp:attachment":[{"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/media?parent=42713"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/ht_kb_category?post=42713"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/pomoc.comarch.pl\/optima\/pl\/2027\/wp-json\/wp\/v2\/ht_kb_tag?post=42713"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}