CorebanqCorebanq Developer Docs
Invoicesv3OCR

Poll authoring OCR job status (v3)

Returns the current status of a v3 authoring OCR job. When status=200 the Swiss-shaped result is populated. A job of a different kind (v1/v2) is reported as not found.

GET
/v3/invoices/ocr/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Job UUID returned by POST /v3/invoices/ocr

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v3/invoices/ocr/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "status": 0,
  "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  "result": {
    "invoice_number": "string",
    "reference": "string",
    "reference_type": "string",
    "reference_number": "string",
    "vat_number": "string",
    "payment_conditions": "string",
    "currency": "string",
    "issue_date": "string",
    "due_date": "string",
    "creditor": {
      "name": "string",
      "email": "string",
      "address": "string",
      "iban": "string",
      "bic": "string",
      "bank": "string"
    },
    "debtor": {
      "name": "string",
      "email": "string",
      "address": "string",
      "iban": "string",
      "bic": "string",
      "bank": "string"
    },
    "items": [
      {
        "title": "string",
        "description": "string",
        "quantity": "string",
        "price": "string",
        "mwst_rate": "string"
      }
    ],
    "subtotal": "string",
    "discount": "string",
    "shipping": "string",
    "vat_amount": "string",
    "total": "string"
  },
  "message": "string"
}
{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "status": 0,
  "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  "result": {
    "invoice_number": "string",
    "reference": "string",
    "reference_type": "string",
    "reference_number": "string",
    "vat_number": "string",
    "payment_conditions": "string",
    "currency": "string",
    "issue_date": "string",
    "due_date": "string",
    "creditor": {
      "name": "string",
      "email": "string",
      "address": "string",
      "iban": "string",
      "bic": "string",
      "bank": "string"
    },
    "debtor": {
      "name": "string",
      "email": "string",
      "address": "string",
      "iban": "string",
      "bic": "string",
      "bank": "string"
    },
    "items": [
      {
        "title": "string",
        "description": "string",
        "quantity": "string",
        "price": "string",
        "mwst_rate": "string"
      }
    ],
    "subtotal": "string",
    "discount": "string",
    "shipping": "string",
    "vat_amount": "string",
    "total": "string"
  },
  "message": "string"
}
Empty
Empty
Empty
Empty
{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "status": 0,
  "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
  "result": {
    "invoice_number": "string",
    "reference": "string",
    "reference_type": "string",
    "reference_number": "string",
    "vat_number": "string",
    "payment_conditions": "string",
    "currency": "string",
    "issue_date": "string",
    "due_date": "string",
    "creditor": {
      "name": "string",
      "email": "string",
      "address": "string",
      "iban": "string",
      "bic": "string",
      "bank": "string"
    },
    "debtor": {
      "name": "string",
      "email": "string",
      "address": "string",
      "iban": "string",
      "bic": "string",
      "bank": "string"
    },
    "items": [
      {
        "title": "string",
        "description": "string",
        "quantity": "string",
        "price": "string",
        "mwst_rate": "string"
      }
    ],
    "subtotal": "string",
    "discount": "string",
    "shipping": "string",
    "vat_amount": "string",
    "total": "string"
  },
  "message": "string"
}