Library
OpenApi Overview
About these APIs
Architecture
Authentication
Error Responses
Locating a Server
Sessions
Design Guides
Guides and Hints
Examples
Pricing for Websites
Accepting Vouchers
PreAuth Payment
Replication
Common Apis
The most used APIs
Create New Sale
Payment Completion
Multiple Locations
Delivery Addresses
Create New Sale v2
Customers
Locations
Products
Staff
WebHooks
eCommerce Apis
These APIs are often used with eCommerce website integrations
Get Pricing
Card Inquiry
Report & Analysis
Grouped or analysed report data. Typically used to build reports and dashboards
Today
Login Access
Pinboard
ReportRequest
Advanced Information
More indepth information
Caller Handling
HTTP Protocol
Bulk Data Downloads
Document Uploading
RetailConfig
Under Development
Details of APIs that will be available shortly. Documentation provided is for early adopters
Get Receipt
Document Uploading
The document uploading group of APIs allow you to upload source documents such as invoices, packing slips and other documents. These uploads can be PDF, Excel, scans or photographs. Fieldpine will first attempt to extract the relevant information from the document, and then decode and apply that to your database.
The process that is followed is broadly as follows. The progression from each step can take time so any API use needs to after uploading a document there may be a delay to actual use.
Document Uploaded | » | Checked, Parsed, OCR | » | Type and purpose of document determined | » | Bound to your Retail System |
APIs involved
/DocumentProcessing
Returns the list of all documents uploaded and their broad status.