Mais pesquisados:Customização, Tutorial, Documentação

fato_financeiro

78 views 0 27/02/2020 Atualizado em 08/07/2024 integrador

2.0info: 1.68.0 fato_financeiro description: Serviço de fatos financeiros x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: fato_financeiro contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /fato_financeiro/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/queries/getFinancialBatchStatus: post: description: Returns the financial batch status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Financial Batch Identifier responses: 200: description: Ok schema: type: object required: – id – status properties: id: type: string description: Financial Batch Identifier status: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Financial Batch Status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns the financial batch status tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Financial Batch Identifier in: query required: true type: string responses: 200: description: Ok schema: type: object required: – id – status properties: id: type: string description: Financial Batch Identifier status: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Financial Batch Status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/queries/obterSituacaoLoteFinanceiro: post: description: Retorna a situação do lote financeiro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Identificador do lote financeiro responses: 200: description: Ok schema: type: object required: – situacao properties: situacao: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Situação do lote financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a situação do lote financeiro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: loteFinanceiroId description: Identificador do lote financeiro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – situacao properties: situacao: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Situação do lote financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/queries/obterComposicaoLoteFinanceiro: post: description: Retorna a composição de um lote financeiro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Identificador do lote financeiro responses: 200: description: Ok schema: type: object required: – composicaoLoteFinanceiro properties: composicaoLoteFinanceiro: type: object allOf: – #/definitions/recComposicaoLoteFinanceiro description: Composição de um lote financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a composição de um lote financeiro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: loteFinanceiroId description: Identificador do lote financeiro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – composicaoLoteFinanceiro properties: composicaoLoteFinanceiro: type: object allOf: – #/definitions/recComposicaoLoteFinanceiro description: Composição de um lote financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/queries/obterTiposFatoFinanceirosRetornoBancario: post: description: Retorna os tipos de fato do lote financeiro retorno bancário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Identificador do lote financeiro responses: 200: description: Ok schema: type: object required: – loteFinanceiroRetornoBancario properties: loteFinanceiroRetornoBancario: type: object allOf: – #/definitions/recLoteFinanceiroRetornoBancario description: Tipos fatos financeiros lote retorno bancário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os tipos de fato do lote financeiro retorno bancário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: loteFinanceiroId description: Identificador do lote financeiro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – loteFinanceiroRetornoBancario properties: loteFinanceiroRetornoBancario: type: object allOf: – #/definitions/recLoteFinanceiroRetornoBancario description: Tipos fatos financeiros lote retorno bancário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/queries/obterFatosFinanceirosRetornoBancario: post: description: Retorna a composição de um lote financeiro retorno bancário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteFinanceiroId – tipoFatoFinanceiro properties: loteFinanceiroId: type: string description: Identificador do lote financeiro tipoFatoFinanceiro: type: string description: Tipo fato financeiro responses: 200: description: Ok schema: type: object required: – fatosFinanceiros properties: fatosFinanceiros: type: array items: type: object allOf: – #/definitions/recFatosRetornoBancario minimum: 1 description: Fatos financeiros gerados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a composição de um lote financeiro retorno bancário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: loteFinanceiroId description: Identificador do lote financeiro in: query required: true type: string – name: tipoFatoFinanceiro description: Tipo fato financeiro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – fatosFinanceiros properties: fatosFinanceiros: type: array items: type: object allOf: – #/definitions/recFatosRetornoBancario minimum: 1 description: Fatos financeiros gerados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/actions/reprocessarLotesFinanceiros: post: description: Reprocessa lotes financeiros tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lotesFinanceirosId properties: lotesFinanceirosId: type: array items: type: string minimum: 1 description: Identificadores do lote financeiro responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Status do processo erros: type: array items: type: string description: Erros coletados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/actions/obterErrosLoteFinanceiro: post: description: Retorna os erros associados a um lote financeiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Identificador do lote financeiro responses: 200: description: Ok schema: type: object required: – status – tipo properties: status: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Status do lote (ERRO ou PENDENCIA) tipo: type: string description: Tipo do erro (Interno ou Validação) erros: type: array items: type: object allOf: – #/definitions/recErrosLoteFinanceiro description: Erros nos eventos assíncronos do lote financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/actions/baixarArquivoImportacaoExtratoBancario: post: description: Ação que retorna a url do arquivo para download tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lote_financeiro_id properties: lote_financeiro_id: type: string description: Lote fincaneiro gerado para busca da tabela e310arq responses: 200: description: Ok schema: type: object required: – arquivo – nomeDoArquivo properties: arquivo: type: string format: byte description: Arquivo da S3 nomeDoArquivo: type: string description: Nome do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/actions/excluirLoteFinanceiro: post: description: Ação que exclui toda composição de um lote financeiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: array items: type: string minimum: 1 description: Identificador dos lotes financeiros a serem excluídos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/actions/internoUpdateSitLoteV2: post: description: Signal para atualização de situação do lote financeiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lotes – situacao properties: lotes: type: array items: type: string minimum: 1 description: Identificadores dos lotes situacao: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Situação destino publicarFinalizacao: type: boolean description: Deve publicar eventos externos finalização? responses: 200: description: Ok schema: type: object required: – output properties: output: type: string description: Saída 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/signals/gerarLoteFinanceiroArquivoRemessaPagamentoEletronico: post: description: Gerar lote Financeiro para o Arquivo de Remessa de Pagamento Eletronico tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – arquivoRemessaDadosId – e501tcpId – callback properties: processId: type: string description: Identificador do processo de geração do arquivo de remessa arquivoRemessaDadosId: type: string description: Identificador do arquivo de remessa de dados e501tcpId: type: array items: type: string minimum: 1 description: Lista de Titulos para o Lote callback: type: object allOf: – #/definitions/callback description: Primitiva de retorno no final do processo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fato_financeiro/signals/excluirLoteFinanceiroPagamentoEletronico: post: description: Signal para excluir o lote financeiro pagamento Eletrônico tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – loteFinanceiroId properties: processId: type: string description: Processo AsyncCaller loteFinanceiroId: type: array items: type: string minimum: 1 description: Id do lote financeiro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fato_financeiro/signals/gerarLoteArquivoRetornoRemessa: post: description: Gerar lote retorno tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – processId – arquivoRetornoRemessaDadosId – titulosId – callback properties: processId: type: string description: Process id arquivoRetornoRemessaDadosId: type: string description: Id da entidade arquivo retorno remessa dados titulosId: type: array items: type: string minimum: 1 description: Lista de títulos do lote callback: type: object allOf: – #/definitions/callback description: Primitiva de callback responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fato_financeiro/events/processoLoteFinanceiroFinalizado: post: description: Evento disparado ao término do processo de geração do lote financeiro x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – loteFinanceiroId – situacao properties: loteFinanceiroId: type: string description: Identificador do lote financeiro situacao: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Situação do lote financeiro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fato_financeiro/events/exclusaoLoteFinanceiroFinalizado: post: description: Evento disparado ao término do processo de exclusão da composição do lote financeiro x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – loteFinanceiroId – situacao properties: loteFinanceiroId: type: string description: Identificador do lote financeiro situacao: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Situação do lote financeiro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fato_financeiro/events/excluirTitulosNotaFiscalEntradaProcessadoComSucesso: post: description: Evento de exclusão de títulos via nota fiscal processado com sucesso x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId – groupId properties: controlProcessId: type: string description: ticket groupId: type: string description: Agrupador responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fato_financeiro/events/excluirTitulosNotaFiscalEntradaProcessadoComErro: post: description: Evento de exclusão de títulos via nota fiscal processado com erro x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId – groupId – message – stackTrace properties: controlProcessId: type: string description: ticket groupId: type: string description: Agrupador message: type: string description: Mensagem de Erro stackTrace: type: string description: Stack de Erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/e070emp: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e070emp responses: 200: description: The created resource schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e070emp responses: 200: description: The created resource schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/e070emp/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e070emp responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e070emp responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/e070emp/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e070emp responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/fatoFinanceiro: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fatoFinanceiro responses: 200: description: The created resource schema: #/definitions/fatoFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/fatoFinanceiro responses: 200: description: The created resource schema: #/definitions/fatoFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/fatoFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/fatoFinanceiro/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fatoFinanceiro responses: 200: description: Ok schema: #/definitions/fatoFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/fatoFinanceiro responses: 200: description: Ok schema: #/definitions/fatoFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/fatoFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/fatoFinanceiro/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fatoFinanceiro responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/loteFinanceiro: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/loteFinanceiro responses: 200: description: The created resource schema: #/definitions/loteFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/loteFinanceiro responses: 200: description: The created resource schema: #/definitions/loteFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/loteFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/loteFinanceiro/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/loteFinanceiro responses: 200: description: Ok schema: #/definitions/loteFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/loteFinanceiro responses: 200: description: Ok schema: #/definitions/loteFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/loteFinanceiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fato_financeiro/entities/loteFinanceiro/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/loteFinanceiro responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumSitTit: description: Situação do título type: string enum: – VAO – VAN – VAA – VAB – VAC – VAE – VAI – VAJ – VAP – VAR – VAS – VAV – VAX – VCA – VCE – VCO – VLQ – VLC – VLI – VLM – VLO – VLP – VLS – VLV – VLX – VPE – VPB – VAZ enumTipPgt: description: Tipo de pagamento type: string enum: – VCA – VCC – VCH – VCP – VCS – VDB – VDC – VDF – VDS – VDJ – VDO – VDP – VDV – VEC – VFG – VGS – VIP – VLC – VOP – VPA – VPC – VPO – VPS – VPT – VTE – VTN – VTO – VTR – VOU enumPerFlu: description: Período type: string enum: – VD – VS – VQ – VM – VT – VR – VA enumOriMcc: description: Origem do movimento type: string enum: – VCR – VCP – VCM – VCH – VOU enumOriChe: description: Origem cheque type: string enum: – VCP – VCM – VCA – VFP – VCR – VDV enumTipCnc: description: Tipo type: string enum: – VA – VM enumSitReg: description: Situação do registro type: string enum: – VA – VI enumTipJrs: description: Tipo de juros type: string enum: – VS – VC enumSituacaoLoteFinanceiro: description: Situação do lote financeiro type: string enum: – PROCESSADO_SUCESSO – PROCESSADO_ERRO – EM_PROCESSAMENTO – EM_PROCESSAMENTO_NOTA_GUIA – PROCESSADO_ERRO_GUIA – PROCESSADO_COM_PENDENCIA – EXCLUIDO_SUCESSO – EXCLUIDO_ERRO – EM_EXCLUSAO – EXCLUIDO_COM_PENDENCIA enumSituacaoBanking: description: Status do PIX type: string enum: – NAO_ENVIADO – ENVIADO_GERACAO – RETORNADO_GERACAO – RETORNADO_PAGO – CANCELADO – ERRO enumOrigemLoteFinanceiro: description: Origem de um lote financeiro type: string enum: – COBRANCA_ESCRITURAL_REMESSA – COBRANCA_ESCRITURAL_RETORNO – BAIXA_MANUAL_CP_POR_SUBSTITUICAO – BAIXA_MANUAL_CP_POR_APROVEITAMENTO – BAIXA_MANUAL_CP_POR_COMPENSACAO – BAIXA_MANUAL_CP_POR_NEGOCIACAO – BAIXA_MANUAL_CP_POR_PAGAMENTO – BAIXA_MANUAL_CP_POR_CANCELAMENTO – BAIXA_MANUAL_CP_POR_ABATIMENTO – BAIXA_MANUAL_CP_POR_LUCROS_PERDAS – INCLUSAO_MANUAL_TESOURARIA – INCLUSAO_DUPLICATA_CP_TESOURARIA – INCLUSAO_DUPLICATA_CR_TESOURARIA – INCLUSAO_CREDITO_CP_TESOURARIA – INCLUSAO_CREDITO_CR_TESOURARIA – DEVOLUCAO_CREDITO_CP_TESOURARIA – DEVOLUCAO_CREDITO_CR_TESOURARIA – INCLUSAO_MANUAL_CP – INCLUSAO_MANUAL_CR – TRANSFERENCIA_MANUAL_TESOURARIA – BAIXA_MANUAL_CR_POR_NEGOCIACAO – BAIXA_MANUAL_CR_POR_SUBSTITUICAO – BAIXA_MANUAL_CR_POR_APROVEITAMENTO – BAIXA_MANUAL_CR_POR_RECEBIMENTO – BAIXA_MANUAL_CR_POR_CANCELAMENTO – BAIXA_MANUAL_CR_POR_ABATIMENTO – BAIXA_MANUAL_CR_POR_LUCROS_PERDAS – BAIXA_MANUAL_CR_POR_PAGAMENTO – OUTROS_MANUAL_TESOURARIA – INCLUSAO_NOTA_FISCAL_ENTRADA – INCLUSAO_NOTA_FISCAL_SAIDA – INCLUSAO_VIA_DDA – ATUALIZACAO_TITULO_CR – ATUALIZACAO_TITULO_CP – INCLUSAO_GUIA_RECOLHIMENTO – CONCILIACAO_BANCARIA – IMPORTACAO_EXTRATO_BANCARIO – INCLUSAO_COMISSAO – ATUALIZACAO_TITULO_DDA – ARQUIVO_REMESSA_PAGAMENTO_ELETRONICO – ARQUIVO_REMESSA_RETORNO_PAGAMENTO_ELETRONICO – BAIXA_AUTOMATICA_CP_POR_PAGAMENTO – BAIXA_AUTOMATICA_CR_POR_PAGAMENTO_COB_ELETRONICA enumTipoFatoFinanceiro: description: Tipo do fato financeiro gerado type: string enum: – COBRANCA_ESCRITURAL_REMESSA_TITULO – COBRANCA_ESCRITURAL_REMESSA_INSTRUCAO – COBRANCA_ESCRITURAL_RETORNO – COBRANCA_ESCRITURAL_RETORNO_COM_ERRO – COBRANCA_ESCRITURAL_RETORNO_TARIFA – COBRANCA_ESCRITURAL_RETORNO_JA_PROCESSADO – ENTRADA – ENTRADA_IMPOSTO – BAIXA_POR_PAGAMENTO – BAIXA_POR_APROVEITAMENTO – BAIXA_POR_SUBSTITUICAO – BAIXA_POR_COMPENSACAO – BAIXA_POR_ABATIMENTO – BAIXA_POR_CANCELAMENTO – BAIXA_POR_LUCROS_PERDAS – BAIXA_POR_SOBRA – TRANSFERENCIA_DEBITO_CHEQUE – TRANSFERENCIA_DEBITO_AVISO – TRANSFERENCIA_CHEQUE_TRANSFERENCIA – TRANSFERENCIA_OUTROS_DEBITOS – OUTROS_AVULSO_DEBITO_CHEQUE – OUTROS_AVULSO_DEBITO_AVISO – OUTROS_AVULSO_CHEQUE_TRANSFERENCIA – OUTROS_AVULSO_DEBITOS – BAIXA_POR_DEVOLUCAO – ATUALIZACAO_TITULO – MOVIMENTO_X_EXTRATO – MOVIMENTO_X_MOVIMENTO – EXTRATO_X_EXTRATO – IMPORTACAO_EXTRATO_BANCARIO – ARQUIVO_REMESSA_PAGAMENTO_ELETRONICO – ARQUIVO_RETORNO_REMESSA_PAGAMENTO_ELETRONICO enumTipTcc: description: Tipo da conta corrente type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 enumDebCre: description: Tipo de pagamento type: string enum: – VD – VC enumTipoSideBar: description: Tipo de side bar para ser exibido no front end type: string enum: – BAIXA_DUPLICATA_CP – BAIXA_DUPLICATA_CR – BAIXA_CREDITO_CP – BAIXA_CREDITO_CR – ENTRADA_DUPLICATA_CP – ENTRADA_DUPLICATA_CR – ENTRADA_CREDITO_CP – ENTRADA_CREDITO_CR – MOVIMENTO_TESOURARIA – PREPARACAO_TESOURARIA – REMESSA_INSTRUCAO – REMESSA_TITULO – TITULO_REMESSA – EXTRATO_BANCARIO – EXTRATO_BANCARIO_CONCILIADO – MOVIMENTO_TESOURARIA_CONCILIADO – RETORNO_BANCARIO_ERRO – RETORNO_BANCARIO_TARIFA – RETORNO_BANCARIO_SUCESSO – RETORNO_BANCARIO_JA_PROCESSADO – MOVIMENTO_TESOURARIA_DEBITO – MOVIMENTO_TESOURARIA_CREDITO enumTipItb: description: Tipo instrução type: string enum: – VA – VM enumOrigemLoteConciliacao: description: Indicativo como ocorreu a conciliação type: string enum: – CONCILIACAO_MANUAL – CONCILIACAO_POR_REGRA_DATA_DOCUMENTO_VALOR – CONCILIACAO_POR_REGRA_DATA_VALOR – CONCILIACAO_POR_REGRA_DOCUMENTO_VALOR – CONCILIACAO_POR_REGRA_MOVIMENTO_ESTORNADO – CONCILIACAO_POR_REGRA_EXTRATO_ESTORNADO enumTipTrb: description: Tipo de transação bancária type: string enum: – VC – VD – VO enumTipHis: description: Tipo histórico type: string enum: – VB – VT – VI – VR – VP – VC enumImpostos: description: Impostos calculados durante uma baixa type: string enum: – ISS_RETIDO – PIS_RETIDO – COFINS_RETIDO – CSLL – IRRF userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT recErrosLoteFinanceiro: description: Record de erros do lote financeiro relacionados aos eventos assíncronos type: object required: – processo – situacao – mensagem – dataInicial – dataFinal properties: processo: type: string description: Processo em que ocorreu o erro situacao: type: string description: Situação atual do processo mensagem: type: string description: Mensagem de erro dataInicial: type: string format: date-time description: Data e hora do início do processo dataFinal: type: string format: date-time description: Data e hora do término do processo checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recErroExclusaoLoteFinanceiro: description: Estrutura para retorno dos erros por lote financeiro type: object required: – loteFinanceiroId – errors properties: loteFinanceiroId: type: string description: Identificador do lote financeiro errors: type: array items: type: string minimum: 1 description: Listagem dos erros encontratos (consistências, problemas…) recGenerico: description: Record para retorno das informações principais de uma entidade type: object required: – id – label – codigo – descricao properties: id: type: string description: Identificador da entidade label: type: string description: Descrição do label codigo: type: string description: Código de negócio descricao: type: string description: Descrição de negócio recMoeda: description: Informações da moeda type: object required: – moeda – cotacaoEmissao properties: moeda: type: object allOf: – #/definitions/recGenerico description: Moeda cotacaoEmissao: type: string description: Cotação de emissão de um título cotacaoPagamento: type: string description: Cotação de pagamento de um título recComposicaoLoteFinanceiro: description: Lote financeiro type: object required: – id – situacao – lote – origem – dataMovimento – usuarioGeracao – dataGeracao – fatosFinanceiros properties: id: type: string description: Identificador do lote financeiro situacao: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Situação do lote financeiro lote: type: string description: Código do lote financeiro origem: type: string allOf: – #/definitions/enumOrigemLoteFinanceiro description: Origem do lote financeiro dataMovimento: type: string format: date description: Data de movimento do lote financeiro usuarioGeracao: type: string description: Usuário que gerou a baixa dataGeracao: type: string format: date-time description: Data de geração fatosFinanceiros: type: array items: type: object allOf: – #/definitions/recFatoFinanceiro minimum: 1 description: Fatos financeiros gerados recFatoFinanceiro: description: Informações do fato financeiro type: object required: – id – sequencia – tipoFato – descricaoFatoUtilizado properties: id: type: string description: Identificador do fato financeiro sequencia: type: integer format: int64 description: Sequência de processamento do fato financeiro tipoFato: type: string allOf: – #/definitions/enumTipoFatoFinanceiro description: Tipo do fato financeiro gerado descricaoFatoUtilizado: type: string description: Nome da lista de fatos que está preenchida fatosEntradaManualTituloPagar: type: array items: type: object allOf: – #/definitions/recFatoEntradaManualTituloPagar description: Fato financeiro referente a uma entrada manual de título no contas a pagar fatosEntradaManualTituloReceber: type: array items: type: object allOf: – #/definitions/recFatoEntradaManualTituloReceber description: Fato financeiro referente a uma entrada manual de título no contas a receber fatosEntradaManualTesouraria: type: array items: type: object allOf: – #/definitions/recFatoEntradaManualTesouraria description: Fato financeiro referente a uma entrada manual na tesouraria fatosPagamentoContasPagar: type: array items: type: object allOf: – #/definitions/recFatoPagamentoPagar description: Fato financeiro referente a baixa por pagamento no contas a pagar fatosPagamentoContasReceber: type: array items: type: object allOf: – #/definitions/recFatoPagamentoReceber description: Fato financeiro referente a baixa por pagamento no contas a receber fatosAproveitamentoContasPagar: type: array items: type: object allOf: – #/definitions/recFatoAproveitamentoPagar description: Fato financeiro referente a uma baixa por aproveitamento de títulos a pagar fatosAproveitamentoContasReceber: type: array items: type: object allOf: – #/definitions/recFatoAproveitamentoReceber description: Fato financeiro referente a uma baixa por aproveitamento de títulos a receber fatosSubstituicaoPagar: type: array items: type: object allOf: – #/definitions/recFatoSubstituicaoPagar description: Fato financeiro referente a uma baixa por substituição de títulos a pagar fatosSubstituicaoReceber: type: array items: type: object allOf: – #/definitions/recFatoSubstituicaoReceber description: Fato financeiro referente a uma baixa por substituição de títulos a receber fatosCompensacao: type: array items: type: object allOf: – #/definitions/recFatoCompensacao description: Fato financeiro referente a uma baixa por compensação entre títulos a pagar e a receber fatoTransferenciaEntreContasInternas: type: array items: type: object allOf: – #/definitions/recFatoTransferenciaEntreContasInternas description: Fato financeiro referente a uma transferencia entre contas internas fatosBaixaIndividualContasPagar: type: array items: type: object allOf: – #/definitions/recFatoBaixaIndividualContasPagar description: Fato financeiro referente a baixas individuais do contas a pagar (abatimento, cancelamento, lucros/perdas) fatosBaixaIndividualContasReceber: type: array items: type: object allOf: – #/definitions/recFatoBaixaIndividualContasReceber description: Fato financeiro referente a baixas individuais do contas a receber (abatimento, cancelamento, lucros/perdas) fatosCreditoFornecedorTesouraria: type: array items: type: object allOf: – #/definitions/recFatosCreditoDuplicataFornecedor description: Fato financeiro referente a uma inclusão de crédito para fornecedor via tesouraria fatosCreditoClienteTesouraria: type: array items: type: object allOf: – #/definitions/recFatosCreditoDuplicataCliente description: Fato financeiro referente a uma inclusão de crédito para cliente via tesouraria fatosDuplicataFornecedorTesouraria: type: array items: type: object allOf: – #/definitions/recFatosCreditoDuplicataFornecedor description: Fato financeiro referente a uma inclusão de duplicata para fornecedor via tesouraria fatosDuplicataClienteTesouraria: type: array items: type: object allOf: – #/definitions/recFatosCreditoDuplicataCliente description: Fato financeiro referente a uma inclusão de duplicata para cliente via tesouraria fatosDevolucaoCreditoFornecedor: type: array items: type: object allOf: – #/definitions/recFatoDevolucaoCreditoFornecedor description: Fato financeiro referente a uma baixa por devolução de créditos a fornecedor fatosDevolucaoCreditoCliente: type: array items: type: object allOf: – #/definitions/recFatoDevolucaoCreditoCliente description: Fato financeiro referente a uma baixa por devolução de créditos a cliente fatosOutrosTesouraria: type: array items: type: object allOf: – #/definitions/recFatoOutrosTesouraria description: Fato financeiro referente a um cheque/aviso avulso fatosSobraContasReceber: type: array items: type: object allOf: – #/definitions/recFatoSobraContasReceber description: Fato financeiro referente a troco/sobra do contas a receber fatosInstrucaoBancaria: type: array items: type: object allOf: – #/definitions/recFatoInstrucaoBancaria description: Fato financeiro referente a instrução bancária fatosConciliacaoBancaria: type: array items: type: object allOf: – #/definitions/recFatoConciliacaoBancaria description: Fato financeiro referente a conciliação bancária fatosRetornoBancario: type: object allOf: – #/definitions/recFatosRetornoBancario description: Fato financeiro referente a retorno bancário fatosImportacaoExtratoBancario: type: array items: type: object allOf: – #/definitions/recFatoImportacaoExtratoBancario description: Fato financeiro referente a conciliação bancária fatosPagamentoEletronico: type: array items: type: object allOf: – #/definitions/recPagamentoEletronico description: Fatos pagamento eletrônico recFatoPagamentoPagar: description: Informações de um fato financeiro de uma baixa por pagamento no contas a pagar type: object required: – sideBars – movimentoDuplicata – movimentoTesouraria properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicata: type: array items: type: object allOf: – #/definitions/recMovimentoPagar minimum: 1 description: Movimento de baixa da duplicata movimentoTesouraria: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de débito realizado na tesouraria movimentoCreditoTesouraria: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de crédito realizado na tesouraria recFatoPagamentoReceber: description: Informações de um fato financeiro de uma baixa por pagamento no contas a receber type: object required: – sideBars – movimentoDuplicata – movimentoTesouraria – movimentoTesourariaDebito properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicata: type: array items: type: object allOf: – #/definitions/recMovimentoReceber minimum: 1 description: Movimento de baixa da duplicata movimentoTesouraria: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de crédito realizado na tesouraria movimentoTesourariaDebito: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de débito realizado na tesouraria (Imposto retido) titulosCreditos: type: array items: type: object allOf: – #/definitions/recTituloContasReceber description: Títulos de créditos gerados referente a sobra titulosPagarDevolucao: type: array items: type: object allOf: – #/definitions/recTituloContasPagar description: Títulos a pagar referente a devolução movimentosTituloPagarDevolucao: type: array items: type: object allOf: – #/definitions/recMovimentoPagar description: Movimento de baixa do título a pagar referente a devolução movimentosTesourariaDevolucao: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria description: Movimento gerado pela baixa do título a pagar de uma devolução recFatoAproveitamentoPagar: description: Informações de um fato financeiro de uma baixa por aproveitamento a pagar type: object required: – sideBars – movimentoDuplicata – movimentoCredito properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicata: type: array items: type: object allOf: – #/definitions/recMovimentoPagar minimum: 1 description: Movimento de baixa da duplicata movimentoCredito: type: array items: type: object allOf: – #/definitions/recMovimentoPagar minimum: 1 description: Movimento de baixa do crédito recFatoAproveitamentoReceber: description: Informações de um fato financeiro de uma baixa por aproveitamento a receber type: object required: – sideBars – movimentoDuplicata – movimentoCredito properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicata: type: array items: type: object allOf: – #/definitions/recMovimentoReceber minimum: 1 description: Movimento de baixa da duplicata movimentoCredito: type: array items: type: object allOf: – #/definitions/recMovimentoReceber minimum: 1 description: Movimento de baixa do crédito recFatoEntradaManualTituloPagar: description: Informações referente a entrada de título manualmente a pagar type: object required: – sideBars – titulos properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos titulos: type: array items: type: object allOf: – #/definitions/recTituloContasPagar minimum: 1 description: Títulos a pagar gerados manualmente recFatoEntradaManualTituloReceber: description: Informações referente a entrada de título manualmente a receber type: object required: – sideBars – titulos properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos titulos: type: array items: type: object allOf: – #/definitions/recTituloContasReceber minimum: 1 description: Títulos a receber gerados manualmente recFatoEntradaManualTesouraria: description: Informações referente a entrada de título manualmente a receber type: object required: – sideBars – movimentos properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentos: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria minimum: 1 description: Entrada manual tesouraria recFatoSubstituicaoPagar: description: Informações de um fato financeiro de uma baixa por substituição a pagar type: object required: – sideBars – movimentoDuplicata – titulosSubstitutos properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicata: type: array items: type: object allOf: – #/definitions/recMovimentoPagar minimum: 1 description: Movimento de baixa da duplicata titulosSubstitutos: type: array items: type: object allOf: – #/definitions/recTituloContasPagar minimum: 1 description: Novos títulos recFatoSubstituicaoReceber: description: Informações de um fato financeiro de uma baixa por substituição a receber type: object required: – sideBars – movimentoDuplicata – titulosSubstitutos properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicata: type: array items: type: object allOf: – #/definitions/recMovimentoReceber minimum: 1 description: Movimento de baixa da duplicata titulosSubstitutos: type: array items: type: object allOf: – #/definitions/recTituloContasReceber minimum: 1 description: Novos títulos titulosCreditos: type: array items: type: object allOf: – #/definitions/recTituloContasReceber description: Títulos de créditos gerados referente a sobra titulosPagarDevolucao: type: array items: type: object allOf: – #/definitions/recTituloContasPagar description: Títulos a pagar referente a devolução movimentosTituloPagarDevolucao: type: array items: type: object allOf: – #/definitions/recMovimentoPagar description: Movimento de baixa do título a pagar referente a devolução movimentosTesourariaDevolucao: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria description: Movimento gerado pela baixa do título a pagar de uma devolução recFatoCompensacao: description: Informações de um fato financeiro de uma baixa por compensação type: object required: – sideBars – movimentoDuplicataPagar – movimentoDuplicataReceber properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicataPagar: type: array items: type: object allOf: – #/definitions/recMovimentoPagar minimum: 1 description: Movimento de baixa da duplicata a pagar movimentoDuplicataReceber: type: array items: type: object allOf: – #/definitions/recMovimentoReceber minimum: 1 description: Movimento de baixa da duplicata a receber recFatoTransferenciaEntreContasInternas: description: Informações de um fato financeiro de uma transferência entre contas internas type: object required: – sideBars – movimentoOrigem – movimentosDestinos properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoOrigem: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento origem da transferência movimentosDestinos: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria minimum: 1 description: Informação dos movimentos destinos de uma transferência recFatosCreditoDuplicataFornecedor: description: Informações da inclusão de créditos/duplicatas a fornecedor via tesouraria type: object required: – sideBars – movimento – titulos properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimento: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de débito/crédito realizado na tesouraria titulos: type: array items: type: object allOf: – #/definitions/recTituloContasPagar minimum: 1 description: Títulos de créditos/duplicatas gerados recFatosCreditoDuplicataCliente: description: Informações da inclusão de créditos/duplicatas a cliente via tesouraria type: object required: – sideBars – movimento – movimentoCredito properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimento: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de débito/crédito realizado na tesouraria movimentoCredito: type: array items: type: object allOf: – #/definitions/recMovimentoReceber minimum: 1 description: Títulos de créditos/duplicatas gerados recFatoDevolucaoCreditoFornecedor: description: Informações de um fato financeiro de uma baixa por devolução de crédito a fornecedor type: object required: – sideBars – movimento – movimentoCredito properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimento: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de crédito realizado na tesouraria movimentoCredito: type: array items: type: object allOf: – #/definitions/recMovimentoPagar minimum: 1 description: Movimento de baixa do crédito recFatoDevolucaoCreditoCliente: description: Informações de um fato financeiro de uma baixa por devolução de crédito a cliente type: object required: – sideBars – movimento – movimentoCredito properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimento: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de crédito realizado na tesouraria movimentoCredito: type: array items: type: object allOf: – #/definitions/recMovimentoReceber minimum: 1 description: Movimento de baixa do crédito recFatoOutrosTesouraria: description: Informações referente a um cheque/aviso avulso type: object required: – sideBars – preparacao – movimento properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos preparacao: type: object allOf: – #/definitions/recPreparacaoTesouraria description: Informação da preparação movimento: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento realizado na tesouraria recFatoSobraContasReceber: description: Informações da sobra do contas a receber type: object required: – sideBars properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos titulosCreditos: type: array items: type: object allOf: – #/definitions/recTituloContasReceber description: Títulos de créditos gerados referente a sobra titulosSubstitutos: type: array items: type: object allOf: – #/definitions/recTituloContasReceber description: Títulos de substitutos gerados referente a sobra titulosPagarDevolucao: type: array items: type: object allOf: – #/definitions/recTituloContasPagar description: Títulos a pagar referente a devolução movimentosTesourariaCreditos: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria description: Movimento tesouraria créditos movimentosPagarAbatidos: type: array items: type: object allOf: – #/definitions/recMovimentoPagar description: Títulos a pagar (duplicatas) que foram abatidos movimentosReceberAbatidos: type: array items: type: object allOf: – #/definitions/recMovimentoReceber description: Títulos a receber (créditos) que foram abatidos movimentosTituloPagarDevolucao: type: array items: type: object allOf: – #/definitions/recMovimentoPagar description: Movimento de baixa do título a pagar referente a devolução movimentosTesourariaDevolucao: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria description: Movimento gerado pela baixa do título a pagar de uma devolução recMovimentoPagar: description: Movimento de um título a pagar type: object required: – titulo – movimento properties: titulo: type: object allOf: – #/definitions/recTituloContasPagar description: Informação do título movimento: type: object allOf: – #/definitions/recMovimento description: Informação do movimento recFatoBaixaIndividualContasPagar: description: Informações da baixa individual do contas a pagar type: object required: – sideBars – movimentoDuplicata properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicata: type: array items: type: object allOf: – #/definitions/recMovimentoPagar minimum: 1 description: Informações da baixa recSideBar: description: Faz a relação dos moviemntos de cada tipo de fato com os side bars para visualização type: object required: – nomeLista – nomeAba – tipoSideBar properties: nomeLista: type: string description: Nome da variável do output nomeAba: type: string description: Nome que deve ser utilizado para exibir a aba que contem os movimentos dessa lista tipoSideBar: type: string allOf: – #/definitions/enumTipoSideBar description: Tipo de sidebar recMovimentoReceber: description: Movimento de um título a receber type: object required: – titulo – movimento properties: titulo: type: object allOf: – #/definitions/recTituloContasReceber description: Informação do título movimento: type: object allOf: – #/definitions/recInformacaoMovimentoReceber description: Informação do movimento recFatoBaixaIndividualContasReceber: description: Informações da baixa individual do contas a receber type: object required: – sideBars – movimentoDuplicata properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoDuplicata: type: object allOf: – #/definitions/recMovimentoReceber description: Informações da baixa recMovimento: description: Informações da baixa de algum título discriminator: _discriminator type: object required: – id – transacaoBaixa – dataMovimento – dataPagamento – moeda – informacoesAdicionaisMovimento – valores – _discriminator properties: id: type: string description: Identificador da baixa transacaoBaixa: type: object allOf: – #/definitions/recGenerico description: Transação de baixa dataMovimento: type: string format: date description: Data do movimento dataPagamento: type: string format: date description: Data de pagamento do movimento moeda: type: object allOf: – #/definitions/recMoeda description: Moeda informacoesAdicionaisMovimento: type: object allOf: – #/definitions/recInformacoesAdicionaisMovimento description: Informações complementares do movimento de baixa valores: type: object allOf: – #/definitions/recValoresMovimentoBaixa description: Valores referente a baixa de títulos _discriminator: type: string description: recInformacoesAdicionaisMovimento: description: Informações complementares do movimento de baixa type: object required: – numeroDocumento – portador – carteira properties: diasAtraso: type: integer format: int64 description: Quantidade de dias de atraso diasJuros: type: integer format: int64 description: Quantidade de dias de juros observacao: type: string description: Observação do movimento numeroDocumento: type: string description: Número de documento formaPagamento: type: object allOf: – #/definitions/recGenerico description: Forma Pagamento portador: type: object allOf: – #/definitions/recGenerico description: Portador carteira: type: object allOf: – #/definitions/recGenerico description: Carteira loteContabil: type: integer format: int64 description: Número do lote contábil rateio: type: object allOf: – #/definitions/recRateio description: Informações rateio usuarioGerador: type: string description: Usuário que realizou o movimento dataGeracao: type: string format: date-time description: Data/Hora da geração do movimento usuarioAlteracao: type: string description: Usuário que realizou o movimento dataAlteracao: type: string format: date-time description: Data/Hora da geração do movimento recInformacaoMovimentoReceber: description: Informações do movimento do título a pagar allOf: – #/definitions/recMovimento – type: object properties: formulaReajuste: type: object allOf: – #/definitions/recGenerico description: Fórmula de reajuste cotacaoReajuste: type: string description: Cotacao da formula de reajuste recValoresMovimentoBaixa: description: Valores do movimento de baixa type: object required: – valorMovimento – valorLiquido properties: valorMovimento: type: string description: Valor Movimento valorJuros: type: string description: Valor Juros valorMulta: type: string description: Valor Multa valorDesconto: type: string description: Valor Desconto valorCorrecao: type: string description: Valor Correção Monetária valorEncargos: type: string description: Valor Encargos/Correção valorOutrosAcrescimos: type: string description: Valor Outros Acréscimos valorOutrosDescontos: type: string description: Valor Outros Descontos impostos: type: array items: type: object allOf: – #/definitions/recImpostos description: Valores referente a impostos valorLiquido: type: string description: Valor Líquido recImpostos: description: Valores de impostos calculados durante uma baixa type: object required: – id – tipoImposto – base – valor – aliquota properties: id: type: string description: Identificação do registro tipoImposto: type: string allOf: – #/definitions/enumImpostos description: Tipo do imposto base: type: string description: Base de cálculo valor: type: string description: Valor retido aliquota: type: number format: double description: Alíquota do imposto recTituloFinanceiro: description: Dados do título financeiro (pagar/receber) discriminator: _discriminator type: object required: – id – empresa – filial – pessoa – numeroTitulo – tipoTitulo – transacaoEntrada – dataEmissao – dataEntrada – vencimentoOriginal – provavelPagamento – situacaoTitulo – valorOriginal – moeda – movimentoEntrada – _discriminator properties: id: type: string description: Identificador do título empresa: type: object allOf: – #/definitions/recGenerico description: Identificador da empresa filial: type: object allOf: – #/definitions/recGenerico description: Identificador da filial pessoa: type: object allOf: – #/definitions/recGenerico description: Identificador do fornecedor/cliente numeroTitulo: type: string maxLength: 15 description: Nº Título tipoTitulo: type: object allOf: – #/definitions/recGenerico description: Identificador do tipo de título transacaoEntrada: type: object allOf: – #/definitions/recGenerico description: Identificador da transação de entrada do título dataEmissao: type: string format: date description: Data Emissão dataEntrada: type: string format: date description: Data Entrada vencimentoOriginal: type: string format: date description: Vencimento Original vencimentoProrrogado: type: string format: date description: Vencimento Prorrogado/Juros provavelPagamento: type: string format: date description: Data Provável Pagamento situacaoTitulo: type: string allOf: – #/definitions/enumSitTit description: Situação do título valorOriginal: type: string description: Valor Original minimum: 0.00 maximum: 9999999999999.99 valorAberto: type: string description: Valor aberto minimum: 0.00 maximum: 9999999999999.99 moeda: type: object allOf: – #/definitions/recMoeda description: Moeda do título rateio: type: object allOf: – #/definitions/recRateio description: Rateio juros: type: object allOf: – #/definitions/recJuros description: Dados para juros multa: type: object allOf: – #/definitions/recMulta description: Dados para multa valoresNegociados: type: object allOf: – #/definitions/recValoresNegociados description: Dados negociados credito: type: boolean description: Título é de crédito usuarioGerador: type: string description: Usuário que realizou o movimento dataGeracao: type: string format: date-time description: Data/Hora da geração do movimento usuarioAlteracao: type: string description: Usuário que realizou o movimento dataAlteracao: type: string format: date-time description: Data/Hora da geração do movimento movimentoEntrada: type: string description: Movimento de criação do título numArb: type: integer format: int64 description: Número da remessa _discriminator: type: string description: recInformacoesAdicionaisTitulo: description: Indicativo das informações adicionados do título discriminator: _discriminator type: object required: – origem – portador – carteira – _discriminator properties: origem: type: object allOf: – #/definitions/recOrigemTitulo description: Origem do título observacao: type: string maxLength: 250 description: Observação naturezaGasto: type: object allOf: – #/definitions/recGenerico description: Natureza Gasto grupoContas: type: object allOf: – #/definitions/recGenerico description: Grupo Contas formaPagamento: type: object allOf: – #/definitions/recGenerico description: Forma Pagamento portador: type: object allOf: – #/definitions/recGenerico description: Portador carteira: type: object allOf: – #/definitions/recGenerico description: Carteira codigoBarras: type: string maxLength: 50 description: Código Barra e600ccoSugestaoTitulo: type: object allOf: – #/definitions/recGenerico description: Sugestão Conta interna _discriminator: type: string description: recTituloContasPagar: description: Título a pagar allOf: – #/definitions/recTituloFinanceiro – type: object required: – informacoesAdicionais properties: descontos: type: object allOf: – #/definitions/recDescontos description: Dados para descontos do título a pagar informacoesAdicionais: type: object allOf: – #/definitions/recInformacoesAdicionaisTituloPagar description: Informações adicionais do título a pagar recTituloContasReceber: description: Título a receber allOf: – #/definitions/recTituloFinanceiro – type: object required: – informacoesAdicionais properties: descontos: type: object allOf: – #/definitions/recDescontosReceber description: Dados para descontos do título a receber informacoesAdicionais: type: object allOf: – #/definitions/recInformacoesAdicionaisTituloReceber description: Informações adicionais do título a receber informacaoPix: type: object allOf: – #/definitions/recInformacaoPix description: Informações do PIX do título a receber recInformacoesAdicionaisTituloPagar: description: Indicativo das informações adicionados do título pagar allOf: – #/definitions/recInformacoesAdicionaisTitulo – type: object properties: favorecido: type: object allOf: – #/definitions/recGenerico description: Identificador do favorecido recInformacoesAdicionaisTituloReceber: description: Indicativo das informações adicionados do título receber allOf: – #/definitions/recInformacoesAdicionaisTitulo – type: object properties: sacado: type: object allOf: – #/definitions/recGenerico description: Identificador do sacado formulaReajuste: type: object allOf: – #/definitions/recGenerico description: Identificador da fórmula de reajuste chequeBancario: type: object allOf: – #/definitions/recChequeBancario description: Informações do cheque recInformacaoPix: description: Record com as informações do PIX do título type: object required: – id – situacao properties: id: type: string description: Identificador da entidade diasExpiracaoAposVencimento: type: integer format: int64 description: Data expiração em dias pós vencimento solicitacaoPagador: type: string description: Solicitação do pagador informacoesAdicionais: type: array items: type: object allOf: – #/definitions/recTituloPixInformacaoAdicional description: Informações adicionais pixCopiaCola: type: string description: Pix copia e cola pixQrCode: type: string description: Pix QRCode (Base64) errosIntegracao: type: array items: type: object allOf: – #/definitions/recTituloPixErro description: Erros da integração valorPago: type: string description: Valor recebido dataHoraRecebimento: type: string format: date-time description: Data/Hora do recebimento informacaoPagador: type: string description: Informação do pagador endToEndId: type: string description: Identificador único do pagamento situacao: type: string allOf: – #/definitions/enumSituacaoBanking description: Situação da geração do PIX recTituloPixInformacaoAdicional: description: Record responsável pelas informações adicionais do PIX do título type: object required: – id – chave – valor properties: id: type: string description: Identificador do registro da entidade chave: type: string description: Chave valor: type: string description: Valor recTituloPixErro: description: Record responsável pelos erros de integração do PIX do título type: object required: – id – campo – mensagem properties: id: type: string description: Identificador do registro da entidade campo: type: string description: Campo mensagem: type: string description: Mensagem recOrigemTitulo: description: Identificação da origem do título type: object required: – tipoEntrada properties: tipoEntrada: type: string allOf: – #/definitions/enumOrigemLoteFinanceiro description: Tipo entrada titulo origemId: type: string description: Identificador origem titulo detalheOrigem: type: string description: Detalhes origem titulo recJuros: description: Indicativo das informações dos juros do título type: object required: – prorrogacaoJuros properties: valorJurosDia: type: string description: Valor Juros Dia minimum: 0.00 maximum: 9999999.99 percentual: type: number format: double description: Percentual/Tipo Juros minimum: 0.00 maximum: 999.99 tipo: type: string allOf: – #/definitions/enumTipJrs description: Tipo de Juros toleranciaJuros: type: integer format: int64 description: Dias Tolerância Juros minimum: 0 maximum: 9999 prorrogacaoJuros: type: boolean description: Aceita prorrogação de juros recMulta: description: Indicativo das informações da multa do título type: object properties: percentual: type: number format: double description: Percentual/Tolerância Multa minimum: 0.00 maximum: 999.99 toleranciaMulta: type: integer format: int64 description: Dias Tolerância Multa minimum: 0 maximum: 9999 recDescontos: description: Indicativo das informações de desconto do título discriminator: _discriminator type: object required: – _discriminator properties: antecipacao: type: boolean description: Calcula Desc. Antecipação dataLimite: type: string format: date description: Data/Tolerância Desconto tolerancia: type: integer format: int64 description: Tolerância Desconto minimum: 0 maximum: 999 percentual: type: number format: double description: Percentual/Valor Desconto minimum: 0.00 maximum: 999.99 valor: type: string description: Valor Desconto minimum: 0.00 maximum: 9999999999999.99 _discriminator: type: string description: recDescontosReceber: description: Desconto para títulos a receber allOf: – #/definitions/recDescontos – type: object required: – periodoDesconto properties: periodoDesconto: type: string allOf: – #/definitions/enumPerFlu description: Periodicidade do desconto recRateio: description: Indicativo das informações para geração de rateio type: object properties: projeto: type: object allOf: – #/definitions/recGenerico description: Indicativo do projeto faseProjeto: type: object allOf: – #/definitions/recGenerico description: Indicativo da fase do projeto contaFinanceira: type: object allOf: – #/definitions/recGenerico description: Indicativo da conta financeira contaContabil: type: object allOf: – #/definitions/recGenerico description: Indicativo da conta contábil centroCustos: type: object allOf: – #/definitions/recGenerico description: Indicativo do centro de custos recValoresNegociados: description: Indicativo das informações negociadas do título type: object properties: dataLimiteNegociacao: type: string format: date description: Data Valores Negociados juroNegociado: type: string description: Valor Juros Negociados minimum: 0.00 maximum: 9999999999999.99 multaNegociada: type: string description: Valor Multa Negociada minimum: 0.00 maximum: 9999999999999.99 descontoNegociado: type: string description: Valor Descontos Negociados minimum: 0.00 maximum: 9999999999999.99 outrosValoresNegociados: type: string description: Outros Negociados minimum: 0.00 maximum: 9999999999999.99 cotacaoNegociada: type: string description: Cotação Moeda Negociada minimum: 0.00 maximum: 999999999.9999999999 recPreparacaoTesouraria: description: Preparação tesouraria type: object required: – id – empresa – filial – contaInterna – transacao – dataPrevisao – dataLiberacao – valorPreparacao – preparacaoProcessada – informacoesAdicionaisPreparacaoTesouraria properties: id: type: string description: Identificador do movimento empresa: type: object allOf: – #/definitions/recGenerico description: Informação da empresa filial: type: object allOf: – #/definitions/recGenerico description: Filial contaInterna: type: object allOf: – #/definitions/recGenerico description: Conta interna utilizada transacao: type: object allOf: – #/definitions/recGenerico description: Transação utilizada dataPrevisao: type: string format: date description: Data de previsão da emissão do crédito para o fornecedor dataLiberacao: type: string format: date description: Data de liberação do movimento de crédito para o fornecedor valorPreparacao: type: string description: Valor da preparacao preparacaoProcessada: type: boolean description: Indicativo se a preparação está processada ou não informacoesAdicionaisPreparacaoTesouraria: type: object allOf: – #/definitions/recInformacoesAdicionaisPreparacaoTesouraria description: Informações adicionais do movimento da tesouraria recMovimentoTesouraria: description: Movimento gerado na tesouraria type: object required: – id – empresa – filial – contaInterna – transacao – dataMovimento – dataLiberacao – dataContabil – natureza – valorMovimento – informacoesAdicionaisMovimentoTesouraria properties: id: type: string description: Identificador do movimento empresa: type: object allOf: – #/definitions/recGenerico description: Informação da empresa filial: type: object allOf: – #/definitions/recGenerico description: Filial contaInterna: type: object allOf: – #/definitions/recGenerico description: Conta interna utilizada transacao: type: object allOf: – #/definitions/recGenerico description: Transação utilizada dataMovimento: type: string format: date description: Data do movimento de transferência dataLiberacao: type: string format: date description: Data da liberação dataContabil: type: string format: date description: Data contábil natureza: type: string allOf: – #/definitions/enumDebCre description: Natureza do movimento (Débito/Crédito) valorMovimento: type: string description: Valor do movimento informacoesAdicionaisMovimentoTesouraria: type: object allOf: – #/definitions/recInformacoesAdicionaisMovimentoTesouraria description: Informações adicionais do movimento da tesouraria recInformacoesAdicionaisPreparacaoTesouraria: description: Informações adicionais do movimento da tesouraria type: object required: – origemPreparacao properties: dataContabil: type: string format: date description: Data contábil dataPagamento: type: string format: date description: Data pagamento origemPreparacao: type: string allOf: – #/definitions/enumOriChe description: Origem do movimento naturezaGasto: type: object allOf: – #/definitions/recGenerico description: Informação da natureza de gasto numeroCheque: type: integer format: int64 description: Número do cheque/aviso de débito tipoDocumento: type: object allOf: – #/definitions/recGenerico description: Indicativo do tipo de documento numeroDocumento: type: string maxLength: 20 description: Número do documento do movimento historico: type: string maxLength: 100 description: Histórico do movimento complemento: type: string maxLength: 100 description: Complemento do histórico do movimento observacao: type: string maxLength: 250 description: Observação da preparacao nomeRecebedor: type: string maxLength: 100 description: Nome do recebedor do cheque cpfCnpj: type: string maxLength: 50 description: Número do CPF ou CNPJ impressoesCheque: type: object allOf: – #/definitions/recImpressosCheque description: Controle de impressões rateio: type: object allOf: – #/definitions/recRateio description: Informações rateio usuarioGerador: type: string description: Usuário que realizou o movimento dataGeracao: type: string format: date-time description: Data/Hora da geração do movimento usuarioAlteracao: type: string description: Usuário que realizou o movimento dataAlteracao: type: string format: date-time description: Data/Hora da geração do movimento recExtratoBancario: description: Extratos bancários type: object required: – empresa – contaInterna – dataExtrato – valorExtrato – natureza – conciliado – usuarioGeracao – dataGeracao – usuarioAlteracao – dataAlteracao properties: id: type: string description: Identificador do extrato empresa: type: object allOf: – #/definitions/recGenerico description: Informação da empresa contaInterna: type: object allOf: – #/definitions/recGenerico description: Conta interna utilizada dataExtrato: type: string format: date description: Data do extrato valorExtrato: type: string description: Valor do extrato numeroCheque: type: integer format: int64 description: Número do cheque numeroDocumento: type: string maxLength: 20 description: Número do documento do movimento natureza: type: string allOf: – #/definitions/enumDebCre description: Natureza do extrato (Débito/Crédito) historico: type: string description: Histórico do extrato conciliado: type: boolean description: Indicativo se o extrato está conciliado usuarioGeracao: type: string description: Usuário que cadastrou/importou o extrato dataGeracao: type: string format: date-time description: Data de cadastro do extrato usuarioAlteracao: type: string description: Usuário que alterou o extrato dataAlteracao: type: string format: date-time description: Data de alteração do extrato recImpressosCheque: description: Controle de impressões type: object properties: quantidadeChequeEmitidos: type: integer format: int64 description: Quantidade Impressões Cheque quantidadeAvisosEmitidos: type: integer format: int64 description: Quantidade Impressões Aviso Débito quantidadeChequesTransferenciaEmitidos: type: integer format: int64 description: Quantidade Impressões Cheque TB recInformacoesAdicionaisMovimentoTesouraria: description: Informações adicionais do movimento da tesouraria type: object required: – origemMovimento – tipoMovimento – lancadoPlanoFinanceiro – situacaoMovimento – usuarioGerador – dataGeracao – usuarioAlteracao – dataAlteracao properties: origemMovimento: type: string allOf: – #/definitions/enumOriMcc description: Origem do movimento tipoMovimento: type: string allOf: – #/definitions/enumTipCnc description: Tipo de movimento numeroCheque: type: integer format: int64 description: Número do cheque naturezaGasto: type: object allOf: – #/definitions/recGenerico description: Informação da natureza de gasto tipoDocumento: type: object allOf: – #/definitions/recGenerico description: Indicativo do tipo de documento numeroDocumento: type: string maxLength: 20 description: Número do documento do movimento historico: type: string maxLength: 100 description: Histórico do movimento complemento: type: string maxLength: 100 description: Complemento do histórico do movimento observacao: type: string maxLength: 250 description: Observação do movimento nomeRecebedor: type: string maxLength: 100 description: Nome do recebedor do cheque loteContabil: type: integer format: int64 description: Número do lote contábil lancadoPlanoFinanceiro: type: boolean description: Lançado no plano financeiro situacaoMovimento: type: string allOf: – #/definitions/enumSitReg description: Situacao cpfCnpj: type: string maxLength: 50 description: Número do CPF ou CNPJ valoresMovimentoTesourariaMoedaEstrangeira: type: object allOf: – #/definitions/recValoresMovimentoTesourariaMoedaEstrangeira description: Informações do movimento da tesouraria em moeda estrangeira rateio: type: object allOf: – #/definitions/recRateio description: Informações rateio conciliado: type: boolean description: Indicativo se o movimento está conciliado usuarioGerador: type: string description: Usuário que realizou o movimento dataGeracao: type: string format: date-time description: Data/Hora da geração do movimento usuarioAlteracao: type: string description: Usuário que realizou o movimento dataAlteracao: type: string format: date-time description: Data/Hora da geração do movimento recValoresMovimentoTesourariaMoedaEstrangeira: description: Informações do movimento da tesouraria em moeda estrangeira type: object required: – valorDataMovimento – cotacaoDataMovimento – valorDataLiberacao – cotacaoDataLiberacao properties: valorDataMovimento: type: string description: Valor do movimento na moeda estrangeria na data de movimento cotacaoDataMovimento: type: string description: Valor da cotação do movimento na moeda estrangeria na data de movimento valorDataLiberacao: type: string description: Valor do movimento na moeda estrangeria na data de liberação cotacaoDataLiberacao: type: string description: Valor da cotação do movimento na moeda estrangeria na data de liberação recChequeBancario: description: Informações do cheque que foi recebido como pagamento type: object required: – banco – agencia – numeroConta – numeroCheque – digitoConta properties: banco: type: string description: Código do banco do cheque agencia: type: string description: Código da agência do cheque numeroConta: type: string description: Número da conta bancária do cheque numeroCheque: type: string description: Número do cheque digitoConta: type: string description: Dígito da conta bancária do cheque recBaseInstrucaoBancaria: description: Record base das informações necessárias para emissão de instrução bancária type: object required: – id properties: id: type: string description: Identificador do título empresa: type: object allOf: – #/definitions/recGenerico description: Identificador da empresa filial: type: object allOf: – #/definitions/recGenerico description: Identificador da filial e036ins_id_ins1: type: object allOf: – #/definitions/recGenerico description: Identificador da primeira instrução qtdDi1: type: integer format: int64 description: Quantidade de dias base da primeira instrução datBa1: type: string format: date description: Data base para primeira instrução perBa1: type: string description: Percentual base da primeira instrução vlrBa1: type: string description: Valor base da primeira instrução e036ins_id_ins2: type: object allOf: – #/definitions/recGenerico description: Identificador da segunda instrução qtdDi2: type: integer format: int64 description: Quantidade de dias base da primeira instrução datBa2: type: string format: date description: Data base para primeira instrução perBa2: type: string description: Percentual base da primeira instrução vlrBa2: type: string description: Valor base da primeira instrução obsItb: type: string maxLength: 250 description: Texto da observação numArb: type: integer format: int64 description: Número da remessa tipItb: type: string allOf: – #/definitions/enumTipItb description: Tipo de isntrução sitItb: type: string allOf: – #/definitions/enumSitReg description: Situação da instrução retIns: type: boolean description: Retorno da instrução e301tcr: type: object allOf: – #/definitions/recGenerico description: Título receber e002tpt: type: object allOf: – #/definitions/recGenerico description: Tipo título e033crt: type: object allOf: – #/definitions/recGenerico description: Carteira e039por: type: object allOf: – #/definitions/recGenerico description: Portador e035ocr: type: object allOf: – #/definitions/recGenerico description: Identificador da Ocorrência tipBa1: type: string maxLength: 1 description: Tipo base da primeira instrução tipBa2: type: string maxLength: 1 description: Tipo base da segunda instrução usuger: type: string description: Usuário que gerou o registro dthger: type: string format: date-time description: Data de geração usualt: type: string description: Usuário que alterou o registro dthalt: type: string format: date-time description: Data de alteração numTit: type: string description: Número do título recFatoInstrucaoBancaria: description: Informações referente a instruçao bancaria type: object required: – sideBars – instrucaoBancaria – titulo properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos instrucaoBancaria: type: array items: type: object allOf: – #/definitions/recBaseInstrucaoBancaria minimum: 1 description: Instrucões bancárias titulo: type: array items: type: object allOf: – #/definitions/recTituloContasReceber minimum: 1 description: Titulo receber recFatoRetornoBancario: description: Informações referente ao retorno bancário type: object required: – sideBars properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos composicaoFatosRetornoBancario: type: array items: type: string allOf: – #/definitions/enumTipoFatoFinanceiro description: Tipos de fato do lote de retorno recFatosRetornoBancario: description: Informações referente ao retorno bancário type: object required: – id – sequecial – tipo – sideBars properties: id: type: string description: Identificador do fato sequecial: type: integer format: int64 description: Sequencia do fato financeiro tipo: type: string allOf: – #/definitions/enumTipoFatoFinanceiro description: Tipo do fato financeiro sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoTesourariaTarifa: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de débito de tarifa realizado na tesouraria histRetornoBancario: type: array items: type: object allOf: – #/definitions/recHistRetornoBancario description: Histórico retorno bancário movimentoDuplicata: type: array items: type: object allOf: – #/definitions/recMovimentoReceber description: Movimento de baixa da duplicata movimentoTesouraria: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria description: Informação do movimento de débito realizado na tesouraria recHistRetornoBancario: description: Informações de um fato financeiro do historico do retorno erro ou sucesso type: object required: – tipHis properties: titulo: type: object allOf: – #/definitions/recTituloReceberRetorno description: Referencia, pode ser e301tcr ou e310itb e035oct: type: object allOf: – #/definitions/recGenerico description: Ocorrência de retorno e030ort: type: object allOf: – #/definitions/recGenerico description: Ocorrencia de retorno do banco tratado: type: boolean description: Indica se foi tratado default: false erro: type: string maxLength: 1000 description: Mensagem de erro obsHic: type: string maxLength: 250 description: Observação datRet: type: string format: date description: Data do retorno vlrRet: type: string description: Valor do retorno minimum: 0.00 maximum: 9999999999999.99 tipTrb: type: string allOf: – #/definitions/enumTipTrb description: Código da ocorrência da tarifa tipHis: type: string allOf: – #/definitions/enumTipHis description: Tipo histórico motivo: type: string maxLength: 20 description: Motivo da rejeição recFatoImportacaoExtratoBancario: description: Informações referente a composição da conciliação bancária type: object required: – sideBars properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos extratos: type: array items: type: object allOf: – #/definitions/recExtratoBancario description: Extratos bancários recFatoConciliacaoBancaria: description: Informações referente a composição da conciliação bancária type: object required: – loteConciliado – sideBars properties: loteConciliado: type: object allOf: – #/definitions/recLoteConciliado description: Informações do lote conciliado sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentos: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria description: Movimentos da tesouraria extratos: type: array items: type: object allOf: – #/definitions/recExtratoBancario description: Extratos bancários recLoteConciliado: description: Informações do lote de conciliação type: object required: – dataConciliacao – origemConciliacao properties: dataConciliacao: type: string format: date description: Data da conciliação origemConciliacao: type: string allOf: – #/definitions/enumOrigemLoteConciliacao description: Qual o tipo de conciliação totalMovimentoCredito: type: string description: Total de movimentos da tesouraria de crédito envolvidos na conciliação totalMovimentoDebito: type: string description: Total de movimentos da tesouraria de débito envolvidos na conciliação totalExtratoCredito: type: string description: Total de extratos bancários de crédito envolvidos na conciliação totalExtratoDebito: type: string description: Total de extratos bancários de débito envolvidos na conciliação quantidadeMovimentos: type: integer format: int64 description: Quantidade de movimentos da tesouraria envolvidos na conciliação quantidadeExtratos: type: integer format: int64 description: Quantidade de extratos bancários envolvidos na conciliação recTituloReceberRetorno: description: Informações do título receber processado no retorno bancário type: object required: – id – empresa – filial – pessoa – numeroTitulo – tipoTitulo properties: id: type: string description: Identificador do título empresa: type: object allOf: – #/definitions/recGenerico description: Identificador da empresa filial: type: object allOf: – #/definitions/recGenerico description: Identificador da filial pessoa: type: object allOf: – #/definitions/recGenerico description: Identificador do fornecedor/cliente numeroTitulo: type: string maxLength: 15 description: Nº Título tipoTitulo: type: object allOf: – #/definitions/recGenerico description: Identificador do tipo de título recLoteFinanceiroRetornoBancario: description: Record para retorno de lote financeiro bancário type: object required: – id – situacao – lote – origem – dataMovimento – usuarioGeracao – dataGeracao – tiposFatoFinanceiros properties: id: type: string description: Identificador do lote financeiro situacao: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Situação do lote financeiro lote: type: string description: Código do lote financeiro origem: type: string allOf: – #/definitions/enumOrigemLoteFinanceiro description: Origem do lote financeiro dataMovimento: type: string format: date description: Data de movimento do lote financeiro usuarioGeracao: type: string description: Usuário que gerou a baixa dataGeracao: type: string format: date-time description: Data de geração tiposFatoFinanceiros: type: array items: type: string allOf: – #/definitions/enumTipoFatoFinanceiro minimum: 1 description: Tipos fatos financeiros lote retorno bancário callback: description: Record de callback para primitivas type: object required: – dominio – servico – primitiva properties: dominio: type: string description: Dominio de retorno servico: type: string description: Serviço de retorno primitiva: type: string description: Primitiva retorno recPagamentoEletronico: description: Informações de um fato financeiro de uma baixa por pagamento no contas a pagar type: object required: – sideBars – movimentoPagamentoEletronico properties: sideBars: type: array items: type: object allOf: – #/definitions/recSideBar minimum: 1 description: Lista de side bars a serem utilizados na exibição dos fatos movimentoPagamentoEletronico: type: array items: type: object allOf: – #/definitions/recTituloPagamentoEletronico minimum: 1 description: Movimento de baixa da duplicata recTituloPagamentoEletronico: description: Título pagamento eletrônico allOf: – #/definitions/recTituloContasPagar – type: object properties: alteracao: type: string description: Alteração e070emp: description: Cadastros – Empresas type: object required: – codEmp – nomEmp – sigEmp – usuger – dthger – usualt – dthalt properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome sigEmp: type: string maxLength: 10 description: Sigla excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: Usuário que gerou o registro dthger: type: string format: date-time description: Data de geração usualt: type: string description: Usuário que alterou o registro dthalt: type: string format: date-time description: Data de alteração fatoFinanceiro: description: Fato financeiro type: object required: – tipoFato – sequencial – usuger – dthger – usualt – dthalt properties: id: type: string format: uuid description: Identificador identificadorFatoOrigem: type: string format: uuid description: Identificador do processo origem tipoFato: type: string allOf: – #/definitions/enumTipoFatoFinanceiro description: Tipo do fato loteFinanceiro: type: object allOf: – #/definitions/loteFinanceiro description: Lote financeiro sequencial: type: integer format: int64 description: Sequencial do fato financeiro usuger: type: string description: Usuário que gerou o registro dthger: type: string format: date-time description: Data de geração usualt: type: string description: Usuário que alterou o registro dthalt: type: string format: date-time description: Data de alteração loteFinanceiro: description: Lote financeiro type: object required: – lote – situacao – fatosFinanceiros – origem – usuger – dthger – usualt – dthalt properties: id: type: string format: uuid description: Identificador e070emp: type: object allOf: – #/definitions/e070emp description: Empresa do lote financeiro lote: type: string description: Código do lote gerado dataMovimento: type: string format: date description: Data de movimentação do lote situacao: type: string allOf: – #/definitions/enumSituacaoLoteFinanceiro description: Situação atual do lote fatosFinanceiros: type: array items: type: object allOf: – #/definitions/fatoFinanceiro minimum: 1 description: Fatos financeiros vinculados ao lote financeiro origem: type: string allOf: – #/definitions/enumOrigemLoteFinanceiro description: Origem do lote financeiro usuger: type: string description: Usuário que gerou o registro dthger: type: string format: date-time description: Data de geração usualt: type: string description: Usuário que alterou o registro dthalt: type: string format: date-time description: Data de alteração notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. discriminator: _discriminator type: object required: – _discriminator properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. _discriminator: type: string description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação