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

Invoice Payment Resource

This resource describes details of a single payment entry made. These payments are supply side, not customers paying for sales

"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.

Example Record

{
  "physkey": "DJFHRGHH395FGHFHGH5HGG", 
  "poid": "MVKFHGH6HGGDJGHHGJFGGG",
  "ref": "JB6783C",
  "amount": 120.45,
  "paymentdate": "2023-08-23 14:45:16"
}

Available Fields

Name	Description	Datatype	Resource	"q"
physkey	Unique record identifier.	String		Yes
pophyskey	Purchase Order (physkey) identifier. Optional, if this payment is for a purchase order	String		Yes
amount	Amount of payment	Money/Currency
ref	Reference details. Should contain the invoice number being paid	String
paymentdate	Date/Time this payment was made	DateTime
comments	General comments about this payment	String