Skip to main content
POST
Create contract

Authorizations

Authorization
string
header
required

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

Path Parameters

contract_id
integer
required

Body

application/json
client_id
integer
required

Client ID

name
string
required

Contract name

type
string
required

Contract type

source
string
required

Source of the contract

status
string
required

Contract status

company_id
integer
required

Company ID

start
string<date-time>
required

Contract start date-time

end
string<date-time>
required

Contract end date-time

frequency
string
required

Contract billing frequency

currency_id
integer
required

Currency ID

json_integrations

Integration payload stored as JSON

url
string

External URL

url_name
string

External URL name

user_positions_header_id
integer

User positions header ID

Response

200 - application/json

Contract created successfully

Contract entity

id
integer

Contract ID

client_id
integer

Client ID

json_integrations

Integration payload stored as JSON

name
string

Contract name

type
string

Contract type

source
string

Source of the contract

status
string

Contract status

company_id
integer

Company ID

start
string<date-time>

Contract start date-time

end
string<date-time>

Contract end date-time

frequency
string

Contract billing frequency

currency_id
integer

Currency ID

currency
object
url
string

External URL

url_name
string

External URL name

user_positions_header_id
integer

User positions header ID

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

deleted_at
string<date-time> | null

Deletion timestamp (soft delete)