Retorna o Contrato de acordo com o id
Path: /api/v2/contratos/:id-contrato
Método: GET
Retorna informações do contrato de acordo com um id.
JSON Retornado (exemplo):
{
"id": 1,
"pasta": "0000000001",
"areaSolicitante": null,
"centrosCusto": [
{
"id": 1,
"nome": "Centro de custo - teste"
}
],
"empresa": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"solicitante": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"gestor": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"responsavel": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"fase": {
"id": 1,
"nome": "Inicial"
},
"subfase": {
"id": 2,
"nome": "Subfase inicial"
},
"dataSolicitacao": "2022-02-04T03:00:00.000+00:00",
"descricao": "teste",
"tipo": {
"id": 3,
"nome": "Adv. X Cliente"
},
"contratante": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"representanteContratante": null,
"contratada": {
"id": 3,
"nome": "A Definir"
},
"representanteContratada": null,
"numero": "0",
"cidade": {
"id": -2307,
"nome": "Palhoça"
},
"objeto": "",
"valor": 100,
"formaPagamento": {
"id": -1,
"nome": "À Vista"
},
"dataInicio": "2022-02-04T03:00:00.000+00:00",
"dataFim": "2022-11-14T03:00:00.000+00:00",
"vigenciaIntederminada": "Não",
"renovacaoAutomatica": "Sim",
"diasAvisoPrevio": null,
"equipes": [
{
"id": 1,
"nome": "Equipe - SC"
}
]
}
Listar contratos
Path: /api/v2/contratos
Método: GET
Parâmetros:
page (Texto)
size (Texto)
sort (Texto)
Exemplos: /api/v2/contratos?page=1&size=5&sort=pasta,desc
JSON de retorno (exemplo):
{
"content": [
{
"id": 1,
"pasta": "0000000001",
"centrosCusto": [
{
"id": 1,
"nome": "Centro de custo - teste"
}
],
"empresa": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"solicitante": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"gestor": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"responsavel": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"fase": {
"id": 1,
"nome": "Inicial"
},
"subfase": {
"id": 2,
"nome": "Subfase inicial"
},
"dataSolicitacao": "2022-02-04T03:00:00.000+00:00",
"descricao": "teste",
"tipo": {
"id": 3,
"nome": "Adv. X Cliente"
},
"contratante": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"contratada": {
"id": 3,
"nome": "A Definir"
},
"numero": "0",
"cidade": {
"id": -2307,
"nome": "Palhoça"
},
"valor": 100.0,
"formaPagamento": {
"id": -1,
"nome": "À Vista"
},
"dataInicio": "2022-02-04T03:00:00.000+00:00",
"dataFim": "2022-11-14T03:00:00.000+00:00",
"vigenciaIntederminada": "Não",
"renovacaoAutomatica": "Sim",
"equipes": [
{
"id": 1,
"nome": "Equipe - SC"
}
]
},
{
"id": 2,
"pasta": "0000000002",
"centrosCusto": [
{
"id": 1,
"nome": "Centro de custo - teste"
}
],
"empresa": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"solicitante": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"gestor": {
"id": 13,
"nome": "Rodrigo Arashida"
},
"responsavel": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"fase": {
"id": 1,
"nome": "Inicial"
},
"dataSolicitacao": "2022-02-25T03:00:00.000+00:00",
"descricao": "aaa",
"tipo": {
"id": 3,
"nome": "Adv. X Cliente"
},
"contratante": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"contratada": {
"id": 20,
"nome": "Aurum Software"
},
"cidade": {
"id": -579,
"nome": "São Paulo"
},
"valor": 0.0,
"dataInicio": "2022-02-25T03:00:00.000+00:00",
"dataFim": "2022-04-30T03:00:00.000+00:00",
"vigenciaIntederminada": "Não",
"renovacaoAutomatica": "Não",
"diasAvisoPrevio": 5,
"equipes": [
{
"id": 1,
"nome": "Equipe - SC"
},
{
"id": 2,
"nome": "Equipe - SP"
},
{
"id": 3,
"nome": "Equipe - RJ"
}
]
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"pageNumber": 0,
"pageSize": 25,
"offset": 0,
"paged": true,
"unpaged": false
},
"totalElements": 2,
"totalPages": 1,
"last": true,
"size": 25,
"number": 0,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"first": true,
"numberOfElements": 2,
"empty": false
}
Criar um contrato
Realiza o cadastro completo do contrato
Path: /api/v2/contratos
Método: POST
ParâmetroTipoDescrição
Parâmetro | Tipo | Descrição |
pasta | String (opcional) | Identificador da pasta
- Se a flag "Atualizar a numeração de pastas de casos automaticamente" estiver ativa, este campo é ignorado Faixa de tamanho: ≤ 250 caracteres |
idAreaSolicitante | Integer (obrigatório) | Identificador da área solicitante |
idsCentrosCusto | Integer[] (obrigatório) | Lista de identificadores dos centros de custo do contrato. Exemplo de preenchimento: [1,2,3] |
idEmpresa | Integer (obrigatório) | Identificador da empresa |
idSolicitante | Integer (obrigatório) | Identificador do solicitante |
idGestor | Integer (obrigatório) | Identificador do gestor |
idFase | Integer (obrigatório) | Identificador do responsável |
idSubfase | Integer (obrigatório) | Identificador da fase do contrato |
dataSolicitacao | Date (obrigatório) | Data de solicitação do contrato
Formato de preenchimento:
Exemplo de preenchimento: |
descricao | String (opcional) | Texto descritivo sobre a descrição do Contrato |
idTipo | Integer (obrigatório) | Identificador do tipo do contrato |
idContratante | Integer (obrigatório) | Identificador do contratante |
idRepresentanteContratante | Integer (opcional) | Identificador do representante contrantante |
idContratada | Integer (obrigatório) | Identificador da pessoa contratada |
idRepresentanteContratada | Integer (opcional) | Identificador do representante da contratada |
numeroContrato | String (opcional) | Número do contrato |
idCidade | Integer (obrigatório) | Identificador da cidade |
objeto | String (opcional) | Texto sobre o objeto do contrato |
valor | Double (opcional) | Valor do contrato |
idFormaPagamento | Integer (opcional) | Identificador da forma de pagamento do contrato |
dataInicio | Date (obrigatório) | Data do início do contrato
Formato de preenchimento:
Exemplo de preenchimento: |
dataFim | Date (opcional) | Data do início do contrato
Formato de preenchimento:
Exemplo de preenchimento: |
renovacaoAutomatica | String (obrigatório) | Indica se o contrato terá renovação automática (0 = Não, 1 = Sim)
Regras: Deve conter apenas os valores 0 ou 1 |
diasAvisoPrevio | Integer (opcional) | Indica com quantos dias de antecedência o aviso prévio será gerado |
idsEquipe | Integer[] (opcional/obrigatório) | Lista de identificadores das equipes a serem vinculadas.
Regras: O campo é obrigatório se a funcionalidade de "Equipes" estiver habilitada.
Exemplo de preenchimento: [1,2,3] |
BODY (json):
{
"pasta": "000000003",
"idAreaSolicitante": 1,
"idsCentrosCusto": [
1
],
"idEmpresa": 1,
"idSolicitante": 1,
"idGestor": 1,
"idResponsavel": 1,
"idFase": 5,
"idSubfase": 1,
"dataSolicitacao": "2024-06-26T18:42:30.581Z",
"descricao": "teste",
"idTipo": 1,
"idContratante": 1,
"idContratada": 1,
"idRepresentanteContratada": 1,
"numeroContrato": "123456",
"idCidade": -2436,
"objeto": "string",
"valor": 10.00,
"idFormaPagamento": -1,
"dataInicio": "2024-06-26T18:42:30.581Z",
"dataFim": "2024-06-26T18:42:30.581Z",
"renovacaoAutomatica": "0",
"diasAvisoPrevio": 0,
"idsEquipes": [1,2]
}
JSON (exemplo):
{
"id": 4515,
"pasta": "0000004505",
"areaSolicitante": {
"id": 1,
"nome": "Área solicitante - teste"
},
"centrosCusto": [
{
"id": 1,
"nome": "Centro de custo - teste"
}
],
"empresa": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"solicitante": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"gestor": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"responsavel": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"fase": {
"id": 1,
"nome": "Inicial"
},
"subfase": {
"id": 2,
"nome": "Subfase inicial"
},
"dataSolicitacao": "2024-06-26T18:42:30.581+00:00",
"descricao": "teste",
"tipo": {
"id": 1,
"nome": "Locação"
},
"contratante": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"contratada": {
"id": 21,
"nome": "Aurum Software Ltda"
},
"representanteContratada": {
"id": 7,
"nome": "Christian Dias"
},
"numero": "123456",
"cidade": {
"id": -2436,
"nome": "Apucarana"
},
"objeto": "string",
"valor": 10,
"formaPagamento": {
"id": -1,
"nome": "À Vista"
},
"dataInicio": "2024-06-26T18:42:30.581+00:00",
"dataFim": "2024-06-26T18:42:30.581+00:00",
"vigenciaIntederminada": "Não",
"renovacaoAutomatica": "Não",
"diasAvisoPrevio": 0,
"equipes": [
{
"id": 1,
"nome": "Equipe - SC"
},
{
"id": 2,
"nome": "Equipe - SP"
}
]
}Atualizar um contrato
Atualiza o Contrato identificado por id
Path: api/v2/contratos/:id
Método: PUT
Parâmetro | Tipo | Descrição |
pasta | String (opcional) | Identificador da pasta
- Se a flag "Atualizar a numeração de pastas de casos automaticamente" estiver ativa, este campo é ignorado Faixa de tamanho: ≤ 250 caracteres |
idAreaSolicitante | Integer (obrigatório) | Identificador da área solicitante |
idsCentrosCusto | Integer[] (obrigatório) | Lista de identificadores dos centros de custo do contrato. Exemplo de preenchimento: [1,2,3] |
idEmpresa | Integer (obrigatório) | Identificador da empresa |
idSolicitante | Integer (obrigatório) | Identificador do solicitante |
idGestor | Integer (obrigatório) | Identificador do gestor |
idFase | Integer (obrigatório) | Identificador do responsável |
idSubfase | Integer (obrigatório) | Identificador da fase do contrato |
dataSolicitacao | Date (obrigatório) | Data de solicitação do contrato
Formato de preenchimento:
Exemplo de preenchimento: |
descricao | String (opcional) | Texto descritivo sobre a descrição do Contrato |
idTipo | Integer (obrigatório) | Identificador do tipo do contrato |
idContratante | Integer (obrigatório) | Identificador do contratante |
idRepresentanteContratante | Integer (opcional) | Identificador do representante contrantante |
idContratada | Integer (obrigatório) | Identificador da pessoa contratada |
idRepresentanteContratada | Integer (opcional) | Identificador do representante da contratada |
numeroContrato | String (opcional) | Número do contrato |
idCidade | Integer (obrigatório) | Identificador da cidade |
objeto | String (opcional) | Texto sobre o objeto do contrato |
valor | Double (opcional) | Valor do contrato |
idFormaPagamento | Integer (opcional) | Identificador da forma de pagamento do contrato |
dataInicio | Date (obrigatório) | Data do início do contrato
Formato de preenchimento:
Exemplo de preenchimento: |
dataFim | Date (opcional) | Data do início do contrato
Formato de preenchimento:
Exemplo de preenchimento: |
renovacaoAutomatica | String (obrigatório) | Indica se o contrato terá renovação automática (0 = Não, 1 = Sim)
Regras: Deve conter apenas os valores 0 ou 1 |
diasAvisoPrevio | Integer (opcional) | Indica com quantos dias de antecedência o aviso prévio será gerado |
idsEquipe | Integer[] (opcional/obrigatório) | Lista de identificadores das equipes a serem vinculadas.
Regras: O campo é obrigatório se a funcionalidade de "Equipes" estiver habilitada.
Exemplo de preenchimento: [1,2,3] |
BODY (json):
{
"id": 81,
"pasta": "11111111117",
"idAreaSolicitante": 1,
"idsCentrosCusto": [
2
],
"idEmpresa": 1,
"idSolicitante": 1,
"idGestor": 1,
"idResponsavel": 1,
"idFase": 1,
"idSubfase": 11111111,
"dataSolicitacao": "2024-06-26T18:42:30.581Z",
"descricao": "teste",
"idTipo": 1,
"idContratante": 1,
"idContratada": 1,
"idRepresentanteContratada": 1,
"numeroContrato": "123456",
"idCidade": -2436,
"objeto": "string",
"valor": 10.00,
"idFormaPagamento": -1,
"dataInicio": "2024-06-26T18:42:30.581Z",
"dataFim": "2024-06-26T18:42:30.581Z",
"renovacaoAutomatica": "0",
"diasAvisoPrevio": 0,
"idsEquipes": [2,3]
}
JSON (exemplo):
{
"id": 4515,
"pasta": "0000004505",
"areaSolicitante": {
"id": 1,
"nome": "Área solicitante - teste"
},
"centrosCusto": [
{
"id": 1,
"nome": "Centro de custo - teste"
}
],
"empresa": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"solicitante": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"gestor": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"responsavel": {
"id": 4,
"nome": "Daniel Leandro de Almeida David"
},
"fase": {
"id": 1,
"nome": "Inicial"
},
"subfase": {
"id": 2,
"nome": "Subfase inicial"
},
"dataSolicitacao": "2024-06-26T18:42:30.581+00:00",
"descricao": "teste",
"tipo": {
"id": 1,
"nome": "Locação"
},
"contratante": {
"id": 5,
"nome": "Astrea Software Ltda"
},
"contratada": {
"id": 21,
"nome": "Aurum Software Ltda"
},
"representanteContratada": {
"id": 7,
"nome": "Christian Dias"
},
"numero": "123456",
"cidade": {
"id": -2436,
"nome": "Apucarana"
},
"objeto": "string",
"valor": 10,
"formaPagamento": {
"id": -1,
"nome": "À Vista"
},
"dataInicio": "2024-06-26T18:42:30.581+00:00",
"dataFim": "2024-06-26T18:42:30.581+00:00",
"vigenciaIntederminada": "Não",
"renovacaoAutomatica": "Não",
"diasAvisoPrevio": 0,
"equipes": [
{
"id": 1,
"nome": "Equipe - SC"
},
{
"id": 2,
"nome": "Equipe - SP"
}
]
}