OCR PDF or image

1 curl -X POST https://api-sandbox.payabli.com/api/Import/ocrDocumentForm/typeResult \ 2 -H "requestToken: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "isSuccess": true, 3 "responseText": "responseText", 4 "responseCode": 1, 5 "responseData": { 6 "resultData": { 7 "billNumber": "billNumber", 8 "netAmount": 1.1, 9 "billDate": "2024-01-15T09:30:00Z", 10 "dueDate": "2024-01-15T09:30:00Z", 11 "comments": "comments", 12 "billItems": [ 13 { 14 "itemTotalAmount": 1.1, 15 "itemTaxAmount": 1.1, 16 "itemTaxRate": 1.1, 17 "itemProductCode": "itemProductCode", 18 "itemProductName": "itemProductName", 19 "itemDescription": "itemDescription", 20 "itemCommodityCode": "itemCommodityCode", 21 "itemUnitOfMeasure": "itemUnitOfMeasure", 22 "itemCost": 1.1, 23 "itemQty": 1, 24 "itemMode": 1, 25 "itemCategories": [ 26 "itemCategories", 27 "itemCategories" 28 ] 29 }, 30 { 31 "itemTotalAmount": 1.1, 32 "itemTaxAmount": 1.1, 33 "itemTaxRate": 1.1, 34 "itemProductCode": "itemProductCode", 35 "itemProductName": "itemProductName", 36 "itemDescription": "itemDescription", 37 "itemCommodityCode": "itemCommodityCode", 38 "itemUnitOfMeasure": "itemUnitOfMeasure", 39 "itemCost": 1.1, 40 "itemQty": 1, 41 "itemMode": 1, 42 "itemCategories": [ 43 "itemCategories", 44 "itemCategories" 45 ] 46 } 47 ], 48 "mode": 1, 49 "accountingField1": "accountingField1", 50 "accountingField2": "accountingField2", 51 "additionalData": { 52 "category": "category", 53 "currency_code": "currency_code", 54 "type": "type", 55 "reference_number": "reference_number" 56 }, 57 "vendor": { 58 "vendorNumber": "vendorNumber", 59 "name1": "name1", 60 "name2": "name2", 61 "ein": "ein", 62 "phone": "phone", 63 "email": "email", 64 "address1": "address1", 65 "address2": "address2", 66 "city": "city", 67 "state": "state", 68 "zip": "zip", 69 "country": "country", 70 "mcc": "mcc", 71 "locationCode": "locationCode", 72 "contacts": [ 73 {}, 74 {} 75 ], 76 "billingData": { 77 "id": 1, 78 "bankName": "bankName", 79 "routingAccount": "routingAccount", 80 "accountNumber": "accountNumber", 81 "typeAccount": "typeAccount", 82 "bankAccountHolderName": "bankAccountHolderName", 83 "bankAccountHolderType": "bankAccountHolderType", 84 "bankAccountFunction": 1 85 }, 86 "paymentMethod": "paymentMethod", 87 "vendorStatus": 1, 88 "remitAddress1": "remitAddress1", 89 "remitAddress2": "remitAddress2", 90 "remitCity": "remitCity", 91 "remitState": "remitState", 92 "remitZip": "remitZip", 93 "remitCountry": "remitCountry", 94 "payeeName1": "payeeName1", 95 "payeeName2": "payeeName2", 96 "customerVendorAccount": "customerVendorAccount", 97 "internalReferenceId": 1000000, 98 "customField1": "customField1", 99 "customField2": "customField2", 100 "additionalData": { 101 "web": "web" 102 } 103 }, 104 "endDate": "2024-01-15T09:30:00Z", 105 "frequency": "frequency", 106 "terms": "terms", 107 "status": 1, 108 "lotNumber": "lotNumber", 109 "attachments": [ 110 { 111 "ftype": "ftype", 112 "filename": "filename", 113 "fileDescriptor": "fileDescriptor", 114 "furl": "furl", 115 "fContent": "fContent" 116 }, 117 { 118 "ftype": "ftype", 119 "filename": "filename", 120 "fileDescriptor": "fileDescriptor", 121 "furl": "furl", 122 "fContent": "fContent" 123 } 124 ] 125 } 126 } 127 }

Path parameters

typeResultstringRequired

The type of object to create in Payabli. Accepted values are bill and invoice.

Request

The image file to OCR. Accepted formats include PDF, JPG, JPEG, PNG, GIF.

ftypeenumOptional

The MIME type of the file (if content is provided)

filenamestringOptional

The name of the file to be uploaded

furlstringOptional

Optional URL link to the file

fContentstringOptional

Base64-encoded file content

Response

OCR document processing result

isSuccessboolean or null

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring or null

Response text for operation: ‘Success’ or ‘Declined’.

responseCodeinteger or null

Code for the response. Learn more in API Response Codes.

responseDataobject or null

Details of the OCR processing result

OCR PDF or image

Path parameters

Headers

Request

Response

Errors