Implementation Steps

Data Flow

Note: PO and Receipt data is specific to a LogisticsOS profile.  If multiple profiles will use PO line item receiving, PO data must be sent to and Receipt data must be pulled from multiple profiles.  Consult your FacilityOS implementation contact for the correct ProfileID value(s).

1. Add or update PO data
   1. Add or update a PO Header
   2. Add or update a PO Line for an existing PO Header
2. Get PO receipt data
   1. Request PO Receipts for a specified timeframe, optionally filtering out processed receipts
   2. Mark processed PO Receipts as processed

API

Authentication: OAuth

Format: JSON

PO Header

For each PO, create or update the header details in FacilityOS to ensure the latest PO information is available.  For updates, it is recommended to only send updates for records that have recently changed. 

Fields

Add a PO Header

Endpoint: POST /api/v1/po/header

Curl

curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  -d '{
    "Business_Unit": "IT",
    "PO_ID": "PO-100254",
    "PO_Type": "STANDARD",
    "RECV_STATUS": "N",
    "VENDOR_ID": "VEND-1001",
    "Vendor_Name": "Acme Office Supplies",
    "VENDOR_SETID": "SET001",
    "ENTERED_DT": "2026-10-21T17:25:13.528Z",
    "PO_REVISION": 1,
    "Total_Order_Amt": 2450.75,
    "Default_Cost_Center": "CC-100",
    "Default_Deliver_To": "Building A - Receiving",
    "profileID": 1
  }' \
  '<base URL>/api/v1/po/header'

Update a PO Header

Endpoint: PATCH /api/v1/po/header

In the following example, the record's Default_Deliver_to is being updated to a new value and the Vendor_SetID value is being cleared.  All other fields will retain their existing values. 

When updating records, PO_ID and profileID are the only required fields.

Curl

curl -X PATCH \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  -d '{
    "VENDOR_SETID": null,
    "Default_Deliver_To": "Building B - Dock",
    "profileID": 1
  }' \
  '<base URL>/api/v1/po/header'

PO Lines

For each PO line, create or update the line details in FacilityOS to ensure the latest PO line information is available.  For updates, it is recommended to only send updates for records that have recently changed. 

Fields

Add a PO Line

Endpoint: POST /api/v1/po/line

Curl

curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  -d '{
    "business_Unit": "IT",
    "po_ID": "PO-100254",
    "line_Number": 1,
    "entered_DT": "2026-10-21T18:41:53.956Z",
    "quantity_PO": 100,
    "price_PO": 24.50,
    "unit_Of_Measure": "EA",
    "vendor_ItemId": "ITEM-1001",
    "item_Description": "USB-C Charging Cable",
    "location_ID": "LOC-001",
    "financial_Asset_SW": "N",
    "req_ID": "REQ-10025",
    "schedule_Line_Number": 1,
    "distribution_Line_Number": 1,
    "delivery_Location_ID": "BLDG-A",
    "delivery_Comment": "Deliver to IT receiving department",
    "buyer_Name": "John Smith",
    "default_Cost_Center": "CC-100",
    "profileID": 1
  }' \
  '<base URL>/api/v1/po/line'

Update a PO Line

Endpoint: PATCH /api/v1/po/line

In the following example, the record's item_Description is being updated to a new value and the delivery_Comment value is being cleared.  All other fields will retain their existing values. 

When updating records, PO_ID, line_Number, and profileID are the only required fields.

Curl

curl -X PATCH \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  -d '{
    "PO_ID": "PO-100254",
    "line_Number": 1,
    "item_Description": "USB-C Charging Cable v2",
    "delivery_Comment": null,
    "profileID": 1
  }' \
  '<base URL>/api/v1/po/line'

PO Receipts

At predefined intervals, query the FacilityOS API to retrieve recent PO receipts by specifying the start and end dates of the desired timeframe.  Optionally (recommended), filter out receipts already marked as processed. 

Get PO Receipts

Endpoint: GET /api/v1/po/receipts

Request

Fields

Curl

curl -X GET \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  -d '{
    "beginDate": "2026-10-01T00:00:00.000Z",
    "endDate": "2026-10-21T23:59:59.999Z",
    "po_ID": "PO-100254",
    "returnUnprocessed": 1,
    "receiptSource": "INTRA",
    "profileID": 1
  }' \
  '<base URL>/api/v1/po/receipts'

Response 

Fields

Sample

The following is a sample response with a single receipt transaction.  Depending on the dataset, multiple receipt transactions (objects) may be returned in the array.

[
  {
    "business_UNIT": "IT",
    "po_ID": "PO-100254",
    "po_Line_Number": 1,
    "recv_ID": "SC00000034",
    "manifestNumber": "130054AA32",
    "quantity_Received": 2,
    "po_Type": "GEN",
    "vendor_ItemId": "0201255",
    "item_Description": "100 Count Cable Ties",
    "intraUsername": "admin",
    "receivedDateTime": "2026-10-12T11:24:21.093",
    "unit_of_Measure": "EA",
    "price_PO": 20.00,
    "vendor_ID": "0000000002",
    "receiving_Comments": "",
    "processed": 0,
    "processedDateTime": "1900-01-01T00:00:00",
    "receipt_Source": "",
    "profileID": 1
  }
]

Mark a Receipt as Processed

Endpoint: POST /api/v1/po/receiptMarkProcessed

Request

Fields

Curl

curl -X POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>' \
  -d '{
    "receiptID": "SC00000034",
    "markProcessed": 1,
    "externalReceiptBatchID": "ERP30217",
    "profileID": 1
  }' \
  '<base URL>/api/v1/po/receiptMarkProcessed'