Skip to main content

Freight Surcharge All V1 Ep

POST 
/v1/freight/surcharge/all

Surcharge All

Required Scopes (ia.r)

Request​

counterparty_name: str | None = None
Name of the counterparty.​

counterparty_id: str | None = None
ID of the counterparty.​

book_type: RateBookType | None = None
Type of rate book.

Details

Show Book Types Cost
Used for carrier ratebooks. Typically used to model internal costs.

Revenue
Used for customer ratebooks. Typically used to model rates charged to customers for carriers or wholesalers.

as_of: datetime | None = None
The date to filter surcharges by. If provided will only return surcharge active on this date.​

product_group: ProductGroups | None = None
Group of products for the surcharge.​

freight_region_name: str | None = None
Name of the freight region. Either the name or ID is required.​

freight_region_id: str | None = None
ID of the freight region. Either the name or ID is required.​

Response​

id: PydanticObjectId
Unique identifier for the surcharge.​

counterparty: str
Name of the counterparty.​

counterparty_id: str
ID of the counterparty.​

product_group: ProductGroups | None = None
Group of products for the surcharge.​

book_type: RateBookType
Type of rate book.

Details

Show Book Types Cost
Used for carrier ratebooks

Revenue
Used for customer ratebooks

freight_region_id: str | None = None
ID of the freight region.​

freight_region_name: str | None = None
Name of the freight region.​

type: SurchargeType
Type of surcharge.​

effective_from: datetime | None = None
Start date when surcharge is effective. Ignores time and will save as a callendar date.​

effective_to: datetime | None = None
End date when surcharge is effective. If no end is specified the surcharge is active until the next surcharge.​

surcharge: float | None = None
The surcharge amount.​

created_on: datetime
Date and time when the record was created.​

created_by: str | None = None
User who created the record.​

Responses​

Successful Response

[
  {
    "id": "5eb7cf5a86d9755df3a6c593",
    "counterparty": "string",
    "counterparty_id": "string",
    "product_group": "Gasoline",
    "book_type": "Cost",
    "freight_region_id": "string",
    "freight_region_name": "string",
    "type": "Per Mile",
    "effective_from": "2025-12-17T21:49:50.694Z",
    "effective_to": "2025-12-17T21:49:50.694Z",
    "surcharge": 0,
    "created_on": "2025-12-17T21:49:50.694Z",
    "created_by": "string"
  }
]
Loading...