Skip to main content
POST
Create Single Driver Agreement

Authorizations

Authorization
string
header
required

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

Body

application/json
agreement_number
string
required

Unique identifier or number for the agreement.

Example:

"AGMT-0001"

agreement_start_date
string<date-time>
required

Start date of the driver agreement (ISO 8601 format).

Example:

"2025-04-10T00:00:00Z"

agreement_end_date
string<date-time>
required

End date of the driver agreement (ISO 8601 format).

Example:

"2025-10-10T00:00:00Z"

driver
integer
required

ID of the driver involved in the agreement.

Example:

103

vehicle
integer
required

ID of the vehicle assigned to the driver agreement.

Example:

7883

Response

201 - application/json

Driver Agreement Created Successfully

agreement_number
string

Unique identifier for the created agreement.

Example:

"AGMT-0001"

agreement_start_date
string<date-time>

Start date of the created agreement.

Example:

"2025-04-10T00:00:00-04:00"

agreement_end_date
string<date-time>

End date of the created agreement.

Example:

"2025-10-10T00:00:00-04:00"

driver
integer

ID of the driver involved in the created agreement.

Example:

103

vehicle
integer

ID of the vehicle linked to the created agreement.

Example:

7883

parent_agreement
string | null

Parent agreement ID if this is a sub-agreement; otherwise null.

Example:

null