Pharus API (1.17.0)

Create a warehouse/site location. Only name is required and must be unique in the org (409 conflict otherwise); the address is optional. New locations are active by default. customFields carries opaque key/value pairs the platform never interprets (max 50 fields; key <= 64 chars, value <= 512 chars; keys unique case-insensitively).

List one page of the org's locations. Narrow with active (active vs archived), a free-text search over the name and notes, territory filters (city/state/country, case-insensitive exact), or a customFieldKey/customFieldValue lookup. Sort with sort (name, createdAt, updatedAt; default name; empty values always last) and order (asc/desc); page with limit (default 50, max 200) and offset. meta.total counts the filtered set, so pagers can render page counts under active filters.

Update a location's fields (partial; only send what changes). Set isActive false to archive or true to reactivate. Renaming to a name another location already uses is rejected with 409 conflict. customFields, when sent, replaces the whole set (max 50 fields; key <= 64 chars, value <= 512 chars; keys unique case-insensitively).

Permanently delete a location. Blocked with 409 in_use when a purchase/work/sales order, a transfer, or either inventory ledger references it; the error details carry the per-source blocking counts (purchaseOrderCount, workOrderCount, salesOrderCount, inventoryLedgerCount, transferCount). Archive it instead (PATCH with isActive=false) for routine cleanup.

Fetch a single location with the contacts linked to it embedded under contacts (each a hydrated link + contact + methods row), so the facility page renders in one call.

Create a vendor for the caller's org. Name is unique per org (case-insensitive), as is QBO id when present; a collision returns 409 conflict.

List one page of the org's vendors. Narrow with active (active vs archived), a free-text search over the name, notes, and payment term, territory filters (city/state/country, case-insensitive exact), a term filter (case-insensitive exact, e.g. Net 30), or a custom-field key/value lookup. Sort with sort (name, term, createdAt, updatedAt; default name; empty values always last) and order (asc/desc); page with limit (default 50, max 200) and offset. meta.total counts the filtered set, so pagers can render page counts under active filters.

Patch a vendor's header fields. Setting isActive archives (false) or reactivates (true) the vendor; there is no separate reactivate route. A name or QBO id that collides with another vendor returns 409 conflict.

Hard-delete a vendor. Blocked with 409 in_use when any purchase order references it; archive it instead (PATCH isActive=false) to retire a supplier while keeping its history.

Fetch a single vendor by id, scoped to the caller's org, including its linked contacts (each with the person, their email and phone methods, and the link role). Returns 404 when no such vendor exists.

Create many vendors in one atomic batch from parsed rows (e.g. a CSV/Excel upload). All rows commit together: the first row whose name or QBO id collides aborts the whole import (409 conflict) and nothing is inserted. Returns the created ids in row order.

Create a raw material, the entity BOMs consume and the materials ledger tracks. Requires a material type. The code must be unique in the org (409 conflict otherwise). customFields carries opaque key/value pairs the platform never interprets (max 50 fields; key <= 64 chars, value <= 512 chars; keys unique case-insensitively).

List one page of the org's materials. Every filter is optional and AND-ed: active, a CSV type id multi-select, a free-text search over the material code, name, joined type name, and notes, and a customFieldKey/customFieldValue lookup for a custom-field code. Sort with sort (code, name, type, createdAt, updatedAt; default name; empty values always last) and order (asc/desc); page with limit (default 50, max 200) and offset. meta.total counts the filtered set, so pagers can render page counts under active filters.

Fetch a single material by id: its header fields, custom fields, and its material type embedded as type with id and name.

Update a material's fields (partial; only send what changes). Set isActive false to archive or true to reactivate. Changing the code to one another material already uses is rejected with 409 conflict. customFields, when sent, replaces the whole set (max 50 fields; key <= 64 chars, value <= 512 chars; keys unique case-insensitively).

Permanently delete a material. Blocked with 409 in_use when a purchase-order item, BOM input, materials-ledger entry, or transfer references it (a blocking transfer surfaces its transferCount in the error details); archive it instead (PATCH with isActive=false) to keep the history.

Create a material type, the classification every material carries. The name must be unique among the org's material types (409 conflict otherwise).

List the org's material types in sort order, active and archived alike. Pass a free-text search to match names (case-insensitive contains).

Update a material type's name, sort order, or active flag (partial update, only send what changes). Set isActive false to archive the type or true to reactivate it; there is no separate archive endpoint. Renaming to a name another type already uses is rejected with 409 conflict.

Permanently delete a material type. Blocked with 409 in_use while any material references it; the error details carry the blocking materialCount.

Create many materials in one atomic call from an array of parsed rows (Data page upload), at most 1000 rows per call. The whole batch is one transaction: the first invalid row (unknown type, or a 409 duplicate code) rolls back all of them. Returns the created ids in row order.

Create a SKU (finished-goods product): the entity work orders produce, sales orders sell, and the finished-goods ledger tracks. Requires a SKU type. The code must be unique in the org (409 conflict otherwise). customFields carries opaque key/value pairs the platform never interprets (max 50 fields; key <= 64 chars, value <= 512 chars; keys unique case-insensitively). itemsPerUnit defaults to 1 when omitted.

List one page of the org's SKUs. Every filter is optional and AND-ed: active, a CSV type id multi-select, inclusive itemsPerUnitMin/Max and totalOzMin/Max ranges (total oz = oz_per_item * items_per_unit; NULL-oz rows drop out once an oz bound is set), a free-text search over the SKU code, name, joined type name, and notes, and a customFieldKey/customFieldValue lookup. Sort with sort (code, name, type, itemsPerUnit, totalOz, createdAt, updatedAt; default code; empty values always last) and order (asc/desc); page with limit (default 50, max 200) and offset. meta.total counts the filtered set, so pagers can render page counts under active filters.

Fetch a single SKU by id: its header fields, pack size (items per unit, oz per item), custom fields, and its SKU type embedded as type with id and name.

Update a SKU's fields (partial; only send what changes). Set isActive false to archive or true to reactivate. Changing the code to one another SKU already uses is rejected with 409 conflict. customFields, when sent, replaces the whole set (max 50 fields; key <= 64 chars, value <= 512 chars; keys unique case-insensitively).