Create new contract

28 Oct 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Create new contract

Updated on 28 Oct 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/contracts/

Operation is used to create new contract. Available from product version 3.2.24.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

contract to be created

object

agreement

string

Contract Identifier

antenna

integer

Contract antenna

billing

integer

Contact Billing id

billingDay

integer

Contract billing day

billingPeriod

integer

Contract billing period

billingReference

string

Contract billing reference

cableUsage

string

Contract billing cable usage

comment

string

Contract comments

contractStatus

integer

Contract Status id

contractType

integer

Contract Type id

lessee

integer

Customer Lesee id

lessor

integer

Customer Lessor id

parentContract

integer

Parent Contract id

rent

number (float) Required

Contract rent. Normally a required attribute, can be set as not required on request.

rentBeginDate

string (date-time)

The date begin to rent

rentEndDate

string (date-time)

The date end of the rent

rent_2

number (float)

Contract rent 2

rent_3

number (float)

Contract rent 3

reserveBeginDate

string (date-time)

The date begin to reserved

reserveEndDate

string (date-time)

The date end of the reservation

termOfNotice

integer

Contract term of notice

Responses

201

created contract data

{
  "agreement": "",
  "antenna": null,
  "billing": null,
  "billingDay": null,
  "billingPeriod": null,
  "billingReference": "",
  "cableUsage": "",
  "comments": "this is a a fire drill asd",
  "contractStatus": null,
  "contractType": null,
  "createdBy": "example@example.com",
  "createdTs": "2022-02-15T05:24:34Z",
  "id": 2473150,
  "lessee": null,
  "lessor": null,
  "parentContract": null,
  "rent": "43.43",
  "rentBeginDate": null,
  "rentEndDate": null,
  "rent_2": null,
  "rent_3": null,
  "reserveBeginDate": null,
  "reserveEndDate": null,
  "termOfNotice": null,
  "updatedBy": "example@example.com",
  "updatedTs": "2022-02-15T05:24:34Z"
}

object

agreement

string

Contract Identifier

antenna

integer

Contract antenna

billing

integer

Contact Billing id

billingDay

integer

Contract billing day

billingPeriod

integer

Contract billing period

billingReference

string

Contract billing reference

cableUsage

string

Contract billing cable usage

comment

string

Contract comments

contractStatus

integer

Contract Status id

contractType

integer

Contract Type id

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

integer

Primary key

lessee

integer

Customer Lesee id

lessor

integer

Customer Lessor id

parentContract

integer

Parent Contract id

rent

number (float)

Contract rent. Normally a required attribute, can be set as not required on request.

rentBeginDate

string (date-time)

The date begin to rent

rentEndDate

string (date-time)

The date end of the rent

rent_2

number (float)

Contract rent 2

rent_3

number (float)

Contract rent 3

reserveBeginDate

string (date-time)

The date begin to reserved

reserveEndDate

string (date-time)

The date end of the reservation

termOfNotice

integer

Contract term of notice

updatedBy

string

Last updated

updatedTs

string (date-time)

Last update date time

400

There was an error in request. Usually field validation failed.

{
  "rent": [
    "This field is required."
  ]
}

object

Fields which failed validation

property*

Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Delete contract data