Guides

Anexar Documentos

Suggest Edits

Através do seguinte endpoint, podemos anexar documentos ao contrato.

POST /contracts/{contract_id}/attachments

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

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

⚠️ Lembre-se de substituir a variável {contract_id} no parâmetro da rota pelo valor id do contrato que você deseja anexar algum documento.

Exemplo de payload:

{ 
  "attachment": {
    "file_id": file_id
  }
}

⚠️ 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.

Descrição do payload:

NameTypeDescription
file_idnumberid do arquivo a ser anexado

Exemplo de resposta:

{
    "data": {
        "contract": {
            "id": 176046
        },
        "file": {
            "download_url": url de download do arquivo,
            "google_file_id": null,
            "id": 200038,
            "inserted_at": "2024-05-31T15:51:27",
            "mime": "application/pdf",
            "name": "dummy.pdf",
            "preview_url": url de visualização prévia do arquivo,
            "size": 13264,
            "updated_at": "2024-05-31T15:51:27"
        },
        "id": 1418,
        "inserted_at": "2024-05-31T15:51:57",
        "mergeable": null,
        "updated_at": "2024-05-31T15:51:57"
    }
}

Anexar Arquivo ao Documento Principal

Disponibilizamos a opção de anexar o arquivo que teve seu upload feito anteriormente ao documento principal. Para isso, utilize o seguinte endpoint:

PUT/contracts/{contract_id}/attachments/{file_id}

Testar endpoint

Exemplo de payload:

{ 
  "attachment": {
    "mergeable": true
  }
}

Descrição do payload:

NameTypeDescription
mergeableboolean"mergeable" - true (anexar ao documento principal)
"mergeable" - false (retirar anexo ao documento principal)

⚠️ Após a criação do anexo no documento em específico, você poderá anexar esse arquivo ao documento principal de seu contrato. Para isso, será necessário fazer um PUT com o payload especificado acima. Caso queira fazer o processo contrário, será preciso passar a variável "mergeable" como false. Isso irá retirar o arquivo anexado ao documento principal.

Exemplo de resposta:

{
    "data": {
        "contract": {
            "id": 176046
        },
        "file": {
            "download_url": url de download do arquivo,
            "google_file_id": null,
            "id": 200038,
            "inserted_at": "2024-05-31T15:51:27",
            "mime": "application/pdf",
            "name": "dummy.pdf",
            "preview_url": url de visualização prévia do arquivo,
            "size": 13264,
            "updated_at": "2024-05-31T15:51:27"
        },
        "id": 1418,
        "inserted_at": "2024-05-31T15:51:57",
        "mergeable": true,
        "updated_at": "2024-05-31T16:05:56"
    }
}

Como anexar um documento?

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

Como anexar documentos em um contrato?

Updated 6 months ago