API Documentation
Documents
Document Conversion
Personal Earnings Statement
Certificate Of Origin
Dangerous Goods Declaration
International Consignment Note
Remittance Advice
Get Remittance Advice Fields
This endpoint returns an object representing the extracted remittance-advice model fields from a document.
GET
/
v1-preview
/
models
/
remittance-advice
/
{documentId}
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.RemittanceAdvice.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"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
Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com
Path Parameters
The id of the document
Response
200
application/json
Extracted Remittance Advice Data Response
Was this page helpful?
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.RemittanceAdvice.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"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"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.