Contracts

Contracts

For instructions on how to authenticate to use this endpoint, see API overview.

Retrieve undefined

Request

GET /contracts
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/contracts

Response

No response

Create undefined

Request Parameters

  • isCompany
    boolean
  • capital
    integer
  • manager
    string
  • name
    string
  • street1
    string
  • street2
    string
  • zipCode
    string
  • city
    string
  • contacts
    array
  • contract
    string
  • frequency
    string
  • beginDate
    string
  • endDate
    string
  • terminationDate
    string
  • guarantyPayback
    number
  • customer
    array
  • units
    array
  • guaranty
    number
  • reference
    string
  • isVat
    boolean
  • vatRatio
    number
  • commissioneRatio
    number
  • discount
    number
  • legalForm
    string
  • siret
    string
  • documents
    array
  • contractDate
    string
  • notes
    string
  • recordSource
    string
  • reservationId
    string
  • customerId
    string
  • terms
    array
  • bankInfo
    object
  • attachments
    array
  • description
    string
  • manual
    boolean
  • manualTerms
    array

Request

POST /contracts
export ICLOUDREADY_API_KEY=[your api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/contracts\
	-d isCompany="boolean"

Response

No response

Retrieve undefined

Path Parameters

  • id
    string

    ID of the contract

Request

GET /contracts/:id
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/contracts/:id

Response

No response

Update undefined

Path Parameters

  • id
    string

    ID of the contract

Request

PUT /contracts/:id
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/contracts/:id

Response

No response

Update undefined

Path Parameters

  • id
    string

    ID of the contract

Request

PATCH /contracts/:id
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/contracts/:id

Response

No response

Delete undefined

Path Parameters

  • id
    string

    ID of the contract

Request

DELETE /contracts/:id
export ICLOUDREADY_API_KEY=[your api key]
curl  -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://app.icloud-ready.com/contracts/:id

Response

No response

Questions?

Was this page useful?