FD1 Client Protocol
 
Library Developer Home FD1 Client Protocol Home Concepts Reading Data Writing Data Protocol Defined Servers Connect & Authenticate Proxies & Tunnels
Webhooks & Firehoses 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 Get Attribute 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 PosGreen 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 Purchase Orders

Functions relating to Purchase Orders.

purchaseorders.get_purchaseorder_header

Retrive header type information about a purchase order(s).

TypeRead
HTTPGET, POST
Links Full details Fields

Example

POST /fd1/purchaseorders/get_purchaseorder_header
{
  "a": "purchaseorders.get_purchaseorder_header",
  "q": {
    "cust_ponum": 12345
  }
}
Or
GET /fd1/purchaseorders/get_purchaseorder_header?cust_ponum=12345

purchaseorders.edit_purchaseorder_header

The header details for a single purchase order.

TypeWrite
HTTPPOST

Example

POST /fd1/purchaseorders/edit_purchaseorder_header
{
  "a": "purchaseorders.edit_purchaseorder_header",
  "k": "KSJSFJFHH4J5H5HF9H4H59",
  "v": {
     "comments": "My first edit",
     "suppliercomments": "Use loading dock 2"
  }
}

purchaseorders.email_purchaseorder

Send the purchase order via email to the supplier

TypeRPC
HTTPPOST
Links

Example

POST /fd1/purchaseorders/email_purchaseorder
{
  "a": "purchaseorders.email_purchaseorder",
  "v": {
    "physkey": "ABCHS92747GJW0F74B3H5H"
  }
}

Worked Example

This example shows a simple form to capture a purchase order number and apply a payment against it. Use View Source to see implementation details

Server Address
API Key
PO Number
Comments
Payment Amount
Payment Ref
Payment Date