{
  "opencollection": "1.0.0",
  "info": {
    "name": "Horizon API V1 AccountExternalTruckIdentifier Rates API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Rates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Rates that belong to a Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tread-horizon.com/v1/companies/:company-id/rates",
            "headers": [
              {
                "name": "Accept-Language",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company-id",
                "value": "",
                "type": "path",
                "description": "Company ID"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of paginated results to return"
              },
              {
                "name": "page[after]",
                "value": "",
                "type": "query",
                "description": "The cursor to start paginating after"
              },
              {
                "name": "page[before]",
                "value": "",
                "type": "query",
                "description": "The cursor to stop paginating at"
              },
              {
                "name": "filter[account_id]",
                "value": "",
                "type": "query",
                "description": "Account ID filter"
              },
              {
                "name": "filter[account_type]",
                "value": "",
                "type": "query",
                "description": "AccountType filter. See `AccountType` enum for accepted values."
              },
              {
                "name": "filter[driver_id]",
                "value": "",
                "type": "query",
                "description": "Driver ID filter"
              },
              {
                "name": "filter[equipment_id]",
                "value": "",
                "type": "query",
                "description": "Equipment ID filter"
              },
              {
                "name": "filter[include_default]",
                "value": "",
                "type": "query",
                "description": "Includes default rates when set to true"
              },
              {
                "name": "filter[owner_type]",
                "value": "",
                "type": "query",
                "description": "RateOwnerType filter"
              },
              {
                "name": "filter[project_id]",
                "value": "",
                "type": "query",
                "description": "Project ID filter"
              },
              {
                "name": "filter[service_id]",
                "value": "",
                "type": "query",
                "description": "Service ID filter"
              },
              {
                "name": "filter[service_class_id]",
                "value": "",
                "type": "query",
                "description": "The associated ServiceClass ID"
              },
              {
                "name": "filter[equipment_type_id]",
                "value": "",
                "type": "query",
                "description": "The associated EquipmentType ID"
              }
            ]
          },
          "docs": "Retrieve `Rates` that belong to a `Company`"
        },
        {
          "info": {
            "name": "Typeahead search on Rates for a Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tread-horizon.com/v1/companies/:company-id/rates/typeahead",
            "headers": [
              {
                "name": "Accept-Language",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company-id",
                "value": "",
                "type": "path",
                "description": "Company ID"
              },
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of paginated results to return"
              },
              {
                "name": "page[after]",
                "value": "",
                "type": "query",
                "description": "The cursor to start paginating after"
              },
              {
                "name": "page[before]",
                "value": "",
                "type": "query",
                "description": "The cursor to stop paginating at"
              },
              {
                "name": "filter[account_id]",
                "value": "",
                "type": "query",
                "description": "Account ID filter"
              },
              {
                "name": "filter[driver_id]",
                "value": "",
                "type": "query",
                "description": "Driver ID filter"
              },
              {
                "name": "filter[equipment_id]",
                "value": "",
                "type": "query",
                "description": "Equipment ID filter"
              },
              {
                "name": "filter[include_default]",
                "value": "",
                "type": "query",
                "description": "Includes default rates when set to true"
              },
              {
                "name": "filter[owner_type]",
                "value": "",
                "type": "query",
                "description": "RateOwnerType filter"
              },
              {
                "name": "filter[project_id]",
                "value": "",
                "type": "query",
                "description": "Project ID filter"
              },
              {
                "name": "filter[service_id]",
                "value": "",
                "type": "query",
                "description": "Service ID filter"
              },
              {
                "name": "search[query]",
                "value": "",
                "type": "query",
                "description": "Search string for queries"
              },
              {
                "name": "filter[service_class_id]",
                "value": "",
                "type": "query",
                "description": "The associated ServiceClass ID"
              },
              {
                "name": "filter[equipment_type_id]",
                "value": "",
                "type": "query",
                "description": "The associated EquipmentType ID"
              }
            ]
          },
          "docs": "Typeahead search on `Rates` for a `Company`"
        },
        {
          "info": {
            "name": "Retrieve Rates that belong to the current Company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tread-horizon.com/v1/rates",
            "headers": [
              {
                "name": "Accept-Language",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page[limit]",
                "value": "",
                "type": "query",
                "description": "The maximum number of paginated results to return"
              },
              {
                "name": "page[after]",
                "value": "",
                "type": "query",
                "description": "The cursor to start paginating after"
              },
              {
                "name": "page[before]",
                "value": "",
                "type": "query",
                "description": "The cursor to stop paginating at"
              },
              {
                "name": "filter[account_id]",
                "value": "",
                "type": "query",
                "description": "Account ID filter"
              },
              {
                "name": "filter[project_id]",
                "value": "",
                "type": "query",
                "description": "Project ID filter"
              },
              {
                "name": "filter[service_id]",
                "value": "",
                "type": "query",
                "description": "Service ID filter"
              },
              {
                "name": "filter[equipment_id]",
                "value": "",
                "type": "query",
                "description": "Equipment ID filter"
              },
              {
                "name": "filter[account_type]",
                "value": "",
                "type": "query",
                "description": "Account type filter (deprecated, will only work if owner_type is not provided)"
              },
              {
                "name": "filter[include_default]",
                "value": "",
                "type": "query",
                "description": "Includes default rates when set to true"
              },
              {
                "name": "filter[owner_type]",
                "value": "",
                "type": "query",
                "description": "RateOwnerType filter (should be used instead of account_type, this takes precedence over account_type)"
              },
              {
                "name": "filter[driver_id]",
                "value": "",
                "type": "query",
                "description": "Driver ID filter"
              },
              {
                "name": "filter[service_class_id]",
                "value": "",
                "type": "query",
                "description": "The associated ServiceClass ID"
              },
              {
                "name": "filter[equipment_type_id]",
                "value": "",
                "type": "query",
                "description": "The associated EquipmentType ID"
              }
            ]
          },
          "docs": "Retrieve `Rates` for a `Company`"
        },
        {
          "info": {
            "name": "Create a Rate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.tread-horizon.com/v1/rates",
            "headers": [
              {
                "name": "Accept-Language",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a `Rate`\n\nThis endpoint requires the `create_rate` permission\n"
        },
        {
          "info": {
            "name": "Retrieve a single Rate",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tread-horizon.com/v1/rates/:id",
            "headers": [
              {
                "name": "Accept-Language",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Rate ID"
              }
            ]
          },
          "docs": "Retrieve `Rate` by ID"
        },
        {
          "info": {
            "name": "Update a Rate",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.tread-horizon.com/v1/rates/:id",
            "headers": [
              {
                "name": "Accept-Language",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Rate ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a `Rate` by ID\n\nThis endpoint requires the `edit_rate` permission"
        },
        {
          "info": {
            "name": "Delete a Rate",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.tread-horizon.com/v1/rates/:id",
            "headers": [
              {
                "name": "Accept-Language",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Rate ID"
              }
            ]
          },
          "docs": "Delete a `Rate` by ID\n\nThis endpoint requires the `delete_rate` permission"
        },
        {
          "info": {
            "name": "Copy a Rate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.tread-horizon.com/v1/rates/:rate-id/copy",
            "headers": [
              {
                "name": "Accept-Language",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "rate-id",
                "value": "",
                "type": "path",
                "description": "Rate ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Copy a `Rate` to another `Account` or `Driver`\n\nThis endpoint requires the `create_rate` permission\n\nUsage:\n- provide either `account_id` or `driver_id`"
        }
      ]
    }
  ],
  "bundled": true
}