API ReferenceBillingLine Item Groups

Shared task group mileage create

Prices a single driver's combined trip across several task groups once. Recomputes route mileage from the ordered task locations (plus optional start/end legs), applies the CHRT-ground rate sheet, and atomically creates an OrderGroup-anchored LineItemGroup, its mileage LineItems, and the LineItemCalculation that records how the charges were derived. The LIG is detached on create (task_group_id is None) — attach to a Statement afterwards. | authz: allowed_org_types=[provider], min_org_role=operator | (SharedTaskGroupMileageCreateForProviderPayDriverClientReq) -> (LineItemGroup1)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
order_group_idstringRequired
payment_destination_driver_idstringRequired
rate_sheet_idstringRequired
task_idslist of stringsRequired
end_locationobjectOptional

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

end_location_labelstringOptional<=512 characters
start_locationobjectOptional

GeoJSON Feature with typed properties for locations

The geometry field is strongly typed as Geometry (union of all geometry types) but remains optional to match the base Feature class specification. To ensure geometry is always present, validate it at runtime or make it required.

start_location_labelstringOptional<=512 characters

Response

Successful Response
_idstring
owned_by_org_idstring

Must be a string starting with org_

schema_versioninteger
agreement_amountdoubleDefaults to 0
agreement_line_item_idslist of strings
amendment_amountdoubleDefaults to 0
amendment_line_item_idslist of strings
denied_amountdoubleDefaults to 0
denied_line_item_idslist of strings
finalized_at_timestampdatetime
finalized_by_user_idstring

Must be a string starting with user_

line_item_group_s3_object_metadata_idslist of strings
messageslist of objects
order_group_idstring
order_group_short_idstring
order_idstring
order_off_chrt_reference_idstringformat: "^[A-Za-z0-9._~\-]{1,64}$"1-64 characters

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, ’.’, ’_’, ’~’, ’-’ (RFC 3986 unreserved).

order_short_idstring
payment_destination_driver_idstring
payment_destination_off_chrt_provider_org_idstring
payment_destination_off_chrt_vendor_idstring
payment_destination_org_idstring

Must be a string starting with org_

payment_origin_off_chrt_shipper_org_idstring
payment_origin_org_idstring

Must be a string starting with org_

pending_amountdoubleDefaults to 0
pending_line_item_idslist of strings
rate_sheet_idstring
settlement_typeenum
statement_idstring
statusenum

LineItemGroup lifecycle.

The pre-FINALIZED window is a single STAGED state — operators compose the bundle (add/remove owner ad-hoc into amendment, propose/approve/deny counterparty items) and then call finalize/v1 to lock it. Every state past STAGED is reached by a deliberate transition (finalize/v1, open_invoice/v1, sync routes).

The legacy PENDING_RATES, PENDING_CALCULATION, and ADJUSTABLE states were tied to the old auto-recalc-on-mutation hooks. Bucket amounts ARE kept in sync on every mutation today (see the “Amounts” section of the module docstring), but that’s a write-time invariant, not a status — modeling “is the amount fresh?” as LIG status duplicates information and was dropped 2026-05-03. The worklist principle (an empty agreement_line_item_ids bucket or an unfilled <vector>_line_item_group_id field IS the operator signal) makes the intermediate states redundant in any case.

task_group_idstring

Errors

422
Line Item Groups Shared Task Group Mileage Create V1request Unprocessable Entity Error