sharpapi/php-invoice-parser
Composer 安装命令：
composer require sharpapi/php-invoice-parser
包简介
Pure PHP client for SharpAPI Invoice Parser (extracts structured data from invoices in PDF/TIFF/JPG/PNG).
README 文档
README
Invoice Parser for PHP 8
🎯 Extract structured data from invoices (PDF/TIFF/JPG/PNG) — powered by SharpAPI AI.
Check the full documentation on the Invoice Parsing API page.
Quick Links
| Resource | Link |
|---|---|
| Main API Documentation | Authorization, Webhooks, Polling & More |
| Product Details | SharpAPI.com |
| SDK Libraries | GitHub - SharpAPI SDKs |
Requirements
- PHP >= 8.0
Installation
Step 1. Install the package via Composer:
composer require sharpapi/php-invoice-parser
Step 2. Visit SharpAPI to get your API key.
What it does
This package uploads an invoice file to the SharpAPI AI endpoint and returns a status URL to poll for results. When the job completes, you can fetch a structured JSON containing parsed invoice data (seller, buyer, line items, financials, tax details, and more).
Usage
<?php require __DIR__ . '/vendor/autoload.php'; use SharpAPI\FinanceParseInvoice\InvoiceParserClient; use GuzzleHttp\Exception\GuzzleException; $invoicePath = __DIR__ . '/invoice.pdf'; // make sure this file exists $client = new InvoiceParserClient(apiKey: 'your_api_key_here'); try { // submit parsing job $statusUrl = $client->parseInvoice($invoicePath); // Optional: adjust polling settings $client->setApiJobStatusPollingInterval(10); // seconds $client->setApiJobStatusPollingWait(180); // seconds total wait // fetch results when ready $result = $client->fetchResults($statusUrl)->toArray(); print_r($result); } catch (GuzzleException $e) { // Handle SharpAPI or network errors echo $e->getMessage(); }
Example Response
{
"data": {
"type": "api_job_result",
"id": "e00ebeec-6df3-4282-b515-8c447ea5d6ab",
"attributes": {
"status": "success",
"type": "invoice_parse",
"result": [
{
"source_pages": [
1
],
"document": {
"type": "invoice",
"original_type_label": "",
"is_copy": false,
"copy_type": null
},
"invoice": {
"invoice_number": "D7BDFA00-0019",
"issue_date": "2025-12-07",
"due_date": "2025-12-07",
"document_date": null,
"order_date": null,
"delivery_date": null,
"shipping_date": null,
"pricing_date": null,
"currency": "USD",
"exchange_rate": null,
"page_info": "1 of 1",
"amount_in_words": "",
"notes": "",
"remarks": "",
"delivery_instructions": "",
"terms_and_conditions": [],
"late_payment_interest_rate": null
},
"references": {
"delivery_order_number": "",
"purchase_order_number": "",
"sales_order_number": "",
"customer_reference": "",
"external_document_number": "",
"grn_number": "",
"route_number": "",
"lorry_number": "",
"serial_number": "",
"batch_number": "",
"other_references": []
},
"e_invoice": {
"uuid": "",
"e_invoice_code": "",
"e_invoice_type": "",
"e_invoice_version": "",
"submission_id": "",
"submission_document_id": "",
"submission_long_id": "",
"submission_status": "",
"validation_datetime": null,
"digital_signature_present": false,
"validated_link": "",
"original_e_invoice_ref": "",
"qr_code_present": false
},
"seller": {
"name": "OpenAl, LLC",
"trade_name": "OpenAl",
"registration_number": "",
"tin": "",
"sst_id": "",
"gst_id": "",
"vat_id": "GB434338990",
"msic_code": "",
"business_activity": "",
"address": {
"street_line_1": "548 Market Street",
"street_line_2": "PMB 97273",
"city": "San Francisco",
"state": "California",
"postcode": "94104-5401",
"country": "US"
},
"phone": "",
"fax": "",
"email": "",
"website": "",
"bank_details": [
{
"bank_name": "",
"account_name": "",
"account_number": "",
"sort_code": "",
"swift_code": "",
"iban": ""
}
],
"contact_person": {
"name": "",
"role": "",
"phone": "",
"email": ""
}
},
"buyer": {
"name": "A2Z WEB LTD",
"trade_name": "",
"registration_number": "",
"tin": "",
"brn": "",
"sst_id": "",
"gst_id": "",
"vat_id": "",
"customer_account_number": "",
"billing_address": {
"location_name": "",
"street_line_1": "Unit 4e Enterprise Court, Farfield",
"street_line_2": "Park",
"city": "Rotherham",
"state": "",
"postcode": "S63 5DB",
"country": "GB"
},
"delivery_address": {
"recipient_name": "",
"location_name": "",
"street_line_1": "Unit 10 Enterprise Court",
"street_line_2": "Farfield Park",
"city": "Rotherham",
"state": "",
"postcode": "S63 5DB",
"country": "GB"
},
"delivery_address_same_as_billing": false,
"phone": "",
"fax": "",
"email": "",
"attention_to": {
"name": "",
"phone": "",
"email": ""
}
},
"sales_info": {
"salesperson_name": "",
"salesperson_code": "",
"salesperson_phone": "",
"sales_agent": "",
"sales_location": "",
"sales_department": "",
"outlet_name": ""
},
"financials": {
"subtotal": 15.57,
"gross_amount": null,
"total_discount_amount": null,
"shipping_charge": null,
"delivery_fee": null,
"total_excl_tax": 15.57,
"total_tax_amount": 3.11,
"service_tax_amount": null,
"total_incl_tax": 18.68,
"rounding_adjustment": null,
"total_payable": 18.68,
"amount_paid": null,
"amount_due": 18.68,
"tax_details": [
{
"tax_type": "VAT",
"tax_rate": 20,
"taxable_amount": 15.57,
"tax_amount": 3.11
}
]
},
"line_items": [
{
"line_number": 1,
"item_code": "",
"stock_code": "",
"barcode": "",
"description": "OpenAl API usage credit",
"classification_code": "",
"country_of_origin": "",
"quantity": 1,
"free_quantity": null,
"unit_of_measure": "",
"unit_of_measure_raw": "",
"pack_size": "",
"total_units": null,
"weight": null,
"weight_uom": "",
"unit_price": 15.57,
"discount_percent": null,
"discount_amount": null,
"subtotal": 15.57,
"tax_rate": 20,
"tax_type": "VAT",
"tax_amount": 3.11,
"total_excl_tax": 15.57,
"total_incl_tax": null,
"expiry_date": null,
"batch_lot_number": "",
"service_start_date": null,
"service_end_date": null
}
],
"payment": {
"payment_terms": "",
"payment_terms_days": null,
"payment_method": "",
"payment_date": null,
"payment_reference": "",
"jompay_biller_code": "",
"jompay_ref_1": ""
},
"logistics": {
"shipping_method": "",
"vehicle_number": "",
"driver_name": "",
"delivery_zone": "",
"delivery_time_constraint": "",
"carton_count": null,
"total_volume": null,
"total_weight": null,
"goods_received_confirmation": false,
"received_by": "",
"receiver_signature_present": false
}
}
]
}
}
}
Changelog
Please see CHANGELOG for more information on what has changed recently.
Credits
- A2Z WEB LTD
- Dawid Makowski
- Boost your PHP AI capabilities!
License
The MIT License (MIT). Please see License File for more information.
Social Media
🚀 For the latest news, tutorials, and case studies, don't forget to follow us on:
sharpapi/php-invoice-parser 适用场景与选型建议
sharpapi/php-invoice-parser 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 3 次下载、GitHub Stars 达 0， 最近一次更新时间为 2026 年 02 月 02 日， 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向： 「php」 「parser」 「invoice」 「OCR」 「finance」 「SharpAPI」 等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 sharpapi/php-invoice-parser 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 sharpapi/php-invoice-parser 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
与 sharpapi/php-invoice-parser 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：
Easy to use SDK with grabber for multiple platforms at once like YouTube, Dailymotion, Facebook and more.
Easy invoice generation using Laravel Eloquent
An MT940 bank statement parser for PHP
Laravel MPdf : Easily generate PDF files with arabic support
Szamlazz.hu integration for Laravel
Laravel integration for the jsonapi.org parser
统计信息
- 总下载量： 3
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 0
- 点击次数： 37
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： MIT
- 更新时间： 2026-02-02