ERP senior X Finanças (erpx_fin)

Contas a Pagar (contas_pagar)

88 views 03/03/2020 07/05/2021 integrador 0

2.0info: 1.29.0 Contas a Pagar description: Serviço de fatos financeiros x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: contas_pagar 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_pagar/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_pagar/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 de títulos do contas a pagar pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de 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 retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_pagar/queries/obterCreditosPagarBaixar: post: description: Retorna créditos 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 pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de 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 totalElements: type: integer format: int64 description: Total de títulos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_pagar/queries/obterSugestaoTitulosV2: 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 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 fornecedorId: 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 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 responses: 200: description: Ok schema: type: object required: – titulos – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recTituloContasPagar minimum: 1 description: Títulos sugeridos totalElements: type: integer format: int64 description: Total de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_pagar/queries/obterMovimentosContasPagar: post: description: Retorna os movimentos de títulos a pagar 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 fornecedor 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 favorecidoId: type: array items: type: string description: Filtro por favorecido 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/recMovimentoPagar 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_pagar/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_pagar/queries/obterTotalCreditosPagarBaixar: post: description: Retorna o total financeiro das créditos 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: – totalCreditos properties: totalCreditos: type: string description: Total dos créditos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_pagar/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: – dataEmissao – dataEntrada – dataBCont – quantidadeTitulos – tipoValor – valor properties: empresa: type: string description: Empresa filial: type: string description: Filial dataEmissao: type: string format: date description: Data de emissão dataEntrada: type: string format: date description: Data de entrada dataBCont: type: string allOf: – #/definitions/enumDataBaseContabil description: Data base contábil fornecedor: type: string description: Fornecedor tipoTitulo: type: string description: Tipo de título transacao: type: string description: Transação quantidadeTitulos: type: integer format: int64 description: Quantidade prefixoTitulo: type: string maxLength: 15 description: Número sugestivo do futuro título moeda: type: string description: Moeda formaPagamento: type: string description: Forma de pagamento contaFinanceira: type: string description: Conta financeira contaContabil: type: string description: Conta contábil centroCusto: type: string description: Centro de custo tipoValor: type: string allOf: – #/definitions/enumTipoValor description: Tipo de valor valor: type: string description: Valor primeiroVencimento: type: string format: date description: Data do primeiro vencimento do primeiro título responses: 200: description: Ok schema: type: object required: – titulos – totalElements properties: titulos: type: array items: type: object allOf: – #/definitions/recSugestaoTituloPagar minimum: 1 description: Títulos totalElements: type: integer format: int64 description: Total de títulos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_pagar/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: baixas responses: 200: description: Ok schema: type: object required: – campos – e501tcp properties: campos: type: array items: type: string minimum: 1 description: Campos editáveis e501tcp: 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: baixas in: query required: true type: string responses: 200: description: Ok schema: type: object required: – campos – e501tcp properties: campos: type: array items: type: string minimum: 1 description: Campos editáveis e501tcp: type: object allOf: – #/definitions/recTituloEdicao description: Título 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /contas_pagar/queries/obterTitulosPagar: post: description: Obtém os títulos de contas a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: empresas: type: array items: type: string description: Identificadores das empresas filiais: type: array items: type: string description: Identificadores das filiais fornecedores: type: array items: type: string description: Identificadores dos fornecedores 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 de títulos notasEntrada: type: array items: type: string description: Identificadores das notas de entrada tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: Tipo de vencimento 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 modalidadeTitulo: type: string allOf: – #/definitions/enumModalidadeTitulo description: Modalidade do título vencimentoInicial: type: string format: date description: Vencimento inicial vencimentoFinal: type: string format: date description: Vencimento final dataBase: type: string format: date description: Data base para o cálculo possível dos títulos em aberto pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de 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 totalElements: type: integer format: int64 description: Total de títulos 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_pagar/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_pagar/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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_pagar/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 – 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_pagar/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 – 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_pagar/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_pagar/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_pagar/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_pagar/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_pagar/actions/gerarBaixasCompostasPagar: 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 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_pagar/actions/simularCalculoImpostoContasPagar: post: description: Simular cálculo do imposto para o contas a pagar 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_pagar/actions/consultaStatusLoteTituloImposto: post: description: Permite consultar o status do cálculo do imposto para o lote desejado do contas a pagar 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_pagar/actions/salvarTitulosContasPagar: post: description: Geração de Títulos de Contas a Pagar 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/recE501tcp minimum: 1 description: Títulos do contas a pagar loteFinanceiroReprocessamentoId: type: string description: Identificador do Lote Financeiro para 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_pagar/events/geracaoTituloNotaFiscalEntradaProcessadoComSucesso: 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/recTituloNotaFiscalEntrada minimum: 1 description: Titulos gerados responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /contas_pagar/events/geracaoTituloNotaFiscalEntradaProcessadoComErro: 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 enumTipoValor: description: Tipo de valor type: string enum: – IGUALITARIO – DIVIDIDO enumOpcaoMovimento: description: Opção de Movimento type: string enum: – OUTROS – BAIXAS – TODOS 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 enumTipObs: description: Tipo de Observação type: string enum: – VM – VA – VP – VX – VV enumTipTcc: description: Tipo da conta corrente type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 enumDebCre: description: Tipo de Operação type: string enum: – VD – VC enumTipJrs: description: Tipo de Juros type: string enum: – VS – VC enumTipPgt: description: Tipo de Pagamento type: string enum: – VCA – VCC – VCH – VCP – VCS – VDB – VDC – VDF – VDS – VDJ – VDO – VDP – VDV – VEC – VFG – VGS – VIP – VLC – VOP – VPA – VPC – VPO – VPS – VPT – VTE – VTN – VTO – VTR – VOU enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC enumProcessoFatoFinanceiro: description: Processo do Fato Financeiro type: string enum: – ENTRADA_MANUAL – ENTRADA_VIA_NOTA_NFC – ENTRADA_VIA_NOTA_NFV – BAIXA_MANUAL – BAIXA_AUTOMATICA enumTipoValorTitulo: description: Tipo de valor do título type: string enum: – ABERTOS – LIQUIDADOS – AMBOS enumTipCnc: description: Tipo de Cancelamento type: string enum: – VA – VM enumTipImp: description: Tipo de Imposto type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V28 – V29 – V30 – V31 – V32 – V33 – V34 – V35 – V36 – V37 – V38 – V39 – V40 – V41 – V42 – V43 – V44 – V45 – V46 – V47 – V48 – V49 – V50 – V51 – V52 – V53 – V54 – V55 – V56 – V57 – V58 – V59 – V60 – V61 – V62 – V63 – V64 – V65 – V66 – V67 – V68 – V69 – V95 – V96 – V97 – V98 – V99 enumTipoConta: description: Tipo de conta type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 enumTipoJuros: description: Tipo de Juros type: string enum: – VS – VC 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 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 – 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 enumDataBaseContabil: description: Data base contábil type: string enum: – V1 – V2 enumModalidadeTitulo: description: Modalidade do título type: string enum: – PREVISTOS – EFETIVOS – AMBOS enumTipoVencimento: description: Tipo de Vencimento type: string enum: – PROVAVEL_PAGAMENTO – VENCIMENTO_ORIGINAL – VENCIMENTO_PRORROGADO 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 enumImpostos: description: Tipo de imposto type: string enum: – ISS_RETIDO – PIS_RETIDO – COFINS_RETIDO – CSLL – IRRF userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT 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 recPageRequest: description: Record para paginação e ordenação type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderyBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o 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) 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 – cotacaoEmissao properties: moeda: type: object allOf: – #/definitions/recE031MOE 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 recTituloFinanceiro: description: Dados do título financeiro (pagar/receber) discriminator: _discriminator type: object required: – id – empresa – filial – pessoa – numeroTitulo – tipoTitulo – transacao – dataEmissao – dataEntrada – vencimentoOriginal – provavelPagamento – situacaoTitulo – 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: 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 dataMovimento: type: string format: date description: Data movimento de baixa formaPagamentoId: type: string description: Identificador da forma de pagamento. observacao: type: string maxLength: 250 description: Observação do movimento de baixa projetoId: type: string description: Identificador do projeto faseProjetoId: type: string description: Identificador da fase do projeto contaContabilId: type: string description: Identificador da conta contábil contaFinanceiraId: type: string description: Identificador da conta financeira centroCustosId: type: string description: Identificador do centro de custos 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 recInformacoesAdicionaisTitulo: description: Indicativo das informações adicionados do título discriminator: _discriminator type: object required: – origem – portador – carteira – _discriminator properties: origem: type: object allOf: – #/definitions/recOrigemTitulo description: Origem do título observacao: type: string maxLength: 250 description: Observação naturezaGasto: type: object allOf: – #/definitions/recGenerico description: Natureza Gasto grupoContas: type: object allOf: – #/definitions/recGenerico description: Grupo Contas formaPagamento: type: object allOf: – #/definitions/recGenerico description: Forma Pagamento portador: type: object allOf: – #/definitions/recGenerico description: Portador carteira: type: object allOf: – #/definitions/recGenerico description: Carteira codigoBarras: type: string maxLength: 50 description: Código Barra usuarioGerador: type: string description: Usuário que realizou o movimento dataGeracao: type: string format: date-time description: Data da geração do movimento _discriminator: type: string description: recTituloContasPagar: description: Título a pagar allOf: – #/definitions/recTituloFinanceiro – type: object required: – informacoesAdicionais properties: descontos: type: object allOf: – #/definitions/recDescontos description: Dados para descontos do título a pagar dadosBancarios: type: object allOf: – #/definitions/recDadosBancarios description: Dados bancários do título informacoesAdicionais: type: object allOf: – #/definitions/recInformacoesAdicionaisTituloPagar description: Informações adicionais do título a pagar recInformacoesAdicionaisTituloPagar: description: Indicativo das informações adicionados do título pagar allOf: – #/definitions/recInformacoesAdicionaisTitulo – type: object properties: favorecido: type: object allOf: – #/definitions/recGenerico description: Identificador do favorecido recOrigemTitulo: description: Identificação da origem do título type: object required: – id – descricao properties: id: type: string description: Identificador da origem descricao: type: string description: Descrição da origem 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 type: object 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 percentual: type: number format: double description: Percentual/Valor Desconto minimum: 0.00 maximum: 999.99 valor: type: string description: Valor Desconto minimum: 0.00 maximum: 9999999999999.99 recRateio: description: Indicativo das informações para geração de rateio type: object properties: projeto: type: object allOf: – #/definitions/recGenerico description: Indicativo do projeto faseProjeto: type: object allOf: – #/definitions/recGenerico description: Indicativo da fase do projeto contaFinanceira: type: object allOf: – #/definitions/recGenerico description: Indicativo da conta financeira contaContabil: type: object allOf: – #/definitions/recGenerico description: Indicativo da conta contábil centroCustos: type: object allOf: – #/definitions/recGenerico description: Indicativo do centro de custos recValoresNegociados: description: Indicativo das informações negociadas do título type: object properties: dataLimiteNegociacao: type: string format: date description: Data Valores Negociados juroNegociado: type: string description: Valor Juros Negociados minimum: 0.00 maximum: 9999999999999.99 multaNegociada: type: string description: Valor Multa Negociada minimum: 0.00 maximum: 9999999999999.99 descontoNegociado: type: string description: Valor Descontos Negociados minimum: 0.00 maximum: 9999999999999.99 outrosValoresNegociados: type: string description: Outros Negociados minimum: 0.00 maximum: 9999999999999.99 cotacaoNegociada: type: string description: Cotação Moeda Negociada minimum: 0.00 maximum: 999999999.9999999999 recDadosBancarios: description: Indicativo das informações da conta bancária do título a pagar type: object properties: bancoId: type: object allOf: – #/definitions/recGenerico description: Banco/Agência/Nº Conta Fornecedor agencia: type: string description: Agência Fornecedor contaCorrente: type: string maxLength: 14 description: Nº CC no Banco digitoVerificador: type: string maxLength: 2 description: Dígito da Conta Corrente tipoConta: type: string allOf: – #/definitions/enumTipTcc description: Tipo de Conta recMovimentoPagar: description: Movimento de um título a pagar type: object required: – titulo – movimento properties: titulo: type: object allOf: – #/definitions/recTituloContasPagar description: Informação do título movimento: type: object allOf: – #/definitions/recInformacaoMovimentoPagar description: Informação do movimento 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: 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 recInformacaoMovimentoPagar: description: Informações do movimento do título a pagar allOf: – #/definitions/recMovimento – type: object properties: dadosBancarios: type: object allOf: – #/definitions/recDadosBancarios description: Dados bancários do movimento de baixa tipoPagamento: type: string allOf: – #/definitions/enumTipPgt description: Tipo de pagamento recInformacoesAdicionaisMovimento: description: Informações complementares do movimento de baixa type: object required: – 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 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 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/recValoresImpostos description: Valores referente a impostos valorLiquido: type: string description: Valor Líquido recValoresImpostos: description: Valores de impostos calculados durante uma baixa type: object required: – tipoImposto – base – valor – aliquota properties: tipoImposto: type: string allOf: – #/definitions/enumImpostos description: Tipo 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 recBaixasCompostas: description: Baixas compostas type: object required: – dataMovimento – processoFatoFinanceiro – transacoesBaixa – titulosBaixarDuplicatasPagar properties: dataMovimento: type: string format: date description: Data de movimento de baixa filialProcessamento: type: string description: Filial de processamento processoFatoFinanceiro: type: string allOf: – #/definitions/enumProcessoFatoFinanceiro description: Processo do fato financeiro transacoesBaixa: type: object allOf: – #/definitions/recTransacoesBaixasCompostas description: Transações de baixa titulosBaixarDuplicatasPagar: 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 tituloBaixarCreditosPagar: 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) titulosBaixarDuplicatasReceber: type: array items: type: object allOf: – #/definitions/recTituloBaixa description: Títulos a receber (duplicatas) que serão baixados por compensação contra os títulos a pagar (duplicatas) movimentosContasInternas: type: array items: type: object allOf: – #/definitions/recMovimentoContaInterna description: Movimentos de contas internas que serão gerados e ligados aos movimentos de baixas por pagamento dos títulos a pagar (duplicatas) titulosPagarSubstitutos: type: array items: type: object allOf: – #/definitions/recSugestaoTituloPagar description: Títulos a receber (duplicatas) que serão gerados e ligados aos movimentos de baixa por substituição dos títulos a pagar (duplicatas) simulacaoImpostos: type: boolean description: Identificador para simulação dos impostos no processo de baixa default: false recTransacoesBaixasCompostas: description: Recebe os identificadores das transações para o processo de baixa do contas a pagar type: object properties: transacaoBaixaPagamentoId: type: string description: Recebe o identificador da transação de baixa por pagamento da duplicata a pagar.\n A transação deverá estar parametrizada conforme:\n * Módulo: CPB\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.\n A transação deverá estar parametrizada conforme:\n * Módulo: CPB\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 recMovimentoContaInterna: description: Recebe as informações para a geração do movimento da conta interna na tesouraria type: object required: – contaInternaId – valorMovimento – transacaoMovimentoId – dataMovimento – dataLiberacao – dataContabil properties: contaInternaId: type: string description: Identificador da conta interna para a geração do movimento valorMovimento: type: string description: Valor do movimento transacaoMovimentoId: type: string description: Identificador da transação para a geração do movimento dataMovimento: type: string format: date description: Data do movimento para a geração do movimento dataLiberacao: type: string format: date description: Data de liberação para a geração do movimento dataContabil: type: string format: date description: Data contábil numeroDocumento: type: string description: Número do documento para a geração do movimento tipoDocumento: type: string description: Tipo do documento naturezaGasto: type: string description: Natureza de Gasto historico: type: string maxLength: 100 description: Histórico para a geração do movimento observacao: type: string maxLength: 250 description: Observação para a geração do movimento numeroCheque: type: integer format: int64 description: Número do cheque – quando a transação for do tipo C-Débito por Cheque ou T-Cheque transferência ou A – Aviso de débito, este campo se torna obrigatório nomeRecebedor: type: string maxLength: 100 description: Nome do recebedor rateio: type: object allOf: – #/definitions/recRateio description: Campos do rateio recSugestaoTituloPagar: description: Record para sugestão de títulos a pagar type: object required: – numTit – vlrOri – vctOri – e031moe – cotEmi – e070emp – e070fil – e002tpt – e001pes – e001tns – sitTit – datEmi – datEnt – vctPro – proJrs – datPpt – e039por properties: numTit: type: string maxLength: 15 description: Número Título vlrOri: type: string description: Valor Original vctOri: type: string format: date description: Vencimento Original e031moe: type: object allOf: – #/definitions/recE031MOE description: Moeda (código – descrição) cotEmi: type: string description: Valor cotação moeda obsTcp: type: string maxLength: 250 description: Observação do Título e070emp: type: object allOf: – #/definitions/recGenerico description: Empresa e070fil: type: object allOf: – #/definitions/recGenerico description: Filial e002tpt: type: object allOf: – #/definitions/recGenerico description: Tabela parâmetro do Tipo do Título e001pes: type: object allOf: – #/definitions/recGenerico description: Pessoa Fornecedor e001tns: type: object allOf: – #/definitions/recGenerico description: Transação sitTit: type: string allOf: – #/definitions/enumSitTit description: Situação Título e077fav: type: object allOf: – #/definitions/recGenerico description: Favorecido datEmi: type: string format: date description: Data de Emissão datEnt: type: string format: date description: Data entrada vctPro: type: string format: date description: Vencimento Prorrogado/Juros proJrs: type: boolean description: Prorrogação c/ Juros datPpt: type: string format: date description: Data Provável Pagamento e039por: type: object allOf: – #/definitions/recGenerico description: Portador e033crt: type: object allOf: – #/definitions/recGenerico description: Carteira datCjm: type: string format: date description: Data Calculado Juros dscNeg: type: string description: Valor Desconto negociado tipVal: type: string allOf: – #/definitions/enumTipoValor description: tipo geração valor titulo e066fpgCodFpg: type: object allOf: – #/definitions/recGenerico description: forma pagamento e091plfFinRat: type: object allOf: – #/definitions/recGenerico description: conta financeira e045plaFinRat: type: object allOf: – #/definitions/recGenerico description: conta contábil e044ccuFinRat: type: object allOf: – #/definitions/recGenerico description: centro custo codTri: type: string maxLength: 5 description: Código Tributação p/ DARF e047ntg: type: object allOf: – #/definitions/recGenerico description: Natureza Gasto e023crp: type: object allOf: – #/definitions/recGenerico description: Grupo Contas Pagar e029mpt: type: object allOf: – #/definitions/recGenerico description: Motivo Prorrogação vlrAbe: type: string description: Valor Aberto datNeg: type: string format: date description: Data Valores Negociados jrsNeg: type: string description: Valor Juros Negociados mulNeg: type: string description: Valor Multa Negociada outNeg: type: string description: Outros Negociados cotNeg: type: string description: Cotação Moeda Negociada usuNeg: type: integer format: int64 description: Usuário Valores Negociados corNeg: type: number format: double description: Controle de Correções antDsc: type: boolean description: Calcula Desc. Antecipação datDsc: type: string format: date description: Data/Tolerância Desconto tolDsc: type: integer format: int64 description: Tolerância Desconto perDsc: type: number format: double description: Percentual/Valor Desconto vlrDsc: type: string description: Valor Desconto e030ban: type: object allOf: – #/definitions/recGenerico description: banco e030age: type: string description: agência ccbFor: type: string description: conta corrente fornecedor digCcb: type: string description: digito conta corrente fornecedor tipTcc: type: string allOf: – #/definitions/enumTipTcc description: Tipo de Conta titBan: type: string maxLength: 20 description: Número Título Banco priPgt: type: integer format: int64 description: Prioridade Pagamento Título perMul: type: number format: double description: Percentual/Tolerância Multa tolMul: type: integer format: int64 description: Dias Tolerância Multa jrsDia: type: number format: double description: Valor Juros 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 sitAnt: type: string allOf: – #/definitions/enumSitTit description: Situação Anterior e037frj: type: object allOf: – #/definitions/recGenerico description: Fórmula Reajuste ultPgt: type: string format: date description: Data Último Pagamento codBar: type: string maxLength: 50 description: Código Barra tipEfe: type: string allOf: – #/definitions/enumTipCnc description: Tipo Efetivação datPre: type: string format: date description: Data Entrada da Previsão vlrPre: type: string description: Valor Previsto numArb: type: integer format: int64 description: Nº Arquivo Banco tipImp: type: string allOf: – #/definitions/enumTipImp description: Tipo Imposto gerTep: type: boolean description: Gerou título estorno pagamento numPge: type: string maxLength: 10 description: Título PE impEnt: type: boolean description: Gerou Imposto Entrada e039porPorAnt: type: object allOf: – #/definitions/recGenerico description: Portador Anterior e001tnsTnsPre: type: object allOf: – #/definitions/recGenerico description: Transação de Previsão 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: CPB\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: CPB\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 recE031MOE: description: Record para moeda type: object required: – id – codMoe – desMoe – sigMoe properties: id: type: string description: Identificador codMoe: type: string maxLength: 5 description: Código desMoe: type: string maxLength: 60 description: Descrição sigMoe: type: string maxLength: 5 description: Símbolo label: type: string maxLength: 65 description: Label 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 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/recMovimentoContaInterna description: Dados do movimento de conta interna inconsistenciasMovimento: type: array items: type: string minimum: 1 description: Inconsistência do movimento de conta interna recFilterTitulosPagar: description: Record de filtro para obtenção dos títulos a pagar type: object properties: empresas: type: array items: type: string description: Identificadores das empresas (E070emp) filiais: type: array items: type: string description: Identificadores das filiais (E070fil) fornecedores: type: array items: type: string description: Identificadores dos fornecedores (E001pes) tipoTitulos: type: array items: type: string description: Identificadores dos tipos de título (E002tpt) transacoes: type: array items: type: string description: Identificadores das transações (E001tns) numeroTitulo: type: array items: type: string description: Números dos títulos notasEntrada: type: array items: type: string description: Identificadores das notas de entrada notasSaida: type: array items: type: string description: Identificadores das notas de saída tipoVencimento: type: string allOf: – #/definitions/enumTipoVencimento description: Qual vencimento será considerado na busca dos títulos formaPagamento: type: array items: type: string description: Identificador das formas de pagamento 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 ignorarEntradaViaTesouraria: type: boolean description: Ignorar o fato financeiro ENTRADA_VIA_TESOURARIA recTituloPagar: description: Record de títulos do contas a pagar type: object required: – id – e070fil – e002tpt – e001pes – e001tns – numTit – datEmi – titPre – titAdt – sitTit – vctOri – vctPro – datPpt – datEnt – valores properties: id: type: string description: Identificador do título e070fil: type: object allOf: – #/definitions/recE070FIL description: Filial + Empresa e002tpt: type: object allOf: – #/definitions/recGenerico description: Tipo de título e001pes: type: object allOf: – #/definitions/recGenerico description: Pessoa – Fornecedor e001tns: type: object allOf: – #/definitions/recGenerico description: Transação e066fpg: type: object allOf: – #/definitions/recGenerico description: Forma pagamento e031moe: type: object allOf: – #/definitions/recGenerico description: Moeda (código – descrição) e091plfFinRat: type: object allOf: – #/definitions/recGenerico description: Conta Financeira e044ccuFinRat: type: object allOf: – #/definitions/recGenerico 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 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 recValoresTitulo: description: Record de valores do título do contas a pagar type: object required: – vlrOri – vlrAbe – vlrDsc – vlrOde – vlrJrs – vlrMul – vlrOac – vlrEnc – vlrCor – vlrLiq properties: vlrOri: type: string description: Valor original do título vlrAbe: type: string description: Valor aberto do título 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 recTituloNotaFiscalEntrada: description: Resumo das informações do título gerado por nota fiscal de entrada 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) recE501tcp: description: Título do contas a pagar type: object required: – e070emp – e070filCodFil – numTit – e002tptCodTpt – e001pesCodFor – e001tnsCodTns – sitTit – datEmi – datEnt – vctOri – vlrOri – proJrs – datPpt – e039porCodPor properties: id: type: string description: Id da entidade e070emp: type: string description: Empresa e070filCodFil: type: string description: Filial numTit: type: string maxLength: 15 description: Nº Título e002tptCodTpt: type: string description: Tipo Título e001pesCodFor: type: string description: Fornecedor fatoFinanceiro: type: string description: Identificador do fato financeiro do título e001tnsCodTns: type: string description: Transação obsTcp: type: string maxLength: 250 description: Observação sitTit: type: string description: Situação codTri: type: string maxLength: 5 description: Código Tributação para DARF e001pesCodFav: type: string description: Favorecido e047ntg: type: string description: Natureza Gasto e615prjFinRat: type: string description: Projeto e615fpjFinRat: type: string description: Fase e091plfFinRat: type: string description: Conta Financeira e045plaFinRat: type: string description: Conta Contábil Reduzida e044ccuFinRat: type: string description: Centro de Custo e023crp: type: string description: Grupo Contas Pagar datEmi: type: string format: date description: Data Emissão datEnt: type: string format: date description: Data Entrada vctOri: type: string format: date description: Vencimento Original vlrOri: type: string description: Valor Original minimum: 0.00 maximum: 9999999999999.99 e031moe: type: string description: Moeda Base vctPro: type: string format: date description: Vencimento Prorrogado/Juros proJrs: type: boolean description: Prorrogação c/ Juros e029mpt: type: string description: Motivo Prorrogação e066fpgCodFpg: type: string description: Forma Pagamento vlrAbe: type: string description: Valor Aberto minimum: 0.00 maximum: 9999999999999.99 datNeg: type: string format: date description: Data Valores Negociados jrsNeg: type: string description: Valor Juros Negociados minimum: 0.00 maximum: 9999999999999.99 mulNeg: type: string description: Valor Multa Negociada minimum: 0.00 maximum: 9999999999999.99 dscNeg: type: string description: Valor Descontos Negociados minimum: 0.00 maximum: 9999999999999.99 outNeg: type: string description: Outros Negociados minimum: 0.00 maximum: 9999999999999.99 cotNeg: type: number format: double description: Cotação Moeda Negociada minimum: 0.00 maximum: 999999999.9999999999 datPpt: type: string format: date description: Data Provável Pagamento antDsc: type: boolean description: Calcula Desc. Antecipação datDsc: type: string format: date description: Data/Tolerância Desconto tolDsc: type: integer format: int64 description: Tolerância Desconto minimum: -9999 maximum: 9999 perDsc: type: number format: double description: Percentual/Valor Desconto minimum: 0.00 maximum: 999.99 vlrDsc: type: string description: Valor Desconto minimum: 0.00 maximum: 9999999999999.99 e039porCodPor: type: string description: Portador e033crtCodCrt: type: string description: Carteira e030ban: type: string description: Banco/Agência/Nº Conta Fornecedor e030age: type: string description: Agência Fornecedor ccbFor: type: string maxLength: 14 description: Nº CC no Banco tipTcc: type: string description: Tipo de Conta titBan: type: string maxLength: 20 description: Número Título Banco priPgt: type: integer format: int64 description: Prioridade Pagamento Título minimum: 0 maximum: 999999999 perMul: type: number format: double description: Percentual/Tolerância Multa minimum: 0.00 maximum: 999.99 tolMul: type: integer format: int64 description: Dias Tolerância Multa minimum: 0 maximum: 9999 jrsDia: type: number format: double description: Valor Juros Dia minimum: 0.00 maximum: 9999999.99 perJrs: type: number format: double description: Percentual/Tipo Juros minimum: 0.00 maximum: 999.99 tipJrs: type: string description: Tipo de Juros tolJrs: type: integer format: int64 description: Dias Tolerância Juros minimum: 0 maximum: 9999 datCjm: type: string format: date description: Data último cálculo juros usuSit: type: integer format: int64 description: Usuário Responsável Situação minimum: 0 sitAnt: type: string description: Situação Anterior cotEmi: type: string description: Cotação Moeda Emissão minimum: 0.00 maximum: 999999999.9999999999 e037frj: type: string description: Fórmula Reajuste usuNeg: type: integer format: int64 description: Usuário Valores Negociados minimum: 0 corNeg: type: number format: double description: Controle de Correções minimum: 0.00 maximum: 9999999999999.99 ultPgt: type: string format: date description: Data Último Pagamento e039porPorAnt: type: string description: Portador Anterior e033crtCrtAnt: type: string description: Carteira Anterior datUcm: type: string format: date description: Data Última Cotação Valorizada cotUcm: type: number format: double description: Cotação Última Valorização minimum: 0.00 maximum: 999999999.9999999999 codBar: type: string maxLength: 50 description: Código Barra tipEfe: type: string description: Tipo Efetivação e001tnsTnsPre: type: string description: Transação de Previsão datPre: type: string format: date description: Data Entrada da Previsão vlrPre: type: string description: Valor Previsto minimum: 0.00 maximum: 9999999999999.99 numArb: type: integer format: int64 description: Nº Arquivo Banco minimum: 0 maximum: 999999999 tipImp: type: string description: Tipo Imposto gerTep: type: boolean description: Gerou título estorno pagamento numPge: type: string maxLength: 10 description: Título PE impEnt: type: boolean description: Gerou Imposto Entrada digCcb: type: string maxLength: 2 description: Dígito da Conta Corrente excluido: type: boolean description: Indica se o registro foi excluído recTituloEdicao: description: Record de títulos da edição type: object required: – id properties: id: type: string description: Identificador e070filCodFil: type: object allOf: – #/definitions/recGenerico description: Filial e002tptCodTpt: type: object allOf: – #/definitions/recGenerico description: Tipo de título e001pesCodFor: type: object allOf: – #/definitions/recGenerico description: Fornecedor e001tnsCodTns: type: object allOf: – #/definitions/recGenerico description: Transação e039porCodPor: type: object allOf: – #/definitions/recGenerico description: Portador e033crtCodCrt: type: object allOf: – #/definitions/recGenerico description: Carteira e091plfFinRat: type: object allOf: – #/definitions/recGenerico description: Conta Financeira e045plaFinRat: type: object allOf: – #/definitions/recGenerico description: Conta contábil e044ccuFinRat: type: object allOf: – #/definitions/recGenerico description: Centro de Custo e070emp: type: object allOf: – #/definitions/recGenerico description: Empresa e031moe: type: object allOf: – #/definitions/recGenerico description: Moeda e066fpg: type: object allOf: – #/definitions/recGenerico description: Forma de Pagamento e023crp: type: object allOf: – #/definitions/recGenerico description: Grupo de contas e030ban: type: object allOf: – #/definitions/recGenerico description: Banco e030age: type: string description: Agencia numTit: type: string description: Número datEmi: type: string format: date description: Data de Emissão datEnt: type: string format: date description: Data de Entrada vlrAbe: type: string description: Valor aberto vlrOri: type: string description: Valor original vctOri: type: string format: date description: Vencimento original sitTit: type: string allOf: – #/definitions/enumSitTit description: Situação obsTcp: type: string description: Observação cotEmi: type: string description: Cotação vctPro: type: string format: date description: Vencimento prorrogado proJrs: type: boolean description: Prorroga juros datPpt: type: string format: date description: Data tipTcc: type: string allOf: – #/definitions/enumTipTcc description: Tipo da Conta ccbFor: type: string description: Numero conta digCcb: type: string description: Dígito da conta codBar: type: string description: Código de Barras datNeg: type: string format: date description: Data da Negociação jrsNeg: type: string description: Juros Negociados mulNeg: type: string description: Multa Negociado dscNeg: type: string description: Descontos Negociados outNeg: type: string description: Outras negociações cotNeg: type: string description: Cotação Negociada antDsc: type: boolean description: Antecipa desconto datDsc: type: string format: date description: Data do Desconto perDsc: type: number format: double description: Percentual de Desconto vlrDsc: type: string description: Valor do Desconto perMul: type: number format: double description: Percentual de Multa tolMul: type: integer format: int64 description: Tolerância da Multa jrsDia: type: number format: double description: Juros ao dia perJrs: type: number format: double description: Percentual de Juros tipJrs: type: string allOf: – #/definitions/enumTipJrs description: Tipo de juros tolJrs: type: integer format: int64 description: Tolerância dos Juros impostos: type: array items: type: object allOf: – #/definitions/recImpostosTitulo description: Impostos retidos 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 dos impostos calculados titulo: type: array items: type: object allOf: – #/definitions/recTituloImposto minimum: 1 description: Record 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 e066fpgCodFpg: type: object allOf: – #/definitions/recGenerico 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 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 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 recImpostosTitulo: description: Record de impostos retidos no título type: object required: – base – aliquota – valor – tipoImposto properties: id: type: string description: Identificdor base: type: string description: Valor base aliquota: type: number format: double description: Alíquota do imposto valor: type: string description: Valor do imposto tipoImposto: type: string allOf: – #/definitions/enumImpostos description: Tipo do imposto 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