OCR PDF or image

POST

/Import/ocrDocumentForm/:typeResult

POST

/api/Import/ocrDocumentForm/:typeResult

curl -X POST https://api-sandbox.payabli.com/api/Import/ocrDocumentForm/typeResult \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: multipart/form-data" \
     -F file=@string

{
  "isSuccess": true,
  "responseText": "string",
  "responseCode": 1,
  "responseData": {
    "resultData": {
      "billNumber": "string",
      "netAmount": 1.1,
      "billDate": "2024-01-15T09:30:00Z",
      "dueDate": "2024-01-15T09:30:00Z",
      "comments": "string",
      "billItems": [
        {
          "itemTotalAmount": 1.1,
          "itemTaxAmount": 1.1,
          "itemTaxRate": 1.1,
          "itemProductCode": "string",
          "itemProductName": "string",
          "itemDescription": "string",
          "itemCommodityCode": "string",
          "itemUnitOfMeasure": "string",
          "itemCost": 1.1,
          "itemQty": 1,
          "itemMode": 1,
          "itemCategories": [
            "string"
          ]
        }
      ],
      "mode": 1,
      "accountingField1": "string",
      "accountingField2": "string",
      "additionalData": {
        "category": "string",
        "currency_code": "string",
        "type": "string",
        "reference_number": "string"
      },
      "vendor": {
        "vendorNumber": "string",
        "name1": "string",
        "name2": "string",
        "ein": "string",
        "phone": "string",
        "email": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "zip": "string",
        "country": "string",
        "mcc": "string",
        "locationCode": "string",
        "contacts": [
          {
            "contactEmail": "string",
            "contactName": "string",
            "contactPhone": "string",
            "contactTitle": "string",
            "additionalData": "string"
          }
        ],
        "billingData": {
          "id": 1,
          "bankName": "string",
          "routingAccount": "string",
          "accountNumber": "string",
          "typeAccount": "string",
          "bankAccountHolderName": "string",
          "bankAccountHolderType": "string",
          "bankAccountFunction": 1
        },
        "paymentMethod": "string",
        "vendorStatus": 1,
        "remitAddress1": "string",
        "remitAddress2": "string",
        "remitCity": "string",
        "remitState": "string",
        "remitZip": "string",
        "remitCountry": "string",
        "payeeName1": "string",
        "payeeName2": "string",
        "customerVendorAccount": "string",
        "internalReferenceId": 1,
        "customField1": "string",
        "customField2": "string",
        "additionalData": {
          "web": "string"
        }
      },
      "endDate": "2024-01-15T09:30:00Z",
      "frequency": "string",
      "terms": "string",
      "status": 1,
      "lotNumber": "string",
      "attachments": [
        {
          "ftype": "string",
          "filename": "string",
          "fileDescriptor": "string",
          "furl": "string",
          "fContent": "string"
        }
      ]
    }
  }
}

Use this endpoint to upload a document file for OCR processing as multipart/form-data, with the file in a field named file. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either ‘bill’ or ‘invoice’) in the path parameter typeResult. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more. To send the file as a Base64-encoded string in a JSON body instead, use ocrDocumentJson.

Use this endpoint to upload a document file for OCR processing as `multipart/form-data`, with the file in a field named `file`. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more. To send the file as a Base64-encoded string in a JSON body instead, use `ocrDocumentJson`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

typeResultstringRequired

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

Request

This endpoint expects a multipart form containing a file.

filefileRequired

The document to process, sent as a file upload in a field named file. Accepted formats are PDF, JPG, JPEG, PNG, and GIF.

Response

OCR document processing result

isSuccessboolean

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

responseTextstring

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

responseCodeinteger

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

responseDataobjectOptional

Details of the OCR processing result

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error