Notas de Implementação:
Cria um pré-lançamento conforme o modelo e parâmetros informados. O pré-lançamento não se caracteriza como um lançamento do Cigam, sendo apenas uma prévia auxiliar. Para tornar o pré-lançamento um lançamento no Cigam, utilize o método de EfetivarPreLancamentoConformeModelo.
Informações de Envio:
Cabeçalhos de Envio:
| Parâmetro | Valor | Descrição | Tipo de parâmetro | Tipo de dados |
|---|---|---|---|---|
| Authorization | Bearer | Hash gerado no login | Header | String |
Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar
Direitos:
GFLANCTO_P
Itens de Menu:
CG07372,CG07373,CG00003
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| CodigoPreLancamento | integer |
Opcional |
|
| CodigoModelo | string |
Opcional |
|
| CodigoEmpresa | string |
Opcional |
|
| CodigoPortador | string |
Opcional |
|
| CodigoHistorico | string |
Opcional |
|
| CodigoUnidadeNegocio | string |
Opcional |
|
| CodigoContaFinanceira | string |
Opcional |
|
| Emissao | date |
Opcional |
|
| Vencimento | date |
Opcional |
|
| Complemento | string |
Opcional |
|
| Documento | string |
Opcional |
|
| Projeto | string |
Opcional |
|
| Tipo | string |
Opcional |
|
| Valor | decimal number |
Opcional |
|
| Previsao | boolean |
Opcional |
Formato de Envio:
application/json, text/json
Exemplo:
{
"CodigoPreLancamento": 1,
"CodigoModelo": "string 2",
"CodigoEmpresa": "string 3",
"CodigoPortador": "string 4",
"CodigoHistorico": "string 5",
"CodigoUnidadeNegocio": "string 6",
"CodigoContaFinanceira": "string 7",
"Emissao": "2026-01-13",
"Vencimento": "2026-01-13",
"Complemento": "string 8",
"Documento": "string 9",
"Projeto": "string 10",
"Tipo": "string 11",
"Valor": 12.1,
"Previsao": true
}
Informações de Retorno:
Cabeçalhos Adicionais:
| Nome | Descrição | Valor |
|---|---|---|
| cigam-api-version | Versão do build/compilação dessa versão da API | 2.1.8565.21067 |
Modelo:
| Nome | Descrição | Tipo | Informação Adicional |
|---|---|---|---|
| success | boolean |
Opcional |
|
| hash | string |
Opcional |
|
| messages | string |
Opcional |
|
| data | Object |
Opcional |
|
| tipoLogin | string |
Opcional |
Formato de Resposta:
Objeto JSON com o número do pré-lançamento criado.
| Código de status HTTP | Descrição | Modelo de resposta |
|---|---|---|
| 200 | OK |
application/json, text/json
Exemplo:
{
"success": true,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 400 | Requisição inválida |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 401 | Não autorizado |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 500 | Requisição falhou |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|
| 502 | Falha de comunicação |
application/json, text/json
Exemplo:
{
"success": false,
"hash": "string 2",
"messages": [
"string 1"
],
"data": {},
"tipoLogin": "string 4"
}
|