Receipt and Invoice OCR API

API ID 13136

Extracts structured JSON data — vendor name, line items, quantities, prices, subtotal, tax, and total — from photos, scans, or PDF files of receipts and invoices.

Documentação da API

Endpoints

Requisição
Extrai dados estruturados como nome do vendedor, itens da linha, subtotal, imposto e total de uma foto, digitalização ou PDF de um recibo de varejo
Endpoint ID: 26650
POST https://docs.zylalabs.com/api/13136/receipt+and+invoice+ocr+api/26650/extract+receipt
PARÂMETROS DE ENTRADA

Extrair Recibo — Recursos do endpoint

Objeto Descrição
Corpo da requisição Obrigatório Arquivo binário

Solicitações gratuitas de teste restantes: 3 de 3.


PARÂMETROS DE ENTRADA

RESPOSTA DE EXEMPLO DA API
JSON
{"result":{"document_type":"receipt","items":[{"description":"Chocolate (Ice)","quantity":1.0,"unit_price":24000.0,"total_price":24000.0},{"description":"Thai Tea (Ice)","quantity":1.0,"unit_price":24000.0,"total_price":24000.0},{"description":"Cleo Water","quantity":1.0,"unit_price":10000.0,"total_price":10000.0},{"description":"Es Batu","quantity":2.0,"unit_price":2000.0,"total_price":4000.0},{"description":"Nasi Goreng Sun Up","quantity":4.0,"unit_price":30000.0,"total_price":120000.0},{"description":"Chicken Nugget Platter","quantity":1.0,"unit_price":28000.0,"total_price":28000.0}],"subtotal":210000.0,"tax":21000.0,"total":231000.0,"notes":"DINE IN"},"document_info":{"size_mb":0.09,"pages":1,"approx_tokens":300}}
Extrair Recibo — TRECHOS DE CÓDIGO

    curl --location 'https://zylalabs.com/api/13136/receipt+and+invoice+ocr+api/26650/extract+receipt' \
    --header 'Content-Type: application/json' \ 
    --form 'image=@"FILE_PATH"'

Chave de acesso à API e autenticação

Após se cadastrar, cada desenvolvedor recebe uma chave de acesso à API pessoal, uma combinação única de letras e dígitos para acessar nosso endpoint de API. Para autenticar com a Receipt and Invoice OCR API basta incluir seu token Bearer no cabeçalho Authorization.

Cabeçalhos
Cabeçalho Descrição
Authorization Obrigatório Deve ser Bearer access_key. Veja "Sua chave de acesso à API" acima quando você estiver inscrito.

Preços simples e transparentes

Sem compromisso de longo prazo. Faça upgrade, downgrade ou cancele a qualquer momento. O teste gratuito inclui até 50 requisições.

(Economize 2 meses com cobrança anual 🎉)

🚀 Plano Empresarial
Volume personalizado

  • Limite de taxa personalizado
  • Gestão de equipes e acessos
  • Uptime garantido por SLA
  • Suporte ao cliente especializado
  • Monitoramento de API em tempo real
  • Segurança e conformidade empresarial
Contrato anual mínimo: USD 10.000

Empresas líderes confiam em nós

Visão Geral

This API extracts structured data from receipts and invoices. Upload a photo, scan, or PDF file, and receive a JSON response containing the vendor or merchant name, itemized line items with quantity and price, subtotal, tax, discount, total, dates, and payment method when available.

Supported input formats: JPEG, PNG, WEBP, HEIC/HEIF images, and multi-page PDF documents up to 25 pages.

Three endpoints are available: one optimized for retail receipts, one optimized for business invoices, and one that automatically detects which type of document was submitted.

Billing is based on document size — a single-page receipt and a multi-page invoice are billed differently based on the number of pages processed.

Receipt and Invoice OCR API FAQs

Each endpoint returns structured JSON data. The "Extract Receipt" endpoint provides vendor name, itemized line items (including quantity and price), subtotal, tax, total, notes, and document information such as size and page count.

Key fields in the response include "document_type," "items" (with "description," "quantity," "unit_price," and "total_price"), "subtotal," "tax," "total," "notes," and "document_info" (with "size_mb," "pages," and "approx_tokens").

The response data is organized in a JSON format with a "result" object containing the extracted data and a "document_info" object detailing the file's characteristics, such as size and number of pages.

The "Extract Receipt" endpoint provides information such as vendor name, itemized purchases, quantities, prices, subtotal, tax, total amount, notes, and document size and page count.

The endpoints accept image and PDF file uploads in formats like JPEG, PNG, WEBP, HEIC/HEIF, and multi-page PDFs. Users should ensure files are within the size limits for optimal processing.

Users can parse the JSON response to extract relevant fields for applications such as expense tracking, accounting, or inventory management. For example, the "items" array can be used to generate detailed purchase reports.

Data accuracy is maintained through advanced OCR technology that recognizes text and structures it into a usable format. Continuous improvements and updates to the OCR algorithms help enhance recognition capabilities.

Typical use cases include automating expense reporting, managing receipts for tax purposes, tracking business expenses, and integrating with accounting software to streamline financial processes.

Perguntas Frequentes Gerais

O Zyla API Hub é como uma grande loja de APIs, onde você pode encontrar milhares delas em um só lugar. Também oferecemos suporte dedicado e monitoramento em tempo real de todas as APIs. Após se cadastrar, você pode escolher quais APIs deseja usar. Lembre-se apenas de que cada API precisa de sua própria assinatura. Mas se você se inscrever em várias, usará a mesma chave para todas elas, facilitando as coisas para você.
Os preços são listados em USD (Dólar Americano), EUR (Euro), CAD (Dólar Canadense), AUD (Dólar Australiano) e GBP (Libra Esterlina). Aceitamos todos os principais cartões de débito e crédito. Nosso sistema de pagamento usa a mais recente tecnologia de segurança e é operado pela Stripe, uma das empresas de pagamento mais confiáveis do mundo. Se tiver problemas para pagar com cartão, entre em contato conosco em [email protected]

Além disso, se você já tiver uma assinatura ativa em qualquer uma dessas moedas (USD, EUR, CAD, AUD, GBP), essa moeda será mantida para assinaturas subsequentes. Você pode alterar a moeda a qualquer momento, desde que não tenha assinaturas ativas.
A moeda local exibida na página de preços é baseada no país do seu endereço IP e é fornecida apenas como referência. Os preços reais são em USD (Dólar Americano). Ao efetuar o pagamento, a cobrança aparecerá no extrato do seu cartão em USD, mesmo que você veja o valor equivalente em sua moeda local em nosso site. Isso significa que você não pode pagar diretamente com sua moeda local.
Ocasionalmente, o banco pode recusar a cobrança devido às configurações de proteção contra fraude. Sugerimos contatar seu banco inicialmente para verificar se estão bloqueando nossas cobranças. Você também pode acessar o Portal de Cobrança e alterar o cartão associado para realizar o pagamento. Se isso não funcionar e precisar de mais ajuda, entre em contato com nossa equipe em [email protected]
Os preços são determinados por uma assinatura recorrente mensal ou anual, dependendo do plano escolhido.
As chamadas de API são descontadas do seu plano com base nas requisições bem-sucedidas. Cada plano possui um número específico de chamadas por mês. Apenas chamadas bem-sucedidas, indicadas por uma resposta com Status 200, serão contabilizadas, garantindo que falhas não afetem sua cota mensal.
O Zyla API Hub funciona com um sistema de assinatura mensal recorrente. Seu ciclo de cobrança começa no dia em que você compra um dos planos pagos e será renovado no mesmo dia do mês seguinte. Portanto, cancele sua assinatura com antecedência se quiser evitar cobranças futuras.
Para fazer upgrade do seu plano atual, acesse a página de preços da API e selecione o novo plano desejado. O upgrade é instantâneo, permitindo aproveitar imediatamente os recursos do novo plano. Observe que as chamadas restantes do plano anterior não serão transferidas; você será cobrado pelo valor integral do novo plano.
Para verificar quantas chamadas de API restam para o mês atual, consulte o campo 'X-Zyla-API-Calls-Monthly-Remaining' no cabeçalho da resposta. Por exemplo, se seu plano permite 1.000 requisições por mês e você usou 100, este campo no cabeçalho da resposta indicará 900 chamadas restantes.
Para ver o número máximo de requisições de API que seu plano permite, verifique o cabeçalho de resposta 'X-Zyla-RateLimit-Limit'. Por exemplo, se seu plano inclui 1.000 requisições por mês, este cabeçalho exibirá 1.000.
O cabeçalho 'X-Zyla-RateLimit-Reset' mostra o número de segundos até seu limite de taxa ser redefinido. Isso informa quando sua contagem de requisições começará do zero. Por exemplo, se exibir 3.600, significa que restam 3.600 segundos até o limite ser redefinido.
Sim, você pode cancelar seu plano a qualquer momento acessando sua conta e selecionando a opção de cancelamento na página de Cobrança. Observe que upgrades, downgrades e cancelamentos têm efeito imediato. Além disso, após o cancelamento, você não terá mais acesso ao serviço, mesmo que ainda tenha chamadas restantes na sua cota.
Para oferecer a oportunidade de experimentar nossas APIs sem compromisso, oferecemos um teste gratuito de 7 dias que permite realizar até 50 chamadas de API sem custo. Esse teste pode ser usado apenas uma vez; recomendamos aplicá-lo à API que mais interessa. Embora a maioria das APIs ofereça teste gratuito, algumas podem não oferecer. O teste termina após 7 dias ou quando você atingir 50 requisições, o que ocorrer primeiro. Se atingir o limite, será necessário "Iniciar seu plano pago" para continuar. Você encontra esse botão no perfil em Assinatura -> Escolha a API -> aba Preços. Se não cancelar até o 7º dia, sua assinatura será cobrada automaticamente, liberando todas as chamadas do plano.
Após 7 dias, será cobrado o valor total do plano ao qual você estava inscrito durante o teste. Portanto, é importante cancelar antes do término do período. Solicitações de reembolso por esquecimento de cancelamento não são aceitas.
Ao assinar um teste gratuito de API, você pode fazer até 50 chamadas. Se desejar fazer chamadas adicionais além desse limite, a API solicitará que você "Inicie seu plano pago". Você encontra o botão no perfil em Assinatura -> Escolha a API -> aba Preços.
As Ordens de Pagamento são processadas entre os dias 20 e 30 de cada mês. Se você enviar sua solicitação antes do dia 20, seu pagamento será processado dentro desse período.
Você pode nos contatar via chat para receber assistência imediata. Estamos online de 8h às 17h (EST). Se nos contatar após esse horário, retornaremos o mais rápido possível. Além disso, você pode enviar um e-mail para [email protected]

APIs relacionadas