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

Contas a Receber (contas_receber)

416 views 0 27/02/2020 Atualizado em 15/07/2024 integrador

2.0info: 1.104.0 Contas a Receber description: Serviço de contas a receber x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: contas_receber 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: /contas_receber/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 /contas_receber/queries/baixarArquivo: post: description: Baixar arquivo da S3 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – e301tcr_id properties: e301tcr_id: type: string description: Filtro com parâmetros de busca 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 get: description: Baixar arquivo da S3 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: e301tcr_id description: Filtro com parâmetros de busca in: query required: true type: string 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 /contas_receber/queries/obterSugestaoTitulos: post: description: Primitiva que irá sugerir os títulos para a sua geração em lote tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/recFilterSugestaoTitulosReceber description: Filtro com os parâmetros para a sugestão do título responses: 200: description: Ok schema: type: object required: – titulos – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recSugestaoTitulosReceber minimum: 1 description: Duplicatas a receber sugeridas totalElements: type: integer format: int64 description: Total de duplicatas sugeridas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterDuplicatasReceber: post: description: Obtém as duplicatas a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pageRequest properties: filter: type: object allOf: – #/definitions/recFilterTitulosReceber description: Filtro com os parâmetros de busca pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recTitulosReceber description: Duplicatas a receber filtradas totalElements: type: integer format: int64 description: Total de duplicatas retornadas 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterDuplicatasReceberBaixar: post: description: Retorna duplicatas a receber (obterDuplicatasReceber) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: filter: type: object allOf: – #/definitions/recFilterTitulosReceber description: Filtro com os parâmetros de busca pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recTitulosReceber description: Duplicatas a receber filtradas totalElements: type: integer format: int64 description: Total de duplicatas retornadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterCreditosReceberBaixar: post: description: Retorna duplicatas a receber (obterDuplicatasReceber) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: filter: type: object allOf: – #/definitions/recFilterTitulosReceber description: Filtro com os parâmetros de busca pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recTitulosReceber description: Duplicatas a receber filtradas totalElements: type: integer format: int64 description: Total de duplicatas retornadas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterTotalDuplicatasPagarBaixar: post: description: Retorna o total financeiro das duplicatas a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/recFilterTitulosPagar description: Filtros para obtenção dos totais responses: 200: description: Ok schema: type: object required: – totalDuplicatas properties: totalDuplicatas: type: string description: Total das duplicatas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterDuplicatasPagarBaixar: post: description: Retorna duplicatas a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter – pageRequest properties: filter: type: object allOf: – #/definitions/recFilterTitulosPagar description: Filtro com parâmetros de busca pageRequest: type: object allOf: – #/definitions/recPageRequest description: Paginação e ordenação responses: 200: description: Ok schema: type: object required: – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recTituloPagar description: Títulos retornados totalElements: type: integer format: int64 description: Total de títulos encontados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterTituloEditar: post: description: Obtem informações do título tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idTitulo properties: idTitulo: type: string description: Id do título a receber responses: 200: description: Ok schema: type: object required: – campos – e301tcr properties: campos: type: array items: type: string minimum: 1 description: Campos editáveis e301tcr: type: object allOf: – #/definitions/recTituloEdicao description: Título 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem informações do título tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idTitulo description: Id do título a receber in: query required: true type: string responses: 200: description: Ok schema: type: object required: – campos – e301tcr properties: campos: type: array items: type: string minimum: 1 description: Campos editáveis e301tcr: type: object allOf: – #/definitions/recTituloEdicao description: Título 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterMovimentosContasReceber: post: description: Retorna a movimento de títulos a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – opcao properties: empresaId: type: array items: type: string description: Filtro por empresa filialId: type: array items: type: string description: Filtro por filial pessoaId: type: array items: type: string description: Filtro por client tituloId: type: array items: type: string description: Filtro por título tipoTituloId: type: array items: type: string description: Filtro por tipo de título opcao: type: string allOf: – #/definitions/enumOpcaoMovimento description: Filtrar entrada/baixas ou ambas periodoInicial: type: string format: date description: Filtro por data de pagamento inicial periodoFinal: type: string format: date description: Filtro por data de pagamento final emissaoInicial: type: string format: date description: Filtro por data inicial de emissão de título emissaoFinal: type: string format: date description: Filtro por data final de emissão de título portadorId: type: array items: type: string description: Filtro por portador atual do título carteiraId: type: array items: type: string description: Filtro por carteira atual do título transacaoId: type: array items: type: string description: Filtro por transação de movimento formaPagamentoId: type: array items: type: string description: Filtro por forma de pagamento atual do título sacadoId: type: array items: type: string description: Filtro por sacado do título grupoContasId: type: array items: type: string description: Filtro por grupo de contas loteContabil: type: array items: type: integer format: int64 description: Filtro por lote contábil moedaId: type: array items: type: string description: Filtro por moeda do título naturezaGastoId: type: array items: type: string description: Filtro por natureza de gastos loteFinanceiroId: type: array items: type: string description: Filtro por lote financeiro pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação notaFiscalId: type: array items: type: string description: Filtro por nota fiscal responses: 200: description: Ok schema: type: object required: – total properties: movimento: type: array items: type: object allOf: – #/definitions/recMovimentoReceber description: Lista de movimentos encontrados total: type: integer format: int64 description: Quantidade de movimentos encontratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterTotalDuplicatasReceberBaixar: post: description: Retorna o total financeiro das duplicatas a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/recFilterTitulosReceber description: Filtro com os parâmetros de busca responses: 200: description: Ok schema: type: object required: – totalDuplicatas properties: totalDuplicatas: type: string description: Total financeiro das duplicatas a receber 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterTotalCreditosReceberBaixar: post: description: Retorna o total financeiro dos créditos a receber tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/recFilterTitulosReceber description: Filtro com os parâmetros de busca responses: 200: description: Ok schema: type: object required: – totalCreditos properties: totalCreditos: type: string description: Total financeiro dos créditos a receber 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/obterImpostosTituloConsultar: post: description: Retorna os títulos com movimento de imposto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idTitulo properties: idTitulo: type: string description: Id do título a receber responses: 200: description: Ok schema: type: object required: – impostos properties: impostos: type: array items: type: object allOf: – #/definitions/recImpostosTitulo minimum: 1 description: Impostos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os títulos com movimento de imposto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idTitulo description: Id do título a receber in: query required: true type: string responses: 200: description: Ok schema: type: object required: – impostos properties: impostos: type: array items: type: object allOf: – #/definitions/recImpostosTitulo minimum: 1 description: Impostos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/getFinancialInformationSaleOrderBlock: post: description: Retornar informações financeiras para o bloqueio do pedido de venda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – customerId – branchId properties: customerId: type: string description: Id do cliente branchId: type: string description: Id da filial responses: 200: description: Ok schema: type: object required: – creditLimitLastUpdated – creditLimitValue – totalReceivableValue – overdueReceivable properties: creditLimitLastUpdated: type: string format: date description: Data da última atualização do limite de crédito do cliente creditLimitValue: type: string description: Limite de crédito do cliente totalReceivableValue: type: string description: Valor total de títulos a receber em aberto overdueReceivable: type: string description: Identificação de existência de títulos a receber vencidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retornar informações financeiras para o bloqueio do pedido de venda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: customerId description: Id do cliente in: query required: true type: string – name: branchId description: Id da filial in: query required: true type: string responses: 200: description: Ok schema: type: object required: – creditLimitLastUpdated – creditLimitValue – totalReceivableValue – overdueReceivable properties: creditLimitLastUpdated: type: string format: date description: Data da última atualização do limite de crédito do cliente creditLimitValue: type: string description: Limite de crédito do cliente totalReceivableValue: type: string description: Valor total de títulos a receber em aberto overdueReceivable: type: string description: Identificação de existência de títulos a receber vencidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/queries/listErrosIntegracaoCobrancaBankingPix: post: description: Primitiva responsável por retornar os erros da integração da cobrança PIX com o banking tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cobrancaPixId – pageRequest properties: cobrancaPixId: type: string description: Identificador do registro de cobrança pix pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – erros – totalElements properties: erros: type: array items: type: object allOf: – #/definitions/recErroIntegracaoCobrancaBankingPix minimum: 1 description: Lista de erros totalElements: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/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 /contas_receber/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 /contas_receber/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 /contas_receber/actions/enviarEmailRelatorioPagamentoPix: post: description: Action responsável por realizar o envio do relatório de pagamento do Pix tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulosId properties: titulosId: type: array items: type: string minimum: 1 description: Identificadores dos títulos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/downloadRelatorioPagamentoPix: post: description: Action responsável por realizar o download do relatório de pagamento do Pix tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tituloId properties: tituloId: type: string description: Identificador do título responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/reprocessarRelatorioPagamentoPix: post: description: Reprocessar relatório de pagamento pix tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tituloId properties: tituloId: type: string description: Identificador do título responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/cancelarCobrancaPix: post: description: Action responsável por realizar a chamada do cancelamento de cobrança de pix tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulosId properties: titulosId: type: array items: type: string minimum: 1 description: Identificadores dos títulos responses: 200: description: Ok schema: type: object required: – processId properties: processId: type: string description: Identificador do processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarRelatorioTitulosEmAbertoPDF: post: description: Action para geração do relatório de títulos em aberto no formato PDF tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtros properties: filtros: type: object allOf: – #/definitions/recGerarRelatorioTitulosEmAberto description: Parâmetros para geração do relatório responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Identificador processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarRelatorioTitulosEmAbertoPlanilha: post: description: Action para geração do relatório de títulos em aberto no formato planilha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtros properties: filtros: type: object allOf: – #/definitions/recGerarRelatorioTitulosEmAberto description: Parâmetros para geração do relatório responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Identificador processo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/atualizarTitulosReceberIntegrados: post: description: Atualização de títulos do contas a receber com cobrança processada externamente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – key – type – primaryData properties: id: type: string description: Identificador da transação key: type: string description: Key type: type: string description: Evento primaryData: type: object allOf: – #/definitions/recInfoBoleto description: Dados do boleto secondaryData: type: object allOf: – #/definitions/recInfoBanco description: Dados bancários responses: 200: description: Ok schema: type: object 400: description: Parâmetros obrigatórios não informados ou informados incorretamente 401: description: Usuário ou senha inválidos 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /contas_receber/actions/salvarTitulosContasReceber: post: description: Geração de Títulos de Contas a Receber tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulos properties: titulos: type: array items: type: object allOf: – #/definitions/recTituloContasReceber minimum: 1 description: Títulos do contas a receber loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiro properties: loteFinanceiro: type: string description: Lote Financeiro 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /contas_receber/actions/atualizarDuplicatasReceber: post: description: Atualiza informações título tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: object allOf: – #/definitions/recTituloEdicao description: Titulo para atualizar e600ccoSugestaoTituloId: type: string description: Sugestão Conta Interna responses: 200: description: Ok schema: type: object required: – idTitulo properties: idTitulo: type: string description: Identificador título alterado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarBaixasCompostasReceber: post: description: Gerar baixas compostas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – baixas properties: baixas: type: object allOf: – #/definitions/recBaixasCompostas description: baixas loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote Financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarBaixaPorCancelamentoCreditos: post: description: Gerar Baixa por motivos diversos – Cancelamento Créditos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transacaoBaixaId – titulosId properties: transacaoBaixaId: type: string description: Id da transação da baixa titulosId: type: array items: type: object allOf: – #/definitions/recTituloBaixaMotivosDiversos minimum: 1 description: Títulos baixa cancelamento dataBase: type: string format: date description: Data base para movimentos loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote Financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarBaixaPorCancelamentoDuplicatas: post: description: Gerar Baixa por motivos diversos – Cancelamento Duplicatas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transacaoBaixaId – titulosId properties: transacaoBaixaId: type: string description: Id da transação da baixa titulosId: type: array items: type: object allOf: – #/definitions/recTituloBaixaMotivosDiversos minimum: 1 description: Títulos baixa cancelamento dataBase: type: string format: date description: Data base para movimentos loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote Financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarBaixaPorAbatimentoDuplicatas: post: description: Gerar Baixa por motivos diversos – Abatimento Duplicatas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transacaoBaixaId – titulosBaixar properties: transacaoBaixaId: type: string description: Id da transação da baixa titulosBaixar: type: array items: type: object allOf: – #/definitions/recTituloBaixa minimum: 1 description: Informações do título a ser baixado loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote Financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarBaixaPorAbatimentoCreditos: post: description: Gerar Baixa por motivos diversos – Abatimento Créditos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transacaoBaixaId – titulosBaixar properties: transacaoBaixaId: type: string description: Id da transação da baixa titulosBaixar: type: array items: type: object allOf: – #/definitions/recTituloBaixa minimum: 1 description: Informações do título a ser baixado loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote Financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarBaixaPorLucrosPerdasDuplicatas: post: description: Gerar Baixa por motivos diversos – Lucros/Perdas Duplicatas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transacaoBaixaId – titulosBaixar properties: transacaoBaixaId: type: string description: Id da transação da baixa titulosBaixar: type: array items: type: object allOf: – #/definitions/recTituloBaixa minimum: 1 description: Informações do título a ser baixado loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote Financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarBaixaPorLucrosPerdasCreditos: post: description: Gerar Baixa por motivos diversos – Lucros/Perdas Créditos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – transacaoBaixaId – titulosBaixar properties: transacaoBaixaId: type: string description: Id da transação da baixa titulosBaixar: type: array items: type: object allOf: – #/definitions/recTituloBaixa minimum: 1 description: Informações do título a ser baixado loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote Financeiro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/regerarBoleto: post: description: Regerar boleto de títulos não enviados para o banco e que não estejam liquidados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do título responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarBaixasTitulosReceberIntegrados: post: description: Gerar baixa de títulos via portador externo tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – key – type – value – date properties: id: type: string description: Identificador da transação key: type: string description: Chave de identificação do título type: type: string description: Tipo do evento value: type: object allOf: – #/definitions/recValue description: Informações de valores do pagamento date: type: object allOf: – #/definitions/recDate description: Informações de datas do pagamento interest: type: string description: Juros lateFee: type: string description: Multa discount: type: string description: Desconto loteFinanceiroReprocessamentoId: type: string description: Id do lote para reprocessamento responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote Financeiro 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /contas_receber/actions/simularCalculoImpostoContasReceber: post: description: Simular cálculo do imposto para o contas a receber tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titulos properties: titulos: type: object allOf: – #/definitions/recBaixasCompostas description: Títulos responses: 200: description: Ok schema: type: object required: – lote properties: lote: type: string description: Identificação do lote 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/consultaStatusLoteTituloImposto: post: description: Permite consultar o status do cálculo do imposto para o lote desejado do contas a receber tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – identificacaoLote – offset – size properties: titulo: type: array items: type: object allOf: – #/definitions/tituloConsulta description: Identificação do título identificacaoLote: type: string description: identificação do lote status: type: string allOf: – #/definitions/enumStatusImpostoTitulo description: Status dataBase: type: string format: date description: Data base offset: type: integer format: int64 description: Página size: type: integer format: int64 description: Quantidade de registros responses: 200: description: Ok schema: type: object required: – tituloImposto – totalPages – totalElements properties: tituloImposto: type: array items: type: object allOf: – #/definitions/retornoTituloImposto minimum: 1 description: Retorno totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de registros 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/sendBankSlipCopy: post: description: Enviar segunda via do boleto por e-mail tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – securitiesId properties: securitiesId: type: string description: Id do título responses: 200: description: Ok schema: type: object required: – securitiesId properties: securitiesId: type: string description: Id do título 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarRelatorioTitulosLiquidadosPdf: post: description: Action para geração do relatório de títulos em aberto no formato PDF tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtros properties: filtros: type: object allOf: – #/definitions/recGerarRelatorioTitulosLiquidados description: Parâmetros do relatório responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/actions/gerarRelatorioTitulosLiquidadosPlanilha: post: description: Action para geração do relatório de títulos em aberto no formato planilha tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtros properties: filtros: type: object allOf: – #/definitions/recGerarRelatorioTitulosLiquidados description: Parâmetros do relatório responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_receber/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 /contas_receber/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 /contas_receber/signals/calcularJurosMultasDescontosImpostosTitulos: post: description: Signal que faz o processamento assíncrono do cálculo dos impostos dos títulos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – identificador – processId – titulos – callback properties: identificador: type: string description: Identificador do cálculo processId: type: string description: ID processo Async titulos: type: array items: type: string minimum: 1 description: Títulos cálculo dataBase: type: string format: date description: Data agendamento callback: type: object allOf: – #/definitions/callback description: Callback responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /contas_receber/signals/gerarBaixasPorPagamentoAutomaticoReceber: post: description: Gerar baixas automáticas por pagamento do contas a receber tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – dataMovimento – tituloBaixarDuplicataReceber – valorPago properties: dataMovimento: type: string format: date description: Data de movimento da baixa tituloBaixarDuplicataReceber: type: object allOf: – #/definitions/recTituloBaixa description: Títulos a receber (duplicatas) que serão baixados conforme geração dos fatos valorPago: type: string description: Valor Pago loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /contas_receber/signals/gerarRelatorioPagamentoPix: post: description: Signal responsável por gerar o relatório para títulos com forma de pagamento pix tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tituloId – situacaoReportTicket – recebedorImagemLogo properties: tituloId: type: string description: Identificador do título situacaoReportTicket: type: string allOf: – #/definitions/enumSituacaoReportTicketCobrancaPix description: Situação do report ticket recebedorImagemLogo: type: string description: Imagem logo do recebedor do pix responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /contas_receber/events/tituloIntegracaoExternaGerado: post: description: Evento de notificação para envio de títulos/instruções para cobrança escritural via portador externo x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – supplier – titles properties: async: type: boolean description: Indicativo se o envio será assíncrono default: true supplier: type: object allOf: – #/definitions/recSupplier description: Header do envio titles: type: array items: type: object allOf: – #/definitions/recTitle minimum: 1 description: Títulos responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contas_receber/events/geracaoTituloNotaFiscalSaidaProcessadoComSucesso: post: description: Evento de geraçã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 – titulos properties: controlProcessId: type: string description: ticket groupId: type: string description: Agrupador titulos: type: array items: type: object allOf: – #/definitions/recTituloNotaFiscalSaida minimum: 1 description: Titulos gerados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contas_receber/events/geracaoTituloNotaFiscalSaidaProcessadoComErro: post: description: Evento de geraçã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/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 enumTipoVencimento: description: Tipo de Vencimento type: string enum: – PROVAVEL_PAGAMENTO – VENCIMENTO_ORIGINAL – VENCIMENTO_PRORROGADO enumTipoValorTitulo: description: Tipo do valor do título type: string enum: – ABERTOS – LIQUIDADOS – AMBOS enumModalidadeTitulo: description: Modalidade do título type: string enum: – PREVISTOS – EFETIVOS – AMBOS enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – Asc – Desc enumTipTcc: description: Tipo de conta type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 enumPerFlu: description: Período de cálculo type: string enum: – VD – VS – VQ – VM – VT – VR – VA enumTipJrs: description: Tipo de juros type: string enum: – VS – VC enumOpcaoMovimento: description: Opção de movimento type: string enum: – OUTROS – BAIXAS – TODOS 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 enumTipoValor: description: Indica se o valor será igual ou dividido entre as parcelas type: string enum: – IGUALITARIO – DIVIDIDO enumDataBaseContabil: description: Data base contábil type: string enum: – V1 – V2 eValuesMode: description: Tipo de valor a ser considerado para juros e multa type: string enum: – FIXED – PERCENTAGE – DAILY_AMOUNT – DAILY_PERCENTAGE – MONTHLY_PERCENTAGE enumTituloOrigem: description: Origem do título type: string enum: – CONTAS_RECEBER – CONTAS_PAGAR enumStatusImpostoTitulo: description: Status type: string enum: – CALCULO_INICIADO – IMPOSTO_CALCULADO – ERRO_CALCULO – IMPOSTO_CONSULTADO enumImpostoRetidoCaixa: description: Tipo imposto type: string enum: – ISS_RETIDO – PIS_RETIDO – COFINS_RETIDO – CSLL – IRRF enumReportPrintFormat: description: Tipo de impressão do relatório type: string enum: – PDF – PLANILHA enumSituacaoReportTicketCobrancaPix: description: Situação do report ticket type: string enum: – RELATORIO_PIX_NAO_GERADO – RELATORIO_PIX_PROCESSANDO_ENVIO_EMAIL_COM_DANFE – RELATORIO_PIX_PROCESSANDO_ENVIO_EMAIL_SEM_DANFE – RELATORIO_PIX_GERADO_ENVIO_EMAIL_COM_DANFE – RELATORIO_PIX_GERADO_ENVIO_EMAIL_SEM_DANFE – RELATORIO_PIX_PROCESSANDO_DOWNLOAD – RELATORIO_PIX_GERADO_DOWNLOAD – RELATORIO_PIX_REPROCESSANDO – RELATORIO_PIX_REPROCESSADO – ERRO_GERACAO_RELATORIO_PAGAMENTO_PIX externalIntegration: description: Tipo de integração externa type: string enum: – ECOMMERCE enumEmailStatus: description: Status do envio por email type: string enum: – NAO_ENVIADO – PROCESSANDO – ENVIADO – ERRO enumImpostos: description: Tipo de imposto type: string enum: – ISS_RETIDO – PIS_RETIDO – COFINS_RETIDO – CSLL – IRRF enumSituacaoBanking: description: Status do PIX type: string enum: – NAO_ENVIADO – ENVIADO_GERACAO – RETORNADO_GERACAO – RETORNADO_PAGO – CANCELADO – ERRO – EM_CANCELAMENTO enumOrdenacaoRelatorioTitulosLiquidados: description: Tipo de ordenação do relatório de Titulos Liquidados type: string enum: – VENCIMENTO – CLIENTE – VALOR_LIQUIDADO 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 callback: description: Record de Chamada de retorno type: object required: – dominio – servico – primitiva properties: dominio: type: string description: Dominio do service de retorno servico: type: string description: Serviço do service de retorno primitiva: type: string description: Primitiva do service de retorno recGerarRelatorioTitulosEmAberto: description: Record para geração do relatório de títulos em aberto type: object properties: empresaId: type: string description: Empresa filialId: type: array items: type: string description: Filial clienteId: type: array items: type: string description: Cliente grupoId: type: array items: type: string description: Grupo de empresa do fornecedor tipoTituloId: type: array items: type: string description: Tipo de título numeroTitulo: type: array items: type: string description: Número do título tituloId: type: array items: type: string description: Título contas a receber dataInicial: type: string format: date description: Data inicial (provável pagamento) dataFinal: type: string format: date description: Data final (provável pagamento) dataEmissaoInicial: type: string format: date description: Data emissão inicial dataEmissaoFinal: type: string format: date description: Data emissão final moedaId: type: array items: type: string description: Moeda contratoId: type: array items: type: string description: Contratos formaPagamentoId: type: array items: type: string description: Forma de pagamento dataBase: type: string format: date description: Data base ordenacao: type: integer format: int64 description: Ordenação shared: type: boolean description: Indicativo se e o relatório é shared default: true 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 recTituloNotaFiscalSaida: description: Resumo das informações do título gerado por nota fiscal de saida type: object required: – id – filialId – fornecedorId – tipoTituloId – transacaoEntradaId – valorOriginal properties: id: type: string description: Identificador do título filialId: type: string description: Identificador da filial do título fornecedorId: type: string description: Identificador do fornecedor do título tipoTituloId: type: string description: Identificador do tipo de título transacaoEntradaId: type: string description: Identificador da transação de entrada do título valorOriginal: type: string description: Valor original do título (valor da parcela) recTituloPagar: description: Título processo baixa type: object required: – id – e070fil – e002tpt – e001pes – e001tns – e031moe – numTit – datEmi – titPre – titAdt – sitTit – vctOri – vctPro – datPpt – datEnt – valores properties: id: type: string description: Identificador e070fil: type: object allOf: – #/definitions/recE070fil description: Filial + Empresa e002tpt: type: object allOf: – #/definitions/recGeneric description: Tipo de título e001pes: type: object allOf: – #/definitions/recGeneric description: Pessoa – Fornecedor e001tns: type: object allOf: – #/definitions/recGeneric description: Transação e066fpg: type: object allOf: – #/definitions/recGeneric description: Forma pagamento e031moe: type: object allOf: – #/definitions/recGeneric description: Moeda (código – descrição) e091plfFinRat: type: object allOf: – #/definitions/recGeneric description: Conta Financeira e044ccuFinRat: type: object allOf: – #/definitions/recGeneric description: Centro Custo numTit: type: string maxLength: 15 description: Número do título datEmi: type: string format: date description: Data de emissão do título titPre: type: boolean description: Indicativo se o título é previsto titAdt: type: boolean description: Indicativo se o título é adiantamento efetivo sitTit: type: string allOf: – #/definitions/enumSitTit description: Situação do título vctOri: type: string format: date description: Vencimento original vctPro: type: string format: date description: Vencimento prorrogado datPpt: type: string format: date description: Provável pagamento datEnt: type: string format: date description: Data da entrada do título datUpg: type: string format: date description: Data último pagamento do título diaAtr: type: integer format: int64 description: Dias atraso diaJrs: type: integer format: int64 description: Dias juros valores: type: object allOf: – #/definitions/recValoresTitulo description: Informações dos valores do título recFilterTitulosPagar: description: Filtro títulos processo baixa type: object properties: empresas: type: array items: type: string description: Deverá receber E070EMP.ID filiais: type: array items: type: string description: Deverá receber E070FIL.ID fornecedores: type: array items: type: string description: Deverá receber E001PES.ID tipoTitulos: type: array items: type: string description: Deverá receber E002TPT.ID transacoes: type: array items: type: string description: Deverá receber E001TNS.ID numeroTitulo: type: array items: type: string description: Filtrar por numeração de títulos formaPagamento: type: array items: type: string description: Filtra por formas de pagamento vencimentoInicial: type: string format: date description: Período inicial de busca dos títulos vencimentoFinal: type: string format: date description: Período final de busca dos títulos dataBase: type: string format: date description: Data base para o cálculo da possível dos títulos em aberto modalidadeTitulo: type: string allOf: – #/definitions/enumModalidadeTitulo description: Qual modalidade de título deverão ser considerados valorAbertoIgualOriginal: type: boolean description: Valor aberto igual ao valor original ignorarEntradaViaTesouraria: type: boolean description: Ignorar o fato financeiro ENTRADA_VIA_TESOURARIA notasEntrada: type: array items: type: string description: Identificadores das notas de entrada valorMinimo: type: string description: Valor mínimo dos títulos minimum: 0.00 maximum: 9999999999999.99 valorMaximo: type: string description: Valor máximo dos títulos minimum: 0.00 maximum: 9999999999999.99 externalIntegrationType: type: string allOf: – #/definitions/externalIntegration description: Tipo de integração externa saleChannelId: type: array items: type: string description: Id do canal de venda recFilterSugestaoTitulosReceber: description: Filtro com os parâmetros para a sugestão do título type: object required: – quantidadeTitulos – empresaId – filialId – dataEmissao – dataEntrada – transacaoId – valor – primeiroVencimento – tipoTituloId properties: quantidadeTitulos: type: integer format: int64 description: Quantidade de títulos a serem sugeridos empresaId: type: string description: Deverá receber E070EMP.ID filialId: type: string description: Deverá receber E070FIL.ID dataEmissao: type: string format: date description: Data de emissão do futuro título dataEntrada: type: string format: date description: Data de entrada do futuro título clienteId: type: string description: Deverá receber E001PES.ID transacaoId: type: string description: Deverá receber E001TNS.ID formaPagamentoId: type: string description: Código forma de pagamento e066fpg.id contaFinanceiraId: type: string description: Código conta financeira e091plf.id contaContabilId: type: string description: Código conta contábil e045pla.id centroCustoId: type: string description: Código centro custo e044ccu.id valor: type: string description: Valor a serem gerados os futuros títulos minimum: 0.00 maximum: 9999999999999.99 primeiroVencimento: type: string format: date description: Data do primeiro vencimento do primeiro título condicaoPagamento: type: string description: Código da condição de pagamento e028cpg.id observacao: type: string description: Observação prefixoTitulo: type: string maxLength: 15 description: Número sugestivo do futuro título tipoTituloId: type: string description: Código do tipo título e002tpt.id moedaTitulo: type: string description: Moeda titulo e031moe.id tipoValor: type: string allOf: – #/definitions/enumTipoValor description: Indica se o valor será igual ou dividido entre as parcelas dataBaseContabil: type: string allOf: – #/definitions/enumDataBaseContabil description: Data base contábil naturezaGastoId: type: string description: Natureza de gastos e047ntg.id recSugestaoTitulosReceber: description: Duplicatas a receber sugeridas 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/recInformacoesAdicionaisTituloReceber description: Informações adicionais do título a receber recFilterTitulosReceber: description: Record de filtro para obtenção das duplicatas a receber type: object properties: empresas: type: array items: type: string description: Identificadores das empresas filiais: type: array items: type: string description: Identificadores das filiais clientes: type: array items: type: string description: Identificadores dos clientes tipoTitulos: type: array items: type: string description: Identificadores dos tipos de título transacoes: type: array items: type: string description: Identificadores das transações numeroTitulo: type: array items: type: string description: Números dos títulos notasSaida: type: array items: type: string description: Identificadores das notas de saída notasEntrada: type: array items: type: string description: Identificadores das notas de entrada formaPagamento: type: array items: type: string description: Identificadores das formas de pagamento tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: Qual vencimento será considerado na busca dos títulos tipoValor: type: string allOf: – #/definitions/enumTipoValorTitulo description: Qual critério de situações em relação ao valor de títulos deverão ser considerados vencimentoInicial: type: string format: date description: Vencimento inicial do título vencimentoFinal: type: string format: date description: Vencimento final do título dataBase: type: string format: date description: Data base para o cálculo da possível dos títulos em aberto modalidadeTitulo: type: string allOf: – #/definitions/enumModalidadeTitulo description: Modalidade do título que deverá ser considerada valorAbertoIgualOriginal: type: boolean description: Valor aberto igual ao valor original default: false ignorarEntradaViaTesouraria: type: boolean description: Ignorar o fato financeiro ENTRADA_VIA_TESOURARIA default: false emailStatus: type: string allOf: – #/definitions/enumEmailStatus description: Status do envio de email da cobrança valorMinimo: type: string description: Valor mínimo dos títulos minimum: 0.00 maximum: 9999999999999.99 valorMaximo: type: string description: Valor máximo dos títulos minimum: 0.00 maximum: 9999999999999.99 agreements: type: array items: type: string description: Identificadores dos contratos externalIntegrationType: type: string allOf: – #/definitions/externalIntegration description: Tipo de integração externa saleChannelId: type: array items: type: string description: Id do canal de venda recTituloEdicao: description: Record de retorno da pesquisa de edição de títulos allOf: – #/definitions/recTitulosReceber – type: object required: – obsTcr – proJrs properties: e001tns: type: object allOf: – #/definitions/recGeneric description: Transação e033crt: type: object allOf: – #/definitions/recGeneric description: Carteira de cobrança e045plaFinRat: type: object allOf: – #/definitions/recGeneric description: Conta contábil e023crp: type: object allOf: – #/definitions/recGeneric description: Grupo e001pesCodSac: type: object allOf: – #/definitions/recGeneric description: Código do sacado e037frj: type: object allOf: – #/definitions/recGeneric description: Fórmular reajuste e047ntg: type: object allOf: – #/definitions/recGeneric description: Natureza de gasto e029mpt: type: object allOf: – #/definitions/recGeneric description: Motivo Prorrogação numArb: type: string description: Número de remessa de envio ao banco obsTcr: type: string description: Observação cotEmi: type: string description: Cotação Moeda Emissão proJrs: type: boolean description: Prorrogação c/ Juros datCjm: type: string format: date description: Data Juros Mora Calculado digCcc: type: string description: Dígito da Conta Corrente codBar: type: string description: Código Barra datNeg: type: string format: date description: Data Valores Negociados jrsNeg: type: string description: Valor Juros Negociados mulNeg: type: string description: Valor Multa Negociada dscNeg: type: string description: Valor Descontos Negociados outNeg: type: string description: Outros Negociados cotNeg: type: string description: Cotação Moeda Negociada antDsc: type: boolean description: Calcula Desc. Antecipação default: false prdDsc: type: string description: Período para cálculo do desconto datDsc: type: string format: date description: Data/Tolerância Desconto perDsc: type: number format: double description: Percentual/Valor Desconto perMul: type: number format: double description: Percentual/Tolerância Multa tolMul: type: integer format: int64 description: Dias Tolerância Multa tolDsc: type: integer format: int64 description: Dias Tolerância Desconto jrsDia: type: string description: Valor Juros Mora Dia perJrs: type: number format: double description: Percentual/Tipo Juros tipJrs: type: string allOf: – #/definitions/enumTipJrs description: Tipo de Juros tolJrs: type: integer format: int64 description: Dias Tolerância Juros tituloCredito: type: boolean description: Indicatido se titulo é de crédito e001endEndCob: type: object allOf: – #/definitions/recEnderecoPessoaTitulo description: Endereço titBan: type: string description: Nosso número credito: type: boolean description: Crédito origem: type: object allOf: – #/definitions/recOrigem description: Origem recOrigem: description: Record origem type: object properties: numNfs: type: integer format: int64 description: Número nota fiscal codSnf: type: string description: Código série descSnf: type: string description: Descrição série recTitulosReceber: description: Record de retorno da pesquisa de duplicatas a receber discriminator: _discriminator type: object required: – id – e070fil – e002tpt – e001pes – e031moe – numTit – sitTit – titPre – titAdt – vctOri – vctPro – datEmi – datEnt – datPpt – valores – _discriminator properties: id: type: string description: Identificador do título e070emp: type: object allOf: – #/definitions/recE070emp description: Empresa + Moeda e070fil: type: object allOf: – #/definitions/recE070fil description: Empresa + Codigo da filial + Nome da filial e070filFinCre: type: object allOf: – #/definitions/recE070filFinCre description: Filial especializada e002tpt: type: object allOf: – #/definitions/recGeneric description: Tipo de título + Descrição e001pes: type: object allOf: – #/definitions/recGeneric description: Código do cliente + Nome do cliente e066fpg: type: object allOf: – #/definitions/recE066fpg description: Forma de pagamento + Descrição e031moe: type: object allOf: – #/definitions/recGeneric description: Moeda + Sigla e039por: type: object allOf: – #/definitions/recGeneric description: Portador e091plfFinRat: type: object allOf: – #/definitions/recGeneric description: Conta Financeira e044ccuFinRat: type: object allOf: – #/definitions/recGeneric description: Centro Custo numTit: type: string maxLength: 15 description: Número do título sitTit: type: string allOf: – #/definitions/enumSitTit description: Situação do título titPre: type: boolean description: Indicativo se o título é previsto titAdt: type: boolean description: Indicativo se o título é adiantamento efetivo vctOri: type: string format: date description: Vencimento original vctPro: type: string format: date description: Vencimento prorrogado datEmi: type: string format: date description: Data de emissão datEnt: type: string format: date description: Data de entrada datPpt: type: string format: date description: Data provável pagamento ultPgt: type: string format: date description: Data do último pagamento diaJrs: type: integer format: int64 description: Dias juros diaAtr: type: integer format: int64 description: Dias atraso numeroDaRemessa: type: integer format: int64 description: Número da remessa valores: type: object allOf: – #/definitions/recValoresTitulo description: Valores do título emailStatus: type: string allOf: – #/definitions/enumEmailStatus description: Status do envio de email emailErro: type: string description: Mensagem de erro do envio de email e600ccoSugestaoTitulo: type: object allOf: – #/definitions/recGenerico description: Sugestão Conta interna contaInternaSugeridaValida: type: boolean description: Indicativo se a conta interna sugerida é valida lote: type: string description: Lote financeiro informacaoPix: type: object allOf: – #/definitions/recInformacaoPix description: Informações do PIX do título _discriminator: type: string description: recInformacaoPix: description: Record com as informações do PIX do título type: object 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 recValoresTitulo: description: Record de valores dos títulos type: object required: – vlrOri – vlrAbe properties: vlrOri: type: string description: Valor original minimum: 0.00 maximum: 9999999999999.99 vlrAbe: type: string description: Valor aberto do título minimum: 0.00 maximum: 9999999999999.99 vlrBai: type: string description: Valor a baixar vlrDsc: type: string description: Valor descontos vlrOde: type: string description: Valor outros descontos vlrJrs: type: string description: Valor Juros vlrMul: type: string description: Valor multa vlrOac: type: string description: Valor outros acréscimos vlrEnc: type: string description: Valor encargos vlrCor: type: string description: Valor correção monetária vlrLiq: type: string description: Valor líquido vlrImr: type: string description: Valor de impostos retidos cotMcr: type: string description: Valor cotação movimento cotFrj: type: string description: Valor reajuste recE070fil: description: Record da filial type: object required: – idEmp – codEmp – idFil – codFil – nomFil properties: idEmp: type: string description: Identificador da empresa codEmp: type: integer format: int64 description: Código da empresa idFil: type: string description: Identificador da filial codFil: type: integer format: int64 description: Código da filial nomFil: type: string description: Nome da filial recE066fpg: description: Record forma de pagamento type: object required: – id properties: id: type: string description: Identificador da entidade cod: type: string maxLength: 5 description: Código da Entidade des: type: string maxLength: 60 description: Descrição/nome do registro da entidade label: type: string maxLength: 65 description: Label legível para o front tipFpg: type: string description: Tipo pagamento recE070emp: description: Record da empresa type: object required: – idEmp – codEmp – nomEmp – e031moe properties: idEmp: type: string description: Identificador da empresa codEmp: type: integer format: int64 description: Código da empresa nomEmp: type: string description: Nome da empresa e031moe: type: string description: Moeda da empresa recFieldsOrderBy: description: Record do registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) isAliasFromJoin: type: boolean description: Flag para indicar se o order by será por um alias default: false recPageRequest: description: Record de paginação e ordenação de registros type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de páginas orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recE070filFinCre: description: Record da filial especializada type: object required: – id – idPor properties: id: type: string description: Identificador da filial idPor: type: string description: Identificador do portador recGeneric: description: Record genérico com os campos padrão de retorno type: object required: – id properties: id: type: string description: Identificador da entidade cod: type: string maxLength: 5 description: Código da Entidade des: type: string maxLength: 60 description: Descrição/nome do registro da entidade label: type: string maxLength: 65 description: Label legível para o front recGenerico: description: Record para retorno das informações principais de uma entidade type: object required: – id 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 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 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 recJuros: description: Indicativo das informações dos juros do título type: object 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 prorrogaJuros: type: boolean description: Prorrogação c/ 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: -9999 maximum: 9999 valor: type: string description: Valor Desconto minimum: 0.00 maximum: 9999999999999.99 percentual: type: number format: double description: Percentual Desconto minimum: 0.00 maximum: 999.99 _discriminator: type: string description: recDescontosReceber: description: Indicativo das informações de desconto do título a receber allOf: – #/definitions/recDescontos – type: object properties: periodoDesconto: type: string allOf: – #/definitions/enumPerFlu description: Periodicidade do desconto percentualAntecipacao: type: number format: double description: Percentual Desconto Antecipação minimum: 0.00 maximum: 999.99 percentualPontualidade: type: number format: double description: Percentual Desconto Pontualidade minimum: 0.00 maximum: 999.99 recInformacoesAdicionaisTitulo: description: Indicativo das informações adicionados do título discriminator: _discriminator type: object required: – _discriminator properties: 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 _discriminator: type: string description: 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 recInformacoesMovimentoContabilidade: description: Indicativo de informações da contabilidade relacionadas ao movimento do contas a receber type: object properties: loteContabilId: type: string description: Identificador do lote contábil numeroLoteContabil: type: integer format: int64 description: Número do lote contábil integradoContabilidade: type: boolean description: Inficativo se o movimento está integrado com a contabilidade default: false 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 valorCotacaoNegociada: type: string description: Valor da cotação da moeda do reajuste na data do titulo minimum: 0.00 maximum: 999999999.9999999999 recTituloFinanceiro: description: Dados do título financeiro (pagar/receber) discriminator: _discriminator type: object required: – empresa – filial – pessoa – numeroTitulo – tipoTitulo – transacao – dataEmissao – dataEntrada – vencimentoOriginal – provavelPagamento – valorOriginal – moeda – _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 transacao: 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 _discriminator: type: string description: 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 recInformacoesSaldoBaixa: description: Informações para possibilidade de efetuar troco em uma baixa do contas a receber type: object properties: clienteId: type: string description: Cliente para geração do crédito devolucao: type: object allOf: – #/definitions/recValorDevolucao description: Informações para devolução recValorDevolucao: description: Informaçoes para devolução type: object required: – vencimentoDuplicata – valorDevolucao properties: vencimentoDuplicata: type: string format: date description: Vencimento da duplicata – Obrigatório quando informado valor da devolução valorDevolucao: type: string description: Valor da devolução imediata contaInternaId: type: string description: Identificador da conta interna para geração da devolução imediata transacaoTesourariaId: type: string description: Identificador da transação de débito para a geração da devolução imediata recTransacoesBaixaPorCredito: description: Recebe os identificadores das transações de baixa por aproveitamento de crédito. type: object required: – transacaoBaixaDuplicataId – transacaoBaixaCreditoId properties: transacaoBaixaDuplicataId: type: string description: A transação deverá estar parametrizada conforme:\n* Módulo: CRB\n* Tipo movimento: 3 – Subtrai Duplicatas/Outros\n* Tipo baixa: CR – Baixa Crédito ou DV – Devolução\n* Situação: Ativa transacaoBaixaCreditoId: type: string description: A transação deverá estar parametrizada conforme:\n* Módulo: CRB\n* Tipo movimento: 4 – Subtrai Créditos\n* Tipo baixa: CR – Baixa Crédito ou DV – Devolução\n* Situação: Ativa recTransacoesBaixaPorCompensacao: description: Recebe os identificadores das transações de baixa por compensação type: object required: – transacaoBaixaDuplicataContasReceberId – transacaoBaixaDuplicataContasPagarId properties: transacaoBaixaDuplicataContasReceberId: type: string description: A transação deverá estar parametrizada conforme:\n* Módulo: CRB\n* Tipo movimento: 3 – Subtrai Duplicatas/Outros\n* Tipo baixa: CP – Compensação\n* Situação: Ativa transacaoBaixaDuplicataContasPagarId: type: string description: A transação deverá estar parametrizada conforme:\n* Módulo: CPB\n* Tipo movimento: 3 – Subtrai Duplicatas/Outros\n* Tipo baixa: CP – Compensação\n* Situação: Ativa recTransacoesBaixasCompostas: description: Recebe os identificadores das transações para o processo de baixa do contas a receber type: object properties: transacaoBaixaPagamentoId: type: string description: Recebe o identificador da transação de baixa por pagamento da duplicata a receber.\nA transação deverá estar parametrizada conforme:\n* Módulo: CRB\n* Tipo movimento: 3 – Subtrai Duplicatas/Outros\n* Tipo baixa: PG – Pagamento\n* Situação: Ativa transacaoBaixaSubstituicaoId: type: string description: Recebe o identificador da transação de baixa por pagamento da duplicata a pagar.\nA transação deverá estar parametrizada conforme:\n* Módulo: CRB\n* Tipo movimento: 3 – Subtrai Duplicatas/Outros\n* Tipo baixa: SU – Substituição\n* Situação: Ativa transacoesBaixaPorCredito: type: object allOf: – #/definitions/recTransacoesBaixaPorCredito description: Recebe os identificadores das transações de baixa por aproveitamento de crédito. transacoesBaixaPorCompensacao: type: object allOf: – #/definitions/recTransacoesBaixaPorCompensacao description: Recebe os identificadores das transações de baixa por compensação 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 informacoesContabilidade: type: object allOf: – #/definitions/recInformacoesMovimentoContabilidade description: Informações contabilidade e600ccoSugestaoTitulo: type: object allOf: – #/definitions/recGenerico description: Sugestão Conta interna recInformacoesAdicionaisMovimento: description: Informações complementares do movimento de baixa type: object required: – numeroDocumento – portador – carteira – usuarioGerador – dataGeracao 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 portadorAnterior: type: object allOf: – #/definitions/recGenerico description: Portador anterior carteiraAnterior: type: object allOf: – #/definitions/recGenerico description: Carteira anterior 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 da geração do movimento projrs: type: boolean description: Indicativo se o vencimento prorrogado é com ou sem juros recFatoFinanceiro: description: Informações do fato financeiro type: object required: – id – tipoFato – loteFinanceiro properties: id: type: string description: Identificador do fato financeiro tipoFato: type: string allOf: – #/definitions/enumTipoFatoFinanceiro description: Tipo do fato financeiro gerado loteFinanceiro: type: object allOf: – #/definitions/recLoteFinanceiro description: Lote financeiro ligado ao fato financeiro recLoteFinanceiro: description: Informações do lote financeiro type: object required: – id – lote – origem properties: id: type: string description: Identificador do lote financeiro lote: type: string description: Código do lote financeiro origem: type: string allOf: – #/definitions/enumOrigemLoteFinanceiro description: Origem do lote financeiro 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 movimentoBaixa: type: boolean description: Indicativo se o movimento é de baixa fatoFinanceiro: type: object allOf: – #/definitions/recFatoFinanceiro description: Fato financeiro do movimento _discriminator: type: string description: 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: Imposto retido no título 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 parametros: type: string description: Json contendo os ids do perfil tributário e parametros utilizados no cálculo dos impostos recInformacaoMovimentoReceber: description: Informações do movimento do título a receber allOf: – #/definitions/recMovimento – type: object recTituloBaixa: description: Recebe as informações de baixa do título que se deseja efetuar uma baixa type: object required: – tituloId – dataMovimento – valorMovimento properties: tituloId: type: string description: Identificador do título que está sendo baixado numero: type: string description: Número do título que está sendo baixado dataMovimento: type: string format: date description: Data movimento de baixa formaPagamento: type: object allOf: – #/definitions/recGenerico description: Identificador da forma de pagamento. observacao: type: string maxLength: 250 description: Observação do movimento de baixa rateio: type: object allOf: – #/definitions/recRateio description: Rateio valorMovimento: type: string description: Valor do movimento de baixa valorJuros: type: string description: Valor de juros do movimento de baixa valorMulta: type: string description: Valor de multa do movimento de baixa valorCorrecao: type: string description: Valor da correção do movimento de baixa valorEncargos: type: string description: Valor dos encargos do movimento de baixa valorOutrosAcrescimos: type: string description: Valor de outros acréscimos do movimento de baixa valorDescontos: type: string description: Valor de descontos do movimento de baixa valorOutrosDescontos: type: string description: Valor de outros descontos do movimento de baixa valorCotacaoMovimento: type: string description: Valor de cotação do movimento de baixa valorCotacaoReajuste: type: string description: Valor de cotação do reajuste do movimento de baixa recTituloBaixaMotivosDiversos: description: Payload baixa por motivos diversos type: object required: – tituloId – valorMovimento properties: tituloId: type: string description: Identificador título observacaoMovimento: type: string maxLength: 250 description: Observacao do movimento contaFinanceiraId: type: string description: Identificador conta financeira rateio centroCustoId: type: string description: Identificador centro de custo rateio valorMovimento: type: string description: Valor do movimento da baixa cancelamento recMovimentoTesouraria: description: Movimento gerado na tesouraria type: object required: – contaInterna – transacao – dataMovimento – dataLiberacao – dataContabil – valorMovimento 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 valorMovimento: type: string description: Valor do movimento informacoesAdicionaisMovimentoTesouraria: type: object allOf: – #/definitions/recInformacoesAdicionaisMovimentoTesouraria description: Informações adicionais do movimento da tesouraria recInformacoesAdicionaisMovimentoTesouraria: description: Informações adicionais do movimento da tesouraria type: object properties: 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 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 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 recBaixasCompostas: description: Baixas compostas type: object required: – dataMovimento – filialProcessamento – transacoesBaixa – titulosBaixarDuplicatasReceber properties: dataMovimento: type: string format: date description: Data de movimento de baixa filialProcessamento: type: string description: Filial de processamento transacoesBaixa: type: object allOf: – #/definitions/recTransacoesBaixasCompostas description: Transações de baixa informacoesSaldo: type: object allOf: – #/definitions/recInformacoesSaldoBaixa description: Informações para controle de saldo. Obrigatório quando o valor a receber é maior que o valor a baixar titulosBaixarDuplicatasReceber: type: array items: type: object allOf: – #/definitions/recTituloBaixa minimum: 1 description: Títulos a receber (duplicatas) que serão baixados conforme geração dos fatos tituloBaixarCreditosReceber: type: array items: type: object allOf: – #/definitions/recTituloBaixa description: Títulos a receber de crédito que serão baixados por aproveitamento de crédito contra os títulos a receber (duplicatas) titulosBaixarDuplicatasPagar: type: array items: type: object allOf: – #/definitions/recTituloBaixa description: Títulos a pagar (duplicatas) que serão baixados por compensação contra os títulos a receber (duplicatas) movimentosContasInternas: type: array items: type: object allOf: – #/definitions/recMovimentoTesouraria description: Movimentos de contas internas que serão gerados e ligados aos movimentos de baixas por pagamento dos títulos a receber (duplicatas) titulosReceberSubstitutos: type: array items: type: object allOf: – #/definitions/recTituloContasReceber description: Títulos a receber (duplicatas) que serão gerados e ligados aos movimentos de baixa por substituição dos títulos a receber (duplicatas) recInconsistenciasTitulosBaixa: description: Inconsistências da execução de baixa de títulos type: object required: – tituloBaixa – inconsistenciasTitulo properties: tituloBaixa: type: object allOf: – #/definitions/recTituloBaixa description: Dados do movimento de baixa do título inconsistenciasTitulo: type: array items: type: string minimum: 1 description: Inconsistência do movimento de baixa recInconsistenciasMovimentosContaInterna: description: Inconsistências da execução de baixa de títulos type: object required: – movimentoContaIterna – inconsistenciasMovimento properties: movimentoContaIterna: type: object allOf: – #/definitions/recMovimentoTesouraria description: Dados do movimento de conta interna inconsistenciasMovimento: type: array items: type: string minimum: 1 description: Inconsistência do movimento de conta interna recInconsistenciasGerarBaixasCompostas: description: Inconsistências da execução de baixa de títulos type: object required: – inconsistenciasGerais properties: inconsistenciasGerais: type: array items: type: string minimum: 1 description: Inconsistências gerais inconsistenciasTitulosBaixa: type: array items: type: object allOf: – #/definitions/recInconsistenciasTitulosBaixa description: Inconsistências específicas dos movimentos de baixa inconsistenciasMovimentosConta: type: array items: type: object allOf: – #/definitions/recInconsistenciasMovimentosContaInterna description: Inconsistências específicas dos movimentos de conta interna recEnderecoPessoaTitulo: description: Retornar o endereço da pessoa para o front-end type: object required: – id properties: id: type: string description: Identificador da entidade endPes: type: string maxLength: 100 description: Endereço do cliente nenEnd: type: string maxLength: 60 description: Número do endereço cplEnd: type: string maxLength: 200 description: Complemento do endereço cepEnd: type: string maxLength: 20 description: CEP do endereço baiEnd: type: string maxLength: 75 description: Bairro do endereço cidEnd: type: string maxLength: 60 description: Cidade do endereço sigUfs: type: string maxLength: 2 description: Estado do endereço recInfoBoleto: description: Record dos dados do boleto retornado pelo portador externo type: object required: – barcode – ournumber – file properties: barcode: type: string description: Código de barras ournumber: type: string description: Nosso número file: type: string description: Link do boleto recInfoBanco: description: Record dos dados bancários do boleto retornado pelo portador externo type: object required: – bankCode – billetId – transactionId – bankWalletCode – billetDocumentNumber – billetReferenceNumber properties: bankCode: type: string description: Código do banco billetId: type: string description: Identificador do boleto transactionId: type: string description: Identificador da transação bankWalletCode: type: string description: Código da carteira billetDocumentNumber: type: string description: Número do boleto billetReferenceNumber: type: string description: Número de referência do boleto recSupplier: description: Record header para envio de título ao portador externo type: object required: – taxNumber properties: taxNumber: type: string description: CNPJ do sacado bankAccount: type: string description: Conta bancária recTitle: description: Record do título a ser enviado ao portador externo type: object required: – key – value – dueDate – customer properties: key: type: string description: Chave de identificação value: type: string description: Valor dueDate: type: string description: Data de vencimento description: type: string description: Descrição interest: type: object allOf: – #/definitions/recValues description: Juros lateFee: type: object allOf: – #/definitions/recValues description: Multa discount: type: object allOf: – #/definitions/recDiscount description: Descontos customer: type: object allOf: – #/definitions/recCustomer description: Sacado customData: type: object allOf: – #/definitions/recCustomData description: Dados adicionais targetEmails: type: array items: type: string description: Emails recCustomer: description: Record de identificação do sacado para envio de título ao portador externo type: object required: – taxNumber – name – address – neighborhood – zipCode – city – state properties: type: type: string description: Tipo do sacado taxNumber: type: string description: CPF/CNPJ name: type: string description: Nome address: type: string description: Logradouro neighborhood: type: string description: Bairro zipCode: type: string description: CEP city: type: string description: Cidade state: type: string description: UF country: type: string description: País recValues: description: Record base de dados de multa, juros e descontos do título enviado ao portador externo type: object required: – mode properties: mode: type: string allOf: – #/definitions/eValuesMode description: Tipo amount: type: string description: Valor percentage: type: string description: Percentual startDate: type: string format: date-time description: Data inicial recDiscount: description: Record dos dados de desconto para envio de título ao portador externo type: object required: – mode properties: mode: type: string allOf: – #/definitions/eValuesMode description: Tipo amount: type: string description: Valor percentage: type: string description: Percentual limitDate: type: string format: date-time description: Data limite recValue: description: Record dos valores enviados pela Wiipo para realizar a baixa do título type: object required: – payed – original properties: payed: type: string description: Valor pago original: type: string description: Valor original do pagamento recDate: description: Record das data do pagamento do boleto enviados pela Wiipo para realizar a baixa do título type: object required: – payment – deposit properties: payment: type: string format: date-time description: Data do pagamento deposit: type: string format: date-time description: Data do deposito recCustomData: description: Record para envio de dados adicionais ao portador externo type: object properties: id: type: string description: Identificador do título titleNumber: type: string description: Número do título tituloConsulta: description: Titulo consulta type: object required: – identificacaoTitulo properties: identificacaoTitulo: type: string description: Identificação do título retornoTituloImposto: description: Retorno do titulo imposto type: object required: – status – statusDescricao – registro_payload – titulo – identificacaoLote – consultaId properties: status: type: string description: Status do cálculo statusDescricao: type: string maxLength: 1000 description: Descrição do status registro_payload: type: string maxLength: 5000 description: payload com impostos calculados titulo: type: array items: type: object allOf: – #/definitions/recTituloImposto minimum: 1 description: Identificação do título identificacaoLote: type: string description: identificação do lote consultaId: type: string description: Identificador fato calculado recTituloImposto: description: Dados do título financeiro (pagar/receber) type: object required: – empresa – filial – pessoa – numeroTitulo – tipoTitulo – dataEmissao – dataEntrada – vencimentoOriginal – provavelPagamento – valorOriginal – moeda – titPre – valores – informacoesSimulacao 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 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 e066fpg: type: object allOf: – #/definitions/recE066fpg description: Forma pagamento juros: type: object allOf: – #/definitions/recJuros description: Dados para juros multa: type: object allOf: – #/definitions/recMulta description: Dados para multa diaJrs: type: integer format: int64 description: Dias juros diaAtr: type: integer format: int64 description: Dias atraso titPre: type: boolean description: Indicativo se o título é previsto valores: type: object allOf: – #/definitions/recValoresTitulo description: Informações dos valores do título informacoesSimulacao: type: object allOf: – #/definitions/recInfoSimulacaoTitulo description: Informações simulação recImpostosTitulo: description: Record de impostos retidos no título type: object required: – base – valor – tipo_impostos – aliquota properties: base: type: string description: Valor da base valor: type: string description: Valor tipo_impostos: type: string allOf: – #/definitions/enumImpostoRetidoCaixa description: Imposto aliquota: type: number format: double description: Alíquota parametros: type: string description: Json contendos os ids do perfil tributário e parametros utilizados no cálculo dos impostos recInfoSimulacaoTitulo: description: Informações do título imposto simulado type: object required: – tipoBaixa – origemTitulo – agrupador – valoresProporcionaisSimulacao properties: tipoBaixa: type: string allOf: – #/definitions/enumTipoFatoFinanceiro description: Tipo Baixa origemTitulo: type: string allOf: – #/definitions/enumTituloOrigem description: Origem do título agrupador: type: string description: Id do agrupador dos titulos valoresProporcionaisSimulacao: type: object allOf: – #/definitions/recValoresProporcionaisSimulacao description: Valores título recValoresProporcionaisSimulacao: description: Valores proporcionais do título imposto simulado type: object properties: valorLiquido: type: string description: Valor líquido valorMovimento: type: string description: Valor movimento valorDesconto: type: string description: Valor descontos valorOutrosDescontos: type: string description: Valor outros descontos valorJuros: type: string description: Valor Juros valorMulta: type: string description: Valor multa valorOutrosAcrescimos: type: string description: Valor outros acréscimos valorEncargos: type: string description: Valor encargos valorCorrecao: type: string description: Valor correção monetária recGerarRelatorioTitulosLiquidados: description: Record para geração do relatório demonstrativo finaceiro type: object required: – empresaId properties: empresaId: type: string description: ID Empresa filiaisId: type: array items: type: string description: ID Filial clientesId: type: array items: type: string description: ID Cliente gruposEmpresaClienteId: type: array items: type: string description: ID Grupo de empresa do fornecedor titulosId: type: array items: type: string description: ID Título tiposTituloId: type: array items: type: string description: ID Tipo de título numeroTitulo: type: string description: Número do título periodoInicial: type: string format: date description: Data inicial periodoFinal: type: string format: date description: Data final emissaoInicial: type: string format: date description: Data de emissão inicial emissaoFinal: type: string format: date description: Data de emissão final pagamentoInicial: type: string format: date description: Data de pagamento inicial pagamentoFinal: type: string format: date description: Data de pagamento final transacoesId: type: array items: type: string description: ID Transacao situacoesTitulo: type: array items: type: string allOf: – #/definitions/enumSitTit description: Situacao moedasId: type: array items: type: string description: ID Moeda notasFiscaisOrigemId: type: array items: type: string description: ID Nota fiscal de saída origem ordenacao: type: string allOf: – #/definitions/enumOrdenacaoRelatorioTitulosLiquidados description: Ordenação contasInternasId: type: array items: type: string description: ID da conta interna recErroIntegracaoCobrancaBankingPix: description: Record com as informações do erro da integração cobrança pix banking type: object required: – erro – dataHoraErro properties: campo: type: string description: Campo que ocorreu o erro erro: type: string description: Mensagem do erro dataHoraErro: type: string format: date-time description: Data/hora do erro 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