Skip to main content
POST
Create a Project in the current Company

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> | null
Available options:
RatePerHour,
RatePerDay,
RatePerLoad,
RatePerTon,
RatePerTonne,
RatePerYard,
RatePerBushel,
RateCommission,
RateFlatCommission,
RateFlatRate
Example:

"RatePerHour"

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

"RatePerHour"

driver_rate_value
number | null
driver_rate_type
enum<string> | null
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> | null
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> | null
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> | null
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> | null
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