Skip to main content

Freight Accessorial Automatic Overview V1 Ep

POST 
/v1/freight/accessorial/automatic/overview

Automatic Accessorial Overview

Retrieves all automatic accessorials for the specified counterparty and book type, including their current rates, scheduled rates, and configuration details. Automatic accessorials are applied to orders based on defined rules and conditions.

Required Scopes (if.r)

Request​

as_of: datetime | None = None
The date 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 automatic 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[AccessorialRateRow] = []
Complete history of rates with their effective dates and status (active, scheduled, or expired).

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.

exclude_from_costing: bool = False
Indicates whether this accessorial should be excluded from net landed cost (NLC) calculations.

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

service_rule: ServiceRule | None = None
Service trigger rules (e.g., weekend delivery, holiday delivery).

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

rate_history: list[AccessorialRate] = []
The full effective-dated rate history for this accessorial.

Show Child Attributes

id: str
Internal identifier of the rate entry.

effective_from: datetime
Date the rate takes effect.

effective_to: datetime | None = None
Date the rate stops being effective, or null while it is open-ended.

rate: float
The rate amount.

type: str | None = None
The fee type the rate is charged under.

created_by: str | None = None
The user who created the rate entry.

created_on: datetime
When the rate entry was created.

origin_group_by: LocationGroupBy | None = None
How origins are grouped for this accessorial. One of None, Region, or State.

destination_group_by: LocationGroupBy | None = None
How destinations are grouped for this accessorial. One of None, Region, or State.

site_tank_move_store_number: str | None = None
Store number of the site the tank-move rule applies to.

site_tank_move_rule: SiteTankMoveRule | None = None
Which tank-to-tank moves at a site trigger this accessorial.

Show Child Attributes

store_id: str
Internal identifier of the site the rule applies to.

combinations: list[SiteTankMoveCombination] = []
The tank groupings that trigger the accessorial when product moves between them.

Show Combination Attributes

side_a_tank_ids: list[int] = []
Tank ids on one side of the move.

side_b_tank_ids: list[int] = []
Tank ids on the other side of the move.

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,
      "type_label": "string",
      "unit_label": "string"
    },
    "rates": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "effective_from": "2026-09-25T19:33:18.383Z",
        "effective_to": "2026-09-25T19:33:18.383Z",
        "rate": 0,
        "type": "Per Order",
        "created_by": "string",
        "created_on": "2026-09-25T19:33:18.383Z",
        "status": "Scheduled"
      }
    ],
    "rate_history": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "effective_from": "2026-09-25T19:33:18.383Z",
        "effective_to": "2026-09-25T19:33:18.383Z",
        "rate": 0,
        "type": "Per Order",
        "created_by": "string",
        "created_on": "2026-09-25T19:33:18.383Z"
      }
    ],
    "disabled": false,
    "requires_approval": false,
    "requires_reason_code": false,
    "exclude_from_invoice": false,
    "exclude_from_costing": false,
    "show_on_delivery_ticket": false,
    "linked_special_pay_config": [
      {
        "sp_id": "string",
        "name": "string",
        "link_date": "2026-09-25T19:33:18.383Z",
        "unlinked_date": "2026-09-25T19:33:18.383Z",
        "link_type": "create_line_item"
      }
    ],
    "service_rule": {
      "type": "Weekend"
    },
    "site_tank_move_rule": {
      "store_id": "string",
      "combinations": [
        {
          "side_a_tank_ids": [
            0
          ],
          "side_b_tank_ids": [
            0
          ]
        }
      ]
    },
    "origin_group_by": "None",
    "destination_group_by": "None",
    "rate": 0,
    "next_scheduled_rate": {
      "id": "5eb7cf5a86d9755df3a6c593",
      "effective_from": "2026-09-25T19:33:18.383Z",
      "effective_to": "2026-09-25T19:33:18.383Z",
      "rate": 0,
      "type": "Per Order",
      "created_by": "string",
      "created_on": "2026-09-25T19:33:18.384Z"
    },
    "site_tank_move_store_number": "string"
  }
]
Loading...