Skip to main content
GET
/
v1
/
contracts
/
{contract_id}
/
surcharges
List contract surcharges
curl --request GET \
  --url https://api.opereit.com/v1/contracts/{contract_id}/surcharges \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": "<string>",
      "contract_id": "<string>",
      "slug": "fuel",
      "display_name": "Fuel surcharge",
      "billing_type": "PERCENTAGE",
      "value": "15.00",
      "currency": "EUR",
      "is_waived": true,
      "origin_country": "<string>",
      "destination_country": "<string>",
      "service_type": "<string>",
      "calculation_base": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "cursor": "<string>",
    "has_more": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.opereit.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).

Path Parameters

​
contract_id
string
required

ID of the contract.

Query Parameters

​
limit
integer
default:50

Number of items to return per request.

Required range: 1 <= x <= 100
​
cursor
string

Opaque cursor from a previous response. Omit on the first request.

​
search
string

Free-text search against the surcharge display name.

​
billing_type
enum<string>

Filter by how the surcharge is billed.

Available options:
PERCENTAGE,
PERCENTAGE_OF_BASE,
FIXED,
TIERED,
PERCENTAGE_OFF
​
service_type
string

Filter by carrier service code the surcharge applies to.

​
is_waived
boolean

If true, returns only surcharges marked as waived in the contract.

Response

Cursor-paginated surcharges.

​
data
object[]
required
​
pagination
object
required