TulipTulip Docs
Contrats

Créer un contrat

Ce endpoint permet de créer un contrat. Si le paramètre preview est à true, ceci ne créera pas le contrat mais retournera un contrat prévisualisé.

POST
/contracts
key<token>

In: header

Query Parameters

preview?boolean

Prévisualisation d'une requête.

  • true : Prévisualisation de la requête sans modification des données
  • false : Prévisualisation de la requête avec modification des données

Par défaut la valeur est false

Cette fonctionnalité peut être utilisée pour consulter une tarification sans créer de contrat

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://api.mytulip.io/v2/contracts" \  -H "Content-Type: application/json" \  -d '{    "contract_type": "LLD",    "uid": "qBaWdy6r3Lc3GkXTn374dFrnoN22",    "start_date": "2022-11-24T15:01:54.747Z",    "end_date": "2023-11-24T15:01:54.747Z",    "options": [      "break",      "theft",      "company",      "home_to_work"    ],    "products": [      {        "product_id": "UIYTYGjdg3Qdhgq9867gdh",        "data": {          "product_marked": "87798",          "user_name": "John Doe"        }      }    ],    "company": {      "address": "2 rue lafite",      "city": "PARIS-15E-ARRONDISSEMENT",      "company_name": "Ma super entreprise de location",      "country": "FR",      "zipcode": "75015",      "siren": "000000000",      "first_name": "Jane",      "last_name": "Doe"    }  }'
{
  "contract": {
    "cid": "01CFV26E8TS0U",
    "uid": "A1234567890",
    "created_date": "2025-01-01T00:00:00.000Z",
    "updated_date": "2025-01-01T00:00:00.000Z",
    "start_date": "2025-01-01T08:00:00.000Z",
    "end_date": "2025-01-01T19:00:00.000Z",
    "status": "open",
    "contract_type": "LCD",
    "company": {
      "address": "123 Rue de la Paix",
      "zipcode": "75001",
      "city": "PARIS-1ER-ARRONDISSEMENT",
      "country": "FR",
      "company_name": "Société A",
      "siren": "123456789",
      "first_name": "Pierre",
      "last_name": "Dupont"
    },
    "individual": {
      "first_name": "Pierre",
      "last_name": "Dupont",
      "address": "123 Rue de la Paix",
      "zipcode": "75001",
      "city": "PARIS-1ER-ARRONDISSEMENT",
      "country": "FR",
      "phone_number": "06 06 06 06 06",
      "email": "pierre.dupont@example.com"
    },
    "test": true,
    "products": {
      "property1": {
        "product_id": "01CFV26E8TS0U",
        "start_date": "2025-01-01T00:00:00.000Z",
        "end_date": "2025-01-01T19:00:00.000Z",
        "status": "open",
        "data": {
          "user_name": "Dubois Jean",
          "product_marked": "04670010008323",
          "internal_id": "ve-1234567890"
        },
        "price": 1,
        "replaced_by": "0000-0000-0000-0000"
      },
      "property2": {
        "product_id": "01CFV26E8TS0U",
        "start_date": "2025-01-01T00:00:00.000Z",
        "end_date": "2025-01-01T19:00:00.000Z",
        "status": "open",
        "data": {
          "user_name": "Dubois Jean",
          "product_marked": "04670010008323",
          "internal_id": "ve-1234567890"
        },
        "price": 1,
        "replaced_by": "0000-0000-0000-0000"
      }
    },
    "options": [
      "break",
      "theft"
    ],
    "price": 1
  },
  "status": "success",
  "execution_id": "1234567890"
}
{
  "execution_id": "1234567890",
  "status": "error",
  "type": "bad_request",
  "message": "bad request",
  "error": {
    "code": 1000,
    "message": "La date de début ne peut pas être dans le passé."
  }
}

Que pensez-vous de cette page ?