Criar Contrato

Uma das funcionalidades da nossa API é permitir a criação de contratos a partir de modelos.

POST /contracts

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}',
  'Content-Type': 'application/json'
}

Exemplo de payload:

{ 
  "contract": { 
    "title": "Título do Contrato",
    "current_document": {
        "draft": {
            "template_id": 2811
        }
    }
  } 
}

Descrição do payload:

NameTypeDescription
template_idnumberid do templete relacionado ao modelo
titlestringtítulo do contrato

Exemplo de resposta:

{
    "data": {
        "status": {
            "color": 1,
            "id": 1638,
            "name": "Rascunho"
        },
        "observations": null,
        "tasks": [],
        "updated_at": "2024-06-04T17:26:56",
        "id": 176161,
        "shares": [],
        "number": "2024/38",
        "inserted_at": "2024-06-04T17:26:56",
        "due_notice": 60,
        "financial": [],
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": {
                "document_history": false,
                "form_review_flow": false,
                "id": 1193,
                "inserted_at": "2023-12-15T19:35:45",
                "organization": {
                    "id": 1199
                },
                "plan": {
                    "id": 7
                },
                "price": "199.90",
                "price_user": "56.33",
                "redlining": false,
                "sharelink": true,
                "signature_counter": 1,
                "updated_at": "2023-12-15T19:35:45",
                "whatsapp_link": true,
                "whatsapp_monthly_quota": 1000,
                "whatsapp_notification": true
            },
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-06-04T17:26:56",
            "workflows": null
        },
        "object": null,
        "comments": [],
        "title": "OIOIOI",
        "review_flows_events": [],
        "childrem_contracts": [],
        "prev_assignee": null,
        "form_submission": null,
        "pendencies": 0.0,
        "current_document": {
            "contract": {
                "id": 176161
            },
            "draft": {
                "content": {
                    "blocks": [
                        {
                            "data": {},
                            "depth": 0,
                            "entityRanges": [],
                            "inlineStyleRanges": [],
                            "key": "MC45N",
                            "text": "",
                            "type": "unstyled"
                        }
                    ],
                    "entityMap": {}
                },
                "html": null,
                "id": 6580,
                "inserted_at": "2024-06-04T17:26:56",
                "read_only": true,
                "template": {
                    "content": null,
                    "description": "Descrição do modelo",
                    "editor": "tinymce",
                    "forms": null,
                    "html": null,
                    "id": 2811,
                    "inserted_at": "2024-05-09T19:06:15",
                    "json_data": null,
                    "organization": {
                        "id": 1199
                    },
                    "read_only_instances": true,
                    "title": "Modelo API Contraktor",
                    "updated_at": "2024-05-09T19:06:15"
                },
                "updated_at": "2024-06-04T17:26:56"
            },
            "editor": "tinymce",
            "file": null,
            "id": "fb45be2d-2588-43e7-818f-4d78d6de841d",
            "inserted_at": "2024-06-04T17:26:56",
            "notes": null,
            "organization": {
                "id": 1199
            },
            "proofs": [],
            "updated_at": "2024-06-04T17:26:56",
            "user": {
                "id": 3056
            }
        },
        "needs_acceptance": null,
        "assignee": {
            "activated": true,
            "activity": "Desenvolvedor Jr",
            "cpf": "136.382.516-08",
            "email": "[email protected]",
            "first_name": "Davi",
            "gender": "unspecified",
            "id": 3056,
            "last_name": "Ferreira",
            "marital_status": null,
            "organizations_users": null
        },
        "term_type": null,
        "deleted": false,
        "end_date": null,
        "prev_status": null,
        "custom_fields": [],
        "parent_contract": null,
        "attachments": [],
        "archived": false,
        "review_flow": null,
        "deny_reason": null,
        "begin_date": null,
        "workflow": null,
        "classifier": null
    }
}

Como criar contratos a partir de modelos?

Acesse nossa central de ajuda e veja o passo a passo completo:

Criando um contrato