FD1 Client Protocol
 
Library Developer Home FD1 Client Protocol Home Concepts Reading Data Writing Data Protocol Defined Servers Connect & Authenticate Proxies & Tunnels
Webhooks Programming Support Logging Minor Facts State Facts Response Format How To Guides eCommerce Sites Custom Point of Sale Customer Access Bulk Downloads Major APIs / Endpoints All Endpoints Products Sales SalesBuilder Session Sale Capture General Purpose Data Capture Devices Barcode Scanners Eftpos IoT Sensors Power Outlets Printing Scales Security Cameras Purchasing / Supply Side Purchase Orders Invoices Invoice Payments Document Capture Rare APIs / Endpoints SSL Certificates API Key Management Diagnositics Server to Client Messages Overview Resources / Objects Purchase Order Invoice Payable Invoice Payment Product Supplier Location Sale Lines Sale Delivery Details Sales Price Maps Employees Carriers Payments Product Kits Department 1 Customers

FD1 Invoices

Functions relating to Invoices received, ie invoices you are expected to pay.

invoices.get_invoice

Fetch an invoice record

Example, fetching by direct key.
{
  a: "fd1.invoices.get_invoice",
  k: "KLMVNVJJJTJYWJFHH3KSI9EZAZ"
}
Example, fetching by by source document MD5.

If the invoice was derived from a file, such as a PDF, CSV file, or even a JSON packet then you can request Fieldpine details using the md5 of the source file.

{
  a: "fd1.invoices.get_invoice",
  q: {
    srcdocmd5: "dcfb940f0e9181bb1629b95c160f7d75"
  }
}
Example, fetching by by source email message-id.

If you know the email message-id used to send the invoice to Fieldpine, you can request all the invoices derived from that email. The response can contain zero, one or more invoices. Emails can send multiple invoices at once.

{
  a: "fd1.invoices.get_invoice",
  q: {
    srcemailid: "<rj848fh248573@soemeghgubg-shw28@23jun2025.mailgun.2828473>"
  }
}