Plantonizei

Plataforma › Contratos com clientes

Contratos de todas as empresas

GET/api/v1/admin/contractsPede sessão

Como funciona

Os contratos de todas as empresas clientes, numa lista só: empresa, título, arquivo e a situação de cada um (enviado, assinado, distratado). É a visão de acompanhamento; o contrato de uma empresa se gerencia em Empresas clientes.

É da equipe interna e pede o módulo Contratos no papel de quem chama.

Respostas

200 · contracts: os contratos de todas as empresas.

  • contractsobject[] · Contratos.
  • contracts[].categorystring · Categoria.
  • contracts[].companyIdstring · Identificador da empresa.
  • contracts[].companyNamestring · Razão social da empresa.
  • contracts[].contactEmailstring · E-mail do contato.
  • contracts[].createdAtstring · Quando foi criado.
  • contracts[].fileNamestring · Nome do arquivo.
  • contracts[].idstring · Identificador do registro.
  • contracts[].sentForSignatureAtstring · Quando o contrato foi enviado para assinatura.
  • contracts[].sentForSignatureTostring · Para qual e-mail o contrato foi enviado.
  • contracts[].signedAtstring · Quando foi assinado.
  • contracts[].sizeinteger · Tamanho do arquivo, em bytes.
  • contracts[].statusstring · Situação.
  • contracts[].terminatedAtstring · Quando foi distratado.
  • contracts[].terminatedBystring · Quem registrou o distrato.
  • contracts[].terminationReasonstring · Motivo do distrato.
  • contracts[].titlestring · Título.
  • contracts[].typestring · Tipo.
  • contracts[].uploadedBystring · Quem enviou o arquivo.

Corpo de exemplo

{
  "contracts": [
    {
      "category": "texto",
      "companyId": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "companyName": "texto",
      "contactEmail": "medico@exemplo.com.br",
      "createdAt": "texto",
      "fileName": "texto",
      "id": "3f0c2a5e-9b1d-4c7e-8a21-6d0f5b7ca91e",
      "sentForSignatureAt": "texto",
      "sentForSignatureTo": "texto",
      "signedAt": "texto",
      "size": 1,
      "status": "texto",
      "terminatedAt": "texto",
      "terminatedBy": "texto",
      "terminationReason": "texto",
      "title": "texto",
      "type": "texto",
      "uploadedBy": "texto"
    }
  ]
}