GET
/
v1-preview
/
models
/
remittance-advice
/
{documentId}
from abbyy_document_ai import DocumentAi
import os


with DocumentAi(
    api_key_auth=os.getenv("DOCUMENTAI_API_KEY_AUTH", ""),
) as document_ai:

    res = document_ai.models.remittance_advice.get_extracted_fields(document_id="wh23anb5xjf0ntw5taase5qz")

    assert res.remittance_advice is not None

    # Handle response
    print(res.remittance_advice)
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "remittance-advice",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "customer": {
      "customerIdAsPrinted": "CUST123",
      "name": "Acme Corporation",
      "address": "123 Business Ave, Suite 100, New York, NY 10001"
    },
    "vendor": {
      "vendorIdAsPrinted": "VEND456",
      "name": "Global Supplies Ltd",
      "address": "456 Commerce St, Chicago, IL 60601"
    },
    "paymentInformation": {
      "paymentNumber": "PAY789",
      "paymentDate": "2024-03-15",
      "paymentAmount": 5000,
      "currency": "USD"
    },
    "total": 5000,
    "bankKey": "BANKUS33",
    "lineItems": [
      {
        "invoiceNumber": "INV001",
        "invoiceDate": "2024-02-15",
        "paidAmount": 3000,
        "invoiceAmount": 3000,
        "discount": 0,
        "type": "Debit",
        "customerId": "CUST123"
      },
      {
        "invoiceNumber": "INV002",
        "invoiceDate": "2024-02-28",
        "paidAmount": 2000,
        "invoiceAmount": 2000,
        "discount": 0,
        "type": "Debit",
        "customerId": "CUST123"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com

Path Parameters

​
documentId
string
required

The id of the document

Response

200
application/json

Extracted Remittance Advice Data Response

​
meta
object
required

Represents a document that has been submitted for processing.

Example:
{
  "id": "wh23anb5xjf0ntw5taase5qz",
  "name": "document.jpg",
  "createdAt": "2025-02-07T17:44:06.949Z",
  "model": "image-to-text",
  "status": "Processed",
  "pageCount": 10,
  "errors": [{ "message": "Total is required" }]
}
​
fields
object

Fields extracted from a remittance advice

Example:
{
  "customer": {
    "customerIdAsPrinted": "CUST123",
    "name": "Acme Corporation",
    "address": "123 Business Ave, Suite 100, New York, NY 10001"
  },
  "vendor": {
    "vendorIdAsPrinted": "VEND456",
    "name": "Global Supplies Ltd",
    "address": "456 Commerce St, Chicago, IL 60601"
  },
  "paymentInformation": {
    "paymentNumber": "PAY789",
    "paymentDate": "2024-03-15",
    "paymentAmount": 5000,
    "currency": "USD"
  },
  "total": 5000,
  "bankKey": "BANKUS33",
  "lineItems": [
    {
      "invoiceNumber": "INV001",
      "invoiceDate": "2024-02-15",
      "paidAmount": 3000,
      "invoiceAmount": 3000,
      "discount": 0,
      "type": "Debit",
      "customerId": "CUST123"
    },
    {
      "invoiceNumber": "INV002",
      "invoiceDate": "2024-02-28",
      "paidAmount": 2000,
      "invoiceAmount": 2000,
      "discount": 0,
      "type": "Debit",
      "customerId": "CUST123"
    }
  ]
}
​
validationErrors
object[]

An array of validation errors that occurred while processing the document. These typically do not prevent field extraction, but rather indicate issues extracting key fields.

Was this page helpful?