Skip to main content
POST
/
v1
/
projects
Create a Project in the current Company
curl --request POST \
  --url https://api.tread-horizon.com/v1/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "effective_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "order_notes": "<string>",
  "job_notes": "<string>",
  "internal_notes": "<string>",
  "po_job_number": "<string>",
  "external_id": "<string>",
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact": {
    "name": "<string>",
    "email": "<string>",
    "phone": "+18885551234"
  },
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phases": [
    {
      "name": "<string>",
      "code": "<string>",
      "primary": true
    }
  ],
  "project_material_totals": [
    {
      "material_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "total_quantity": 123,
      "unit_of_measure": "Load"
    }
  ],
  "sales_contact": {
    "name": "<string>",
    "email": "<string>",
    "phone": "+18885551234"
  },
  "foreman_contact": {
    "name": "<string>",
    "email": "<string>",
    "phone": "+18885551234"
  },
  "supervisor_contact": {
    "name": "<string>",
    "email": "<string>",
    "phone": "+18885551234"
  },
  "collaborator_contact": {
    "name": "<string>",
    "email": "<string>",
    "phone": "+18885551234"
  },
  "department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "foreman_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "collaborator_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "salesperson_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "customer_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vendor_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "driver_rate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hauler_rate_type": "<string>",
  "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "service_class_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_time": 123,
  "order_quantity": 123,
  "equipment_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loads_per_truck": 13,
  "truck_count": 100,
  "units_per_hour": 123,
  "job_quantity": 123,
  "waypoints": [
    {
      "type": "pickup",
      "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ordinality": 123,
      "contact": {
        "name": "<string>",
        "email": "<string>",
        "phone": "+18885551234"
      }
    }
  ],
  "customer_rate_value": 123,
  "customer_rate_type": "RatePerHour",
  "vendor_rate_value": 123,
  "vendor_rate_type": "RatePerHour",
  "driver_rate_value": 123,
  "driver_rate_type": "RatePerHour",
  "requester_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "equipment_type_gross_capacity": 123,
  "load_unit_of_measure": "Load",
  "recurring_loads": true,
  "order_unit_of_measure": "Load",
  "job_unit_of_measure": "Load",
  "equipment_type_gross_capacity_unit_of_measure": "Load",
  "charge_to_account": "<string>",
  "chase_missing_tickets": true,
  "default_digital_ticket_view": false,
  "tax_rate": 123,
  "tax_freight": false,
  "tax_material": false,
  "tax_add_ons": false
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "expires_at": "<string>",
    "effective_at": "<string>",
    "name": "<string>",
    "notes": "<string>",
    "order_notes": "<string>",
    "job_notes": "<string>",
    "internal_notes": "<string>",
    "po_job_number": "<string>",
    "external_id": "<string>",
    "state": "active",
    "project_id": "<string>",
    "company": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tread_id": "ABC123",
      "legal_name": "<string>",
      "company_type": "hauler"
    },
    "account": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "discarded_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "account_types": [
        "customer"
      ],
      "external_id": "<string>",
      "accounting_id": "<string>",
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "schedule_on": true,
      "billing_address": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "thoroughfare": "<string>",
        "premise": "<string>",
        "locality": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>",
        "country": "US",
        "lat": "<string>",
        "lon": "<string>",
        "place_id": "<string>"
      },
      "connected_company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "tread_id": "ABC123",
        "legal_name": "<string>",
        "company_type": "hauler"
      },
      "billing_contact": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "email": "<string>",
        "phone": "+18885551234"
      }
    },
    "phases": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "code": "<string>",
        "primary": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "project_material_totals": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "total_quantity": "<string>",
        "unit_of_measure": "Load",
        "material": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "external_id": "<string>"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "foremen": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        },
        "discarded_at": "2023-11-07T05:31:56Z",
        "company_share": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "ticket_match_id": "<string>",
          "sender_company": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tread_id": "ABC123",
            "legal_name": "<string>",
            "company_type": "hauler"
          },
          "dispatchable": true,
          "schedule_on": true,
          "rate_override": true,
          "expires_at": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "collaborators": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "discarded_at": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "phone": "<string>",
        "external_id": "<string>",
        "schedule_on": true
      }
    ],
    "salespeople": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "discarded_at": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "phone": "<string>",
        "external_id": "<string>",
        "schedule_on": true
      }
    ],
    "hauler_rate_type": "<string>",
    "job_time": 123,
    "order_quantity": "<string>",
    "loads_per_truck": 123,
    "truck_count": 123,
    "units_per_hour": 123,
    "job_quantity": "<string>",
    "customer_rate_value": "<string>",
    "customer_rate_type": "RatePerHour",
    "vendor_rate_value": "<string>",
    "vendor_rate_type": "RatePerHour",
    "driver_rate_value": "<string>",
    "driver_rate_type": "RatePerHour",
    "equipment_type_gross_capacity": "<string>",
    "load_unit_of_measure": "Load",
    "job_unit_of_measure": "Load",
    "order_unit_of_measure": "Load",
    "recurring_loads": true,
    "equipment_type_gross_capacity_unit_of_measure": "Load",
    "charge_to_account": "<string>",
    "chase_missing_tickets": true,
    "tax_rate": "<string>",
    "tax_freight": false,
    "tax_material": false,
    "tax_add_ons": false,
    "contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "site": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "lat": "<string>",
      "lon": "<string>",
      "full_address": "<string>",
      "routable": true,
      "discarded_at": "2023-11-07T05:31:56Z",
      "address": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "thoroughfare": "<string>",
        "premise": "<string>",
        "locality": "<string>",
        "administrative_area": "<string>",
        "postal_code": "<string>",
        "country": "US",
        "lat": "<string>",
        "lon": "<string>",
        "place_id": "<string>"
      },
      "next_billion_geofence": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "geofence": {
          "name": "<string>",
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "geojson": {
            "type": "<string>",
            "coordinates": [
              [
                [
                  "<unknown>"
                ]
              ]
            ]
          },
          "circle_center": {
            "lat": 123,
            "lon": 123
          },
          "circle_radius": 123,
          "tag": "pickup"
        },
        "moving_geofence": false,
        "tag": "scaling",
        "geofence_type": "moving"
      }
    },
    "sales_contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "foreman_contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "supervisor_contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "collaborator_contact": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "email": "<string>",
      "phone": "+18885551234"
    },
    "department": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "customer_rate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "RatePerHour",
      "time_rate": 123
    },
    "vendor_rate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "RatePerHour",
      "time_rate": 123
    },
    "driver_rate": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "type": "RatePerHour",
      "time_rate": 123
    },
    "service": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "service_class": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "equipment_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "system": true,
      "external_id": "<string>",
      "accounting_id": "<string>"
    },
    "waypoints": [
      {
        "type": "pickup",
        "ordinality": 123,
        "site": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "lat": "<string>",
          "lon": "<string>",
          "full_address": "<string>",
          "routable": true,
          "discarded_at": "2023-11-07T05:31:56Z",
          "address": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "thoroughfare": "<string>",
            "premise": "<string>",
            "locality": "<string>",
            "administrative_area": "<string>",
            "postal_code": "<string>",
            "country": "US",
            "lat": "<string>",
            "lon": "<string>",
            "place_id": "<string>"
          },
          "next_billion_geofence": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "geofence": {
              "name": "<string>",
              "type": "<string>",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "geojson": {
                "type": "<string>",
                "coordinates": [
                  [
                    [
                      "<unknown>"
                    ]
                  ]
                ]
              },
              "circle_center": {
                "lat": 123,
                "lon": 123
              },
              "circle_radius": 123,
              "tag": "pickup"
            },
            "moving_geofence": false,
            "tag": "scaling",
            "geofence_type": "moving"
          }
        },
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "contact": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "<string>",
          "phone": "+18885551234"
        }
      }
    ],
    "requester": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "discarded_at": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "phone": "<string>",
      "external_id": "<string>",
      "schedule_on": true
    },
    "dispatch_number": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "default_digital_ticket_view": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tread.ai/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Body

application/json
​
name
string
required

Project name, must be unique in the current Company

​
effective_at
string<date-time>

Timestamp of the Project's effective start. Must be less than expires_at if expires_at is present.

​
expires_at
string<date-time>

Timestamp of the Project's effective end. Must be greater than effective_at if effective_at is present.

​
notes
string | null

Project notes

​
order_notes
string | null

Order notes

​
job_notes
string | null

Job notes

​
internal_notes
string | null

Project notes

​
po_job_number
string

PO/Job # for Project

​
external_id
string

External # for Project, must be unique in the current Company

​
account_id
string<uuid>

Account ID.

One of account_id or account is required.

​
account
Account-Create · object
​
contact
Contact-Create · object
​
site_id
string<uuid> | null
​
company_id
string<uuid>
​
phases
Phase-Create · object[]
​
project_material_totals
ProjectMaterialTotal-Create · object[]
​
sales_contact
Contact-Create · object
​
foreman_contact
Contact-Create · object
​
supervisor_contact
Contact-Create · object
​
collaborator_contact
Contact-Create · object
​
department_id
string<uuid> | null
​
foreman_ids
string<uuid>[]
​
collaborator_ids
string<uuid>[]
​
salesperson_ids
string<uuid>[]
​
customer_rate_id
string<uuid> | null
​
vendor_rate_id
string<uuid> | null
​
driver_rate_id
string<uuid> | null
​
hauler_rate_type
string | null
​
service_id
string<uuid> | null
​
service_class_id
string<uuid> | null
​
job_time
integer | null

Time in minutes

​
order_quantity
number | null
​
equipment_type_id
string<uuid> | null
​
loads_per_truck
integer | null
Required range: 1 <= x <= 25
​
truck_count
integer | null
Required range: 1 <= x <= 200
​
units_per_hour
integer | null
​
job_quantity
number | null
​
waypoints
Waypoint-Create · object[]
​
customer_rate_value
number | null
​
customer_rate_type
enum<string>
Available options:
RatePerHour,
RatePerDay,
RatePerLoad,
RatePerTon,
RatePerTonne,
RatePerYard,
RatePerBushel,
RateCommission,
RateFlatCommission,
RateFlatRate
Example:

"RatePerHour"

​
vendor_rate_value
number | null
​
vendor_rate_type
enum<string>
Available options:
RatePerHour,
RatePerDay,
RatePerLoad,
RatePerTon,
RatePerTonne,
RatePerYard,
RatePerBushel,
RateCommission,
RateFlatCommission,
RateFlatRate
Example:

"RatePerHour"

​
driver_rate_value
number | null
​
driver_rate_type
enum<string>
Available options:
RatePerHour,
RatePerDay,
RatePerLoad,
RatePerTon,
RatePerTonne,
RatePerYard,
RatePerBushel,
RateCommission,
RateFlatCommission,
RateFlatRate
Example:

"RatePerHour"

​
requester_id
string<uuid> | null
​
equipment_type_gross_capacity
number | null
​
load_unit_of_measure
enum<string>
Available options:
Load,
Tonne,
Ton,
Yard,
Meter,
Foot,
Liter,
Hour,
Bushel,
Gallon,
CubicMeter,
Mile,
Kilometer,
Barrel,
Bag,
Pallet
Example:

"Load"

​
dispatch_number
DispatchNumber-Create · object
​
recurring_loads
boolean
​
order_unit_of_measure
enum<string>
Available options:
Load,
Tonne,
Ton,
Yard,
Meter,
Foot,
Liter,
Hour,
Bushel,
Gallon,
CubicMeter,
Mile,
Kilometer,
Barrel,
Bag,
Pallet
Example:

"Load"

​
job_unit_of_measure
enum<string>
Available options:
Load,
Tonne,
Ton,
Yard,
Meter,
Foot,
Liter,
Hour,
Bushel,
Gallon,
CubicMeter,
Mile,
Kilometer,
Barrel,
Bag,
Pallet
Example:

"Load"

​
equipment_type_gross_capacity_unit_of_measure
enum<string>
Available options:
Load,
Tonne,
Ton,
Yard,
Meter,
Foot,
Liter,
Hour,
Bushel,
Gallon,
CubicMeter,
Mile,
Kilometer,
Barrel,
Bag,
Pallet
Example:

"Load"

​
charge_to_account
string | null
​
chase_missing_tickets
boolean

Enable ticket chasing for jobs in orders with this project

​
default_digital_ticket_view
boolean
default:false

Use the default digital ticket view for orders in this project

​
tax_rate
number | null

Tax rate percentage (up to 4 decimal places)

​
tax_freight
boolean
default:false

Whether freight line items and FSC are taxable

​
tax_material
boolean
default:false

Whether material line items are taxable

​
tax_add_ons
boolean
default:false

Whether add-on charges are taxable (dual-confirm with add_on.taxable)

Response

Created

​
data
Project-Read · object
required

Read model for Project