Contracts

Create contract

Creates a new contract.<br/><br/>The request body must contain the name, idApp, and status of the contract.<br/><br/>Fields an admin marked as required in Torii must have a value, or the request fails with 400 and lists them in data.missingMandatoryFields.<br/><br/>Dates should be sent in ISOString format. Example: "2022-02-03"<br/><br/>Currency fields (e.g., amount) can be numbers ("amount": 1500, uses org default currency) or objects to set a different currency: "amount": { "value": 23000000, "currency": "EUR" }. Cannot set currency as a top-level field.<br/><br/>Optional lineItems are created with the contract (each needs a description; quantity, pricePerUnit, totalCost, currency, startDate, endDate, sku and the other value fields are optional; row ids and license mapping cannot be set here). Read them back with GET /contracts/{idContract}?fields=lineItems.<br/><br/>

<p><ul><li>Rate limit: 200 requests per minute</li></ul></p>
post/contracts

Request

  • Base URL
    https://api.toriihq.com/v1.0
  • Auth
    API key in header Authorization

Request body

namestring required
idAppinteger required

Unique app identifier

statusstring required

Contract status

amountinteger
startDatestring date-time

Contract start date, in ISO 8601 format (e.g. "2022-02-03")

endDatestring date-time

Contract end date, in ISO 8601 format (e.g. "2022-02-03")

Example request

{
  "name": "Salesforce contract",
  "idApp": 1000,
  "status": "pipeline",
  "startDate": "2022-02-03",
  "endDate": "2022-02-03"
}

Response

Create contract

Example response

{
  "contract": {
    "id": 1000,
    "name": "Salesforce contract",
    "status": "pipeline"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.