Fieldmotion API Getting started

Stock exports and reporting

Export dispatch batch details

POST /a/Stock_exportDispatches

Download outgoing container rows expanded by their inventory provenance.

When to use this endpoint

Use to reconcile batch/serial stock dispatched to jobs, users and vehicles; it does not create or execute dispatches.

Authentication and permissions

Authenticate with a signed API-key request or a logged-in CRM session. Requires Stock view (pageStocks_view) and table export (pageMain_exportTableData) permissions through the shared export guard; denial returns permission denied.

Client administrators and the all permission satisfy the checks. Legacy users with no role use the helper’s allow fallback when no explicit permission list is loaded. This is not merely the CRM1 export-button bit check.

Queries use the authenticated tenant. No department/owner restriction or stock-tracking feature gate is added by these handlers. CRM2 features2.stockTracking changes the export choices offered, not server authorization. Session CSRF and API signing still apply.

Parameters

ParameterTypeRequiredDescription
stockIDsFilterComma-separated stringNoA string such as 1042,1088, not a JSON or native array. Omitted or blank/whitespace means no selection restriction. Tokens must be positive decimal IDs; whitespace is trimmed and duplicates are removed. Malformed, zero/negative or non-string lists return invalid parameter: stockIDsFilter.

Example request

$csv = FM_api('Stock_exportDispatches', ['stockIDsFilter'=>'1042']);

Example response

ID,"Part Number",Description,"Manufacturer/Supplier Part Number",Type,Dispatch,"Supplier Name",Cost,QTY,"Total Cost",Batch
1042,FLT-01,"Replacement cartridge",AC-01,Job,2042,"Parts supplier",4.5,2,9,BATCH-01

Success is raw CSV, not JSON: retain the response body instead of JSON-decoding it. The response uses text/csv and the final download filename stock_dispatch.csv. Column positions and blank cells are meaningful.

Errors and unusual responses

ResponseCondition
{"error":"not logged in"}No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
{"error":"permission denied"}Either required export permission is denied.
Header-only CSV or interrupted outputMost database reads are not checked for failure. A blank export is not proof that the database contained no matching rows; malformed stored JSON can interrupt legacy reports.
{"error":"invalid parameter: stockIDsFilter"}A supplied selected-ID list is not a string of positive decimal IDs.
{"error":"invalid parameter: search"}A supplied stock/date filter is an array or other non-scalar value; the error names that parameter.
{"error":"could not create stock export"}The per-request CSV stream cannot be created, written or rewound.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

  • Reads OutJob/OutUser/OutVehicle container types 18,14,20 for non-deleted stock, without a positive quantity guard. Archived stock remains included.
  • Expands decoded meta.inventory into resolved inventory entries, using linked inventory cost/reference/supplier and entry qty. Total Cost uses float multiplication.
  • If none resolve, uses one fallback row with current stock average cost and container amount, blank supplier/reference. Partially missing entries are skipped without a balancing fallback.
  • Jobs use numeric IDs; user and vehicle labels fall back to container IDs when lookup fails. Related object lookups do not exclude deleted rows.
  • The manufacturer/supplier heading actually outputs only supplier_part_no. Shared stock/date/trigger filters are ignored.
  • No pagination or result limit is implemented. The entire result is exported; a header-only CSV is a valid empty result.
  • No stock quantity, audit, edit timestamp, notification or event is changed. Reads across multiple queries are not a transactionally frozen snapshot.
  • No direct caller for this exact endpoint was found in the current app JavaScript or m/www intermediary; these are office reporting/source-selection calls, not the app download protocol.
  • The shared guard rejects non-scalar supplied stock/date filters and validates any supplied stockIDsFilter even on reports that do not use it for selection.

Side effects

  • Builds CSV in a checked per-request php://temp stream, then streams it, closes it and exits. No shared tenant filename is written; concurrent requests generate independent files.

See it in Fieldmotion

CRM1

No direct caller for this exact endpoint was found in CRM1. Its Stock page has separate warehouse, user, vehicle, customer and cost export actions.

CRM2

Open Stocks, choose Export, select the matching report and submit. Filter Network for Stock_exportDispatches (the posted form uses php/api.php with extra=/Stock_exportDispatches). CRM2 supplies yes=really and a comma-separated stockIDsFilter for the selected export scope.

Related endpoints