API – GeraFilaDocumentoFinanceiro

Introdução

Os Documentos originados do GERA via integração ensemble, são salvos na tabela de fila de processamento.

Tabela envolvida:
LX_FIN.FIN_INTEGRACAO_DOC_FINANCEIRO

Obs.: Necessário passar os cabeçalhos de autenticação, processo não descrito nesse documento.

Coloca documento financeiro na fila de processamento

…POST…
/api/Financeiro/EnfileirarDocumento

Parâmetros

Nome	Tipo	Descrição	Requerido
lstDocumcentos	Documento[]	Lista de documentos a serem enfileirados	Sim

TIPOS

Documentos

Nome	Tipo	Descrição	Requerido
IdLinx	int?	-	não
CodigoBandeiraCartao	string	-	sim
NumeroAprovacaoCartao	string	-	sim
CVCartao	string	-	sim
TaxaAdministracaoCartao	decimal?	-	não
IndicaTef	bool?	-	não
AlineaCheque	int?	-	não
CMC7	string	-	sim
ChequeBanco	string	-	sim
ChequeAgencia	string	-	sim
CodigoRedeCartao	string	-	sim
ChequeConta	string	-	sim
ChequeFavorecido	string	-	sim
ChequeFavorecidoCnpj	string	-	sim
IdContrato	int?	-	não
TipoPagamento	byte?	-	não
CodigoRegraCartao	string	-	sim
NumeroCartao	string	-	sim
DescricaoOperacao	string	-	sim
Observacao	string	-	sim
Chave_Hash	string	-	sim
NumeroDevolucoes	int?	-	não
IdAdmCartao	int?	-	não
TipoDocumento	byte?	-	não
ContaReceitaDespesa	string	-	sim
IdDocumento	int	-	sim
IdOperacaoFinalidade	int	-	sim
IdFilial	int?	-	não
CnpjFilial	string	-	sim
IdTeceiro	int?	-	não
CnpjTerceiro	string	-	sim
IdSacado	int?	-	não
CnpjSacado	string	-	sim
NumeroDocumento	string	-	sim
Fatura	string	-	sim
Serie	string	-	sim
DataEmissao	DateTime	-	sim
Vencimento	DateTime	-	sim
DataReferencia	DateTime	-	sim
Valor	decimal	-	sim
TaxaMulta	decimal?	-	não
TaxaJuros	decimal?	-	não
QtdeParcelas	int	-	sim
IdContaCaixaCorrente	int?	-	não
ContaCaixaCorrente	string	-	sim
IdContaReceitaDespesa	int?	-	não
DocumentoParcela_LISTA	DocumentoParcela[]	-	sim
DocumentoRateio_LISTA	DocumentoRateio[]	-	sim

DocumentoParcela

Nome	Tipo	Descrição	Requerido
SaldoAcrescimo	decimal?	-	não
SaldoJuros	decimal?	-	não
SaldoMulta	decimal?	-	não
SaldoDesconto	decimal?	-	não
DiasProrrogados	int?	-	não
PorcDescontoVencimento	decimal?	-	não
DataDescontoVencimento	DateTime?	-	não
ContaCaixaCorrente	string	-	sim
IdContaCaixaCorrente	int?	-	não
TaxaAdministracaoCartao	decimal?	-	não
Vencimento	DateTime	-	sim
Valor	decimal	-	sim
Parcela	string	-	sim
IdDocumento	int	-	sim
IdDocumentoParcela	int	-	sim
SeuNumero	string	-	sim

DocumentoRateio

Nome	Tipo	Descrição	Requerido
IdDocumentoRateio	int	-	sim
IdDocumento	int	-	sim
IdFilial	int?	-	não
CnpjFilial	string	-	sim
IdCentroResultado	int?	-	sim
CodigoCentroResultado	string	-	sim
DescCentroResultado	string	-	sim
DataReferencia	DateTime	-	sim
IdContaReceitaDespesa	int?	-	sim
ContaReceitaDespesa	string	-	sim
Valor	decimal	-	sim
Percentual	decimal?	-	sim

REQUEST

curl --location --request POST '{local_api}/api/Financeiro/EnfileirarDocumento' \

--header 'Content-Type: application/json' \

--header 'CurrentCompany: f27ffc4f-eb6e-4484-91ed-a318a4a394b0' \

--header 'AuthorizationToken: ba12947d-4b35-4c3f-b4b1-da54bf56f192' \

--header 'CurrentUser: 1445d056-d841-4d09-a9bf-ad50aa76ca6e' \

--header 'AccessGroup: 00000000-0000-0000-0000-000000000000' \

--header 'EconomicGroup: 057563a9-303c-40ab-a725-4a824cc71983' \

--header 'Environment: 190' \

--header 'Application: 2d606cc0-ea7e-470e-b535-23f3c7a29a18' \

--header 'Content-Type: text/plain' \

--data-raw ' [

{

"IdLinx": null,

"CodigoBandeiraCartao": null,

"NumeroAprovacaoCartao": null,

"CVCartao": null,

"TaxaAdministracaoCartao": null,

"IndicaTef": null,

"AlineaCheque": null,

"CMC7": null,

"ChequeBanco": null,

"ChequeAgencia": null,

"CodigoRedeCartao": null,

"ChequeConta": null,

"ChequeFavorecido": null,

"ChequeFavorecidoCnpj": null,

"IdContrato": null,

"TipoPagamento": null,

"CodigoRegraCartao": null,

"NumeroCartao": null,

"DescricaoOperacao": null,

"Observacao": null,

"Chave_Hash": null,

"NumeroDevolucoes": null,

"IdAdmCartao": null,

"TipoDocumento": null,

"ContaReceitaDespesa": null,

"IdDocumento": 0,

"IdOperacaoFinalidade": 0,

"IdFilial": null,

"CnpjFilial": null,

"IdTeceiro": null,

"CnpjTerceiro": null,

"IdSacado": null,

"CnpjSacado": null,

"NumeroDocumento": null,

"Fatura": null,

"Serie": null,

"DataEmissao": "0001-01-01T00:00:00",

"Vencimento": "0001-01-01T00:00:00",

"DataReferencia": "0001-01-01T00:00:00",

"Valor": 0.0,

"TaxaMulta": null,

"TaxaJuros": null,

"QtdeParcelas": 0,

"IdContaCaixaCorrente": null,

"ContaCaixaCorrente": null,

"IdContaReceitaDespesa": null,

"DocumentoParcela_LISTA": [

{

"SaldoAcrescimo": null,

"SaldoJuros": null,

"SaldoMulta": null,

"SaldoDesconto": null,

"DiasProrrogados": null,

"PorcDescontoVencimento": null,

"DataDescontoVencimento": null,

"ContaCaixaCorrente": null,

"IdContaCaixaCorrente": null,

"TaxaAdministracaoCartao": null,

"Vencimento": "0001-01-01T00:00:00",

"Valor": 0.0,

"Parcela": null,

"IdDocumento": 0,

"IdDocumentoParcela": 0,

"SeuNumero": null

}

],

"DocumentoRateio_LISTA": [

{

"IdDocumentoRateio": 0,

"IdDocumento": 0,

"IdFilial": null,

"CnpjFilial": null,

"IdCentroResultado": null,

"CodigoCentroResultado": null,

"DescCentroResultado": null,

"DataReferencia": "0001-01-01T00:00:00",

"IdContaReceitaDespesa": null,

"ContaReceitaDespesa": null,

"Valor": 0.0,

"Percentual": null

}

]

}

]'

RESPONSES

201 – Created

Nome

Tipo

Descrição

success

Boolean

Indica se houve falha não tratada durante a execução

message

String

Caso a execução não seja ok (success = false), retorna a descrição do erro ocorrido seja por falha de negócio ou de sistema

401 – UNAUTHORIZED
CONTEÚDO: VAZIO

CABEÇALHOS:

authorizationerror: Headers de autenticação inválidos.

400 – BAD REQUEST

Nome	Tipo	Descrição	Valor
success	Boolean	Indica se houve falha não tratada durante a execução	false
message	String	Descrição do erro ocorrido seja por falha de negócio ou de sistema
data			nulo

Árvore de páginas

Refatoração – Integração Financeira GERA-UX II

API – GeraFilaDocumentoFinanceiro

401 – UNAUTHORIZED CONTEÚDO: VAZIOCABEÇALHOS:

400 – BAD REQUEST

401 – UNAUTHORIZED
CONTEÚDO: VAZIO

CABEÇALHOS: