Guides

Criar Contrato

Suggest Edits

Agora, podemos criar um contrato de fato. Basta fazer uma requisição no endpoint de contracts.

POST /contracts

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

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

⚠️ Para os endpoints que possuem payload, será necessário passar 'Content-Type': 'application/json' no headers da requisição.

Exemplo de payload:

{ 
  "contract": { 
    "title": "Titulo do Contrato Teste", 
    "workflow_id": 2379, 
    "document": {
        "file_id": 199849
    }
  } 
}

Descrição do payload:

NameTypeDescription
title *stringtítulo do contrato
workflow_idnumberid do grupo em que o contrato será inserido
file_id *numberid do arquivo que fará parte do documento principal do contrato

🚨 Os campos marcados com * são obrigatórios.

⚠️ O file_id deverá receber o id do documento que teve seu upload realizado através do endpoint /files. Caso não tenho realizado esse processo, clique aqui para faze-lo antes de prosseguir.

Exemplo de resposta:

{
    "data": {
        "deny_reason": null,
        "status": {
            "color": 1,
            "id": 1638,
            "name": "Rascunho"
        },
        "begin_date": null,
        "number": "2024/21",
        "workflow": {
            "contracts_count": null,
            "id": 2379,
            "inserted_at": "2024-05-15T15:07:23",
            "is_default": false,
            "name": "Título para o workflow",
            "organization": {
                "id": 1199
            },
            "statuses": null,
            "updated_at": "2024-05-15T15:07:23",
            "users": null
        },
        "current_document": {
            "contract": {
                "id": 176020
            },
            "draft": null,
            "editor": "tinymce",
            "file": {
                "download_url": url de download do arquivo,
                "google_file_id": null,
                "id": 199849,
                "inserted_at": "2024-05-15T15:06:49",
                "mime": "application/pdf",
                "name": "dummy.pdf",
                "preview_url": url de visualização prévia do arquivo,
                "size": 13264,
                "updated_at": "2024-05-15T15:06:49"
            },
            "id": "caf82d77-c883-4c97-8f8d-905e894a4ec0",
            "inserted_at": "2024-05-15T15:07:37",
            "notes": null,
            "organization": {
                "id": 1199
            },
            "proofs": [],
            "updated_at": "2024-05-15T15:07:37",
            "user": {
                "id": 3056
            }
        },
        "classifier": null,
        "tasks": [],
        "archived": false,
        "due_notice": 60,
        "id": 176020,
        "shares": [],
        "inserted_at": "2024-05-15T15:07:37",
        "observations": null,
        "attachments": [],
        "financial": [],
        "form_submission": null,
        "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": false,
                "signature_counter": 1,
                "updated_at": "2023-12-15T19:35:45",
                "whatsapp_link": false,
                "whatsapp_monthly_quota": 0,
                "whatsapp_notification": false
            },
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-05-15T15:07:36",
            "workflows": null
        },
        "object": null,
        "comments": [],
        "updated_at": "2024-05-15T15:07:37",
        "review_flows_events": [],
        "pendencies": 0.0,
        "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
        },
        "title": "Titulo do Contrato Teste",
        "term_type": null,
        "deleted": false,
        "needs_acceptance": null,
        "end_date": null,
        "childrem_contracts": [],
        "prev_status": null,
        "custom_fields": [],
        "parent_contract": null,
        "review_flow": null,
        "prev_assignee": null
    }
}

⚠️ O id retornado nesse response será de suma importância para continuarmos o processo de disparo para assinaturas. O mesmo se encontra dento do objeto contract.

Updated 3 months ago