Objetivo
A finalidade deste método é possibilitar a inclusão de lançamentos orçamentários.
Chamada
POST/api/v1/lancamentos
Informações para Requisição (Request Information)
{
"origem": "NFDESP",
"identificadorUnicoOrigem": "001",
"identificador": "12425",
"tipoConsumo": 2,
"dataSolicitacao": "2022-11-18",
"dataLancamento": "2022-11-18",
"solicitante": "Usuário da Silva",
"codUsuario": "USUARIO1"
"justificativa": "Necessário troca de equipamento queimado.",
"lancamentoValores": [
{
"empresaId": 1,
"contaContabil": 90101010001,
"centroResultado": 111101,
"valor": 100
},
{
"empresaId": 1,
"contaContabil": 90101010001,
"centroResultado": 111102,
"valor": 200
}
]
}
Parâmetros body
| Parâmetro | Tipo | Descrição | Valores |
|---|---|---|---|
| origem | string | Identificador do módulo de origem dentro do Gestão Orçamentária | - |
| identificadorUnicoOrigem | string | Identificador único que faz referência ao item no módulo de origem. | - |
| identificador | string | Identificador do lançamento no módulo origem. | - |
| tipoConsumo | int | Tipo de consumo que será realizado na Gestão Orçamentária. | 1 - Previsto; 2 - Realizado. |
| dataSolicitacao | date | Data da solicitação do lançamento. | - |
| dataLancamento | date | Data que será efetivado o lançamento. | - |
| solicitante | string | Nome do usuário solicitante. | - |
| codUsuario | string | Código do usuário solicitante. | - |
| justificativa | string | Justificativa para lançamento. | - |
| lancamentoValores | array | Lista contendo informações do lançamento de conta e centro. | - |
Parâmetros body: lancamentoValores
| Parâmetro | Tipo | Descrição | Valores |
|---|---|---|---|
| empresaId | long | Numero da empresa que irá receber o lançamento. | - |
| contaContabil | long | Numero da conta contábil que irá receber o lançamento. | - |
| centroResultado | long | Numero do centro de resultado que irá receber o lançamento. | - |
| valor | decimal | Valor do lançamento. | - |
Informações para Resposta (Response Information)
Descrição do Recurso (Resource Description)
Não há.
Formatos de Resposta (Response Formats)
| Código (Code) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| 201 | Created | Não há | Não há |
application/json, text/json
{
"id": 0,
"situacao": 0
}
Response
| Parâmetro | Tipo | Descrição | Valores |
|---|---|---|---|
| id | long | Identificador único do lançamento no Gestão Orçamentária | - |
| situacao | int | Situação do lançamento | 0 - Rejeitado; 1 - Efetivado; 2 - Aguardando aprovação de verba. |
| Código (Code) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| 400 | Bad Request | Não há | Propriedade code poderá apresentar o seguinte status: "Rejeitado sem verba" ou "Rejeitado sem justificativa" |
application/json, text/json
{
"code": "1",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"notificationType": 0,
"code": "string",
"message": "string",
"detailedMessage": "string",
"status": 0
}
]
}
Response
| Parâmetro | Tipo | Descrição | Valores |
|---|---|---|---|
| code | int | Código de falha | 1 - Conta/Centro não possui verba disponível; 2 - Não foi informado justificativa para estouro; 3 - Não foi encontrado nenhum registro; 4 - Não foi possível localizar um usuário aprovador; |
| message | string | Mensagem de erro | - |
| detailedMessage | string | Detalhamento do erro | - |
| helpUrl | string | Link para documentação de ajuda do erro | - |
| details | array | Lista de erros | - |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas