Transfers

Creates the job-site transfer for a job (the Job Details "Create Transfer" button).

Requires ManageTransfers and an Idempotency-Key header; no body. Same rules as the button, which is only offered when the organization is not in counter-sales mode and the job is Estimated, Scheduled or InProgress: stock is auto-selected for every Planned material line that still needs delivery, the transfer is created Pending with the job's site location as its destination, the job lines become Reserved and a "Transfer created" entry is added to the job history. When the organization allows negative inventory a shortfall becomes a stock-less line instead of an error. Returns the new transfer with its lines; its Location header is /api/v1/transfers/{transferId}.

post/api/v1/jobs/{id}/transfer

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/jobs/{id}/transfer
  • Auth: HTTP bearer

Path parameters

idinteger required

Job id from /api/v1/jobs.

Response

The created transfer.

idinteger

Numeric id used in /api/v1/transfers/{id}. Unique within this organization. Example: 318.

syncIdstring uuid

Stable cross-device identifier (GUID) — also the pagination cursor value. Example: 0b8f4c1e-6f1a-4a5e-9d7c-2f3e4a5b6c7d.

statusstring

Transfer status name. One of Draft, Pending (created, stock reserved, not yet picked up), InTransit, AtWaypoint, InTransitToWaypoint, InTransitToDestination, Completed (delivered), Cancelled, Failed.

notesstring nullable

Free-text notes recorded on the transfer. Example: Transfer for Job J-2026-0042. Null when none.

jobIdinteger nullable

Id of the job this transfer supplies (see /api/v1/jobs/{id}); null for a standalone or sales-order transfer.

jobNumberstring nullable

Job number of jobId at read time. Example: J-2026-0042. Null when there is no job.

salesOrderIdinteger nullable

Id of the sales order this transfer fulfils; null otherwise.

isJobTransferboolean

True for a transfer created for a job (materials to its job site, or a direct / counter sale). Standalone transfers (both flags false) are the ones pick / start / complete / fail accept; job-site and standalone transfers can be cancelled with POST /api/v1/transfers/{id}/cancel.

isSalesOrderTransferboolean

True for a transfer that fulfils a sales order.

sourceLocationIdinteger nullable

Id of the location the stock leaves (see /api/v1/locations/{id}); null when the lines come from several locations or from no location.

sourceLocationNamestring nullable

Name of sourceLocationId. Example: Main Warehouse. Null when there is none.

destinationLocationIdinteger nullable

Id of the location the stock goes to — for a job-site transfer, the job's site location; null for a de-listing.

destinationLocationNamestring nullable

Name of destinationLocationId. Example: Job Site - J-2026-0042. Null when there is none.

requiresApprovalboolean

True when the transfer's value exceeded the organization's approval threshold when it was created. Job-site transfers never require approval.

approvalStatusstring nullable

State of the transfer's approval: Pending (awaiting POST /api/v1/transfers/{id}/approve or /reject), Approved or Rejected; null when the transfer never needed approval.

lineCountinteger

Number of item lines on the transfer. Example: 4.

transferDatestring date-time

When the transfer was initiated, ISO-8601 UTC. Example: 2026-09-23T14:05:00Z.

initiatedByIdstring nullable

Identity user id of the person who created the transfer (for an API/MCP-created transfer, the key's creator); null when unknown on this server.

completedByIdstring nullable

Identity user id of the person who completed (received) the transfer; null until it is completed.

createdAtstring date-time

Creation time, ISO-8601 UTC. Example: 2026-09-23T14:05:00Z.

updatedAtstring date-time nullable

Last modification time, ISO-8601 UTC; null when never modified since creation.

rejectionReasonstring nullable

Why the transfer's approval was rejected (from POST /api/v1/transfers/{id}/reject or the app); null otherwise.

currentWaypointIdinteger nullable

Id of the waypoint the transfer is heading to or stopped at (waypoints[].id); null when it has no waypoints or is heading to its final destination.

Changes

No recorded changes to this operation across all 1 revision of this API.