Skip to main content

Freight Accessorial Manual Overview V1 Ep

POST 
/v1/freight/accessorial/manual/overview

Manual Accessorial Overview

Retrieves all manual accessorials for the specified counterparty and book type, including their current rates, scheduled rates, and configuration details. Manual accessorials are applied to orders through manual user actions rather than automated rules.

Required Scopes (if.r)

Request​

as_of: datetime | None = None
The date (in UTC) to query accessorials as of. If not specified, defaults to the current date.

counterparty_id: str
The internal identifier of the counterparty (carrier or customer) to retrieve accessorials for.

book_type: RateBookType
The type of rate book to query. Valid values are "Cost" or "Revenue".

order_id: str | None = None
Optional order identifier to filter accessorials relevant to a specific order.


Response​

Returns a list of manual accessorial objects, each containing:

id: str
Internal identifier for the accessorial.

name: str
Name of the accessorial.

counterparty_id: str
Internal identifier of the counterparty associated with this accessorial.

book_type: RateBookType
The rate book type (Cost or Revenue).

product_group: str | None = None
The product group this accessorial applies to, if applicable.

product_ids: list[str] = []
List of product identifiers this accessorial applies to.

destinations: LocationBinding | None = None
Destination location bindings for this accessorial.

destination_ids: list[str] = []
List of destination location identifiers.

origins: LocationBinding | None = None
Origin location bindings for this accessorial.

origin_ids: list[str] = []
List of origin location identifiers.

fee_type: TimeIntervalFeeConfig | ThresholdFeeConfig | BasicFeeConfig
Configuration object defining the fee calculation method.

rate: float | None = None
The current active rate for this accessorial.

next_scheduled_rate: AccessorialRate | None = None
The next scheduled rate change, if any.

rates: list[AccessorialRate] = []
Complete history of rates with their effective dates.

disabled: bool = False
Indicates whether the accessorial is disabled.

requires_approval: bool = False
Indicates whether this accessorial requires manual approval before being applied.

requires_reason_code: bool = False
Indicates whether a reason code is required when applying this accessorial.

exclude_from_invoice: bool = False
Indicates whether this accessorial should be excluded from invoices.

show_on_delivery_ticket: bool = False
Indicates whether this accessorial should appear on delivery tickets.

freight_region_name: str | None = None
Name of the freight region this accessorial is associated with, if applicable.

freight_region_id: str | None = None
Internal identifier of the freight region, if applicable.

description: str | None = None
Optional description for this manual accessorial (max 1000 characters).

linked_special_pay_config: list[LinkedSpecialPayConfig] = []
Configuration for linked special pay items.

Responses​

Successful Response

[
  {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "name": "string",
    "counterparty_id": "string",
    "book_type": "Cost",
    "product_group": "Gasoline",
    "product_ids": [
      "string"
    ],
    "destinations": {
      "locations": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "site_states": [
        "string"
      ],
      "site_regions": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "terminal_states": [
        "string"
      ],
      "terminal_regions": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    },
    "destination_ids": [
      "string"
    ],
    "origins": {
      "locations": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "site_states": [
        "string"
      ],
      "site_regions": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "terminal_states": [
        "string"
      ],
      "terminal_regions": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    },
    "origin_ids": [
      "string"
    ],
    "fee_type": {
      "type": "Detention",
      "threshold": 0,
      "interval": 0,
      "max_intervals": 0
    },
    "rates": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "effective_from": "2025-12-17T21:49:50.725Z",
        "effective_to": "2025-12-17T21:49:50.725Z",
        "rate": 0,
        "type": "Per Order",
        "created_by": "string",
        "created_on": "2025-12-17T21:49:50.725Z"
      }
    ],
    "rate_history": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "effective_from": "2025-12-17T21:49:50.725Z",
        "effective_to": "2025-12-17T21:49:50.725Z",
        "rate": 0,
        "type": "Per Order",
        "created_by": "string",
        "created_on": "2025-12-17T21:49:50.725Z"
      }
    ],
    "disabled": false,
    "requires_approval": false,
    "requires_reason_code": false,
    "exclude_from_invoice": false,
    "show_on_delivery_ticket": false,
    "linked_special_pay_config": [
      {
        "sp_id": "string",
        "name": "string",
        "link_date": "2025-12-17T21:49:50.725Z",
        "unlinked_date": "2025-12-17T21:49:50.725Z",
        "link_type": "create_line_item"
      }
    ],
    "freight_region_name": "string",
    "freight_region_id": "string",
    "description": "string",
    "rate": 0,
    "next_scheduled_rate": {
      "id": "5eb7cf5a86d9755df3a6c593",
      "effective_from": "2025-12-17T21:49:50.725Z",
      "effective_to": "2025-12-17T21:49:50.725Z",
      "rate": 0,
      "type": "Per Order",
      "created_by": "string",
      "created_on": "2025-12-17T21:49:50.725Z"
    }
  }
]
Loading...