integration_nfs

2.0info: 3.69.0 integration_nfs description: Serviço para integração de títulos (pagar/receber) com o serviço de nota fiscal de saída x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: integration_nfs 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: /integration_nfs/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 /integration_nfs/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 /integration_nfs/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 /integration_nfs/actions/gerarTitulosNotaFiscalSaida: post: description: Gerar Título via processo de nota fiscal de saida tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notaFiscalSaida – parcelas properties: notaFiscalSaida: type: object allOf: – #/definitions/recNotaFiscalSaida description: Nota fiscal saida notaFiscalDados: type: object allOf: – #/definitions/recNotaFiscalDados description: Dados nota fiscal parcelas: type: array items: type: object allOf: – #/definitions/recParcela minimum: 1 description: Parcelas loteFinanceiroReprocessamentoId: type: string description: Lote Financeiro reprocessamento agreement: type: object allOf: – #/definitions/recAgreement description: Informações do contrato responses: 200: description: Ok schema: type: object required: – loteFinanceiroId properties: loteFinanceiroId: type: string description: Lote financeiro gerado para o processo de geração de títulos via nota fiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_nfs/actions/excluirTitulosNotaFiscalSaida: post: description: Excluir Título via processo de nota fiscal de saida tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notaFiscalSaidaId properties: notaFiscalSaidaId: type: string description: Identificador da nota fiscal fatoContabilId: type: string description: Identificador do fato contabil responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_nfs/actions/validarExclusaoTitulosNotaFiscalSaida: post: description: Validar exclusão de título via processo de nota fiscal de saida tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notaFiscalSaidaId properties: notaFiscalSaidaId: type: string description: Identificador da nota fiscal responses: 200: description: Ok schema: type: object required: – exclusaoPermitida properties: exclusaoPermitida: type: boolean description: Identificador de permissão de exclusão motivo: type: string description: Mensagem indicando o motivo da não permissão de exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_nfs/actions/deleteInvoiceCommissions: post: description: Excluir comissões de uma nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – invoiceId – commissionType properties: invoiceId: type: string description: Id da nota fiscal commissionType: type: string allOf: – #/definitions/enumCommissionType description: Tipo da comissão responses: 200: description: Ok schema: type: object required: – invoiceId properties: invoiceId: type: string description: Id da nota fiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_nfs/actions/canDeleteInvoiceCommissions: post: description: Pode estornar as comissões de uma nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – invoiceId – commissionType properties: invoiceId: type: string description: Id da nota fiscal commissionType: type: string allOf: – #/definitions/enumCommissionType description: Tipo da comissão responses: 200: description: Ok schema: type: object required: – canDelete properties: canDelete: type: boolean description: Pode excluir comissão message: type: string description: Mensagem de motivo da não exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_nfs/actions/createCommission: post: description: Incluir um registro de comissão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – commission properties: commission: type: array items: type: object allOf: – #/definitions/recCommissionData minimum: 1 description: Dados para inclusão de comissões responses: 200: description: Ok schema: type: object required: – id properties: id: type: array items: type: string minimum: 1 description: Id do registro criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration_nfs/events/excluirTitulosNotaFiscalSaidaProcessadoComSucesso: post: description: Evento de exclusão de títulos via nota fiscal processado com sucesso x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId – groupId properties: controlProcessId: type: string description: ticket groupId: type: string description: Agrupador responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration_nfs/events/excluirTitulosNotaFiscalSaidaProcessadoComErro: post: description: Evento de exclusão de títulos via nota fiscal processado com erro x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId – groupId – message – stackTrace properties: controlProcessId: type: string description: ticket groupId: type: string description: Agrupador message: type: string description: Mensagem de Erro stackTrace: type: string description: Stack de Erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumOrigemDocumento: description: Origem do documento type: string enum: – NF_SAIDA – NF_ENTRADA – FINANCEIRO_CP – MANUAL enumTipImpDoc: description: Tipo de imposto documento type: string enum: – IPI – IPI_PRESUMIDO – IPI_DEVOLVIDO – IPI_CREDITADO – ICMS – ICMS_SIMPLES – ICMS_FUTURO – ICMS_DIFERIDO – ICMS_DESONERADO – ICMS_ST – ICMS_UF_DESTINO – ICMS_ISENTAS_OUTRAS – ICMS_CREDITADO – ICMS_EFETIVO – ICMS_ST_RETIDO_ANT – ICMS_ST_FUTURO – ICMS_ST_SOLIDARIO – ICMS_IMPORTACAO – ICMS_DESTINO – FCP – FCP_ST – FCP_UF_DESTINO – FCP_ST_RETIDO_ANT – ISS – COFINS – COFINS_RETIDO – COFINS_RECUPERAR_IMPORTACAO – COFINS_RECUPERAR – COFINS_DEVOLVIDO – PIS – PIS_RETIDO – PIS_RECUPERAR_IMPORTACAO – PIS_RECUPERAR – PIS_DEVOLVIDO – CSLL – ISS_RETIDO – IRRF – INSS – INSS_PATRONAL – IMPOSTO_IMPORTACAO – DIFAL – DIFAL_DEVOLVIDO – CIDE_TECNOLOGIA – FUNRURAL_TOTAL – FUNRURAL_INSS – FUNRURAL_RAT – FUNRURAL_SENAR enumRegimeCaixa: description: Origem do documento type: string enum: – CAIXA – COMPETENCIA tipoDiferimento: description: Indicativo de como será o tipo de diferimento type: string enum: – BASE – VALOR enumMotDes: description: Motivo da desoneração type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V16 – V90 enumOriMer: description: Origem fiscal da mercadoria type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 enumAplLiq: description: Enumeração do tipo de aplicação do valor do imposto type: string enum: – VA – VS – VN enumImpostosRetidos: description: Impostos retidos type: string enum: – ISS_RETIDO – PIS_RETIDO – COFINS_RETIDO – CSLL – IRRF enumTituloOrigem: description: Origem do título type: string enum: – CONTAS_RECEBER – CONTAS_PAGAR enumCommissionType: description: Tipo da comissão type: string enum: – DEBIT – CREDIT enumCommissionStatus: description: Situação da comissão type: string enum: – PENDING – AVAILABLE – IN_PAYMENT – PAID – DEBITED enumAgreementType: description: Tipo do contrato type: string enum: – PURCHASE_PRODUCT – PURCHASE_SERVICE – PURCHASE_LEASING – SALE_PRODUCT – SALE_SERVICE – SALE_LEASING – FINANCIAL_APPLICATION – FINANCIAL_LOAN – FINANCIAL_INVESTMENT_FUND – FINANCIAL_FORWARD_MARKET – FINANCIAL_FUTURE_MARKET – FINANCIAL_OPTIONS_MARKET – FINANCIAL_NDF_MARKET – FINANCIAL_SWAP_MARKET externalIntegration: description: Tipo de integração externa type: string enum: – ECOMMERCE 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 recCommissionData: description: Dados referente a comissões type: object required: – branchId – representativeId – commissionType – value properties: branchId: type: string description: Id da filial representativeId: type: string description: Id do representante commissionType: type: string allOf: – #/definitions/enumCommissionType description: Tipo da comissão value: type: string description: Valor da comissão minimum: -9999999999999.99 maximum: 9999999999999.99 invoice: type: object allOf: – #/definitions/invoice description: Dados da nota fiscal securities: type: object allOf: – #/definitions/securities description: Dados do título no contas a receber status: type: string allOf: – #/definitions/enumCommissionStatus description: Situação da comissão recNotaFiscalSaida: description: Informações da nota fiscal type: object required: – notaFiscalSaidaId – fatoContabilId – filialId – numero – serie – clienteId properties: notaFiscalSaidaId: type: string description: Identificador da nota fiscal fatoContabilId: type: string description: Identificador do fato contabil fatoContabilDescricao: type: string maxLength: 255 description: Descrição do fato contábil origem enderecoCobrancaId: type: string description: Endereço de cobrança filialId: type: string description: Identificador da filial numero: type: integer format: int64 description: Número serie: type: object allOf: – #/definitions/recSerie description: Série clienteId: type: string description: Identificador do cliente contemRetencaoGuia: type: boolean description: Indicativo se a nota fiscal de saida tera guia externalIntegrationType: type: string allOf: – #/definitions/externalIntegration description: Tipo de integração externa saleChannelId: type: string description: Id do canal de venda recNotaFiscalDados: description: Informação dos dados da nota fiscal type: object required: – dadosGerais – itens properties: dadosGerais: type: object allOf: – #/definitions/recDadosGerais description: Informações do cabeçalho itens: type: array items: type: object allOf: – #/definitions/recItens minimum: 1 description: Informações dos itens recDadosGerais: description: Informações do cabeçalho da nota fiscal type: object required: – id – codigoEmpresa – numCgcCpfFilial – codigoFilial – consumidorFinalFil – dataEmissao – dataEntrada – numCgcCpfCliente – codigoCliente – consumidorFinalCliente – serie – numero – valorFinanceiro properties: id: type: string description: Identificador da nota Fiscal codigoEmpresa: type: string description: Código da empresa numCgcCpfFilial: type: string description: Número CNPJ/CPF da filial nifFilial: type: string description: Número de identificação fiscal da filial codigoFilial: type: string description: Código da filial consumidorFinalFil: type: boolean description: Indicativo se é consumidor final dataEmissao: type: string format: date-time description: Data/Hora emissão dataEntrada: type: string format: date-time description: Data/Hora entrada numCgcCpfCliente: type: string description: Número CNPJ/CPF do cliente nifCliente: type: string description: Número de identificação fiscal do cliente codigoCliente: type: string description: Código cliente consumidorFinalCliente: type: boolean description: Indicativo se é consumidor final serie: type: string description: Série da nota fiscal numero: type: string description: Número da nota fiscal valorFinanceiro: type: string description: Valor financeiro recItens: description: Informações dos itens da nota fiscal type: object required: – idItem – valoresItem – operacao properties: idItem: type: string description: Identificação do item no documento valoresItem: type: object allOf: – #/definitions/recValoresItem description: Informações de valores do item operacao: type: string description: Natureza de operação correspondente a transação finalidadeCompraVenda: type: string description: Código da Finalidade produto: type: object allOf: – #/definitions/recProduto description: Informações do produto servico: type: object allOf: – #/definitions/recServico description: Informações do serviço impostos: type: array items: type: object allOf: – #/definitions/recImpostos description: Informações dos impostos recValoresItem: description: Informações de valores do item type: object required: – qtdTributavel – vlrFinanceiro – vlrUnitarioTributavel properties: qtdTributavel: type: number format: double description: Quantidade de venda do item vlrFinanceiro: type: string description: Valor financeiro do item vlrUnitarioTributavel: type: string description: Preço de venda do item vlrDesconto: type: string description: Valor de desconto do item vlrFreteNormal: type: string description: Valor de frete do item vlrFreteDestacado: type: string description: Valor de frete destacado do item vlrSeguro: type: string description: Valor de seguro do item vlrOutrasDespesas: type: string description: Valor de outras despesas do item vlrOutrasDespesasDestacadas: type: string description: Valor de outras despesas destacado do item vlrEncargos: type: string description: Valor de encargos do item vlrEmbalagens: type: string description: Valor de embalagens do item vlrLiquidoSemImposto: type: string description: Valor líquido do item recProduto: description: Informações do produto type: object required: – codigoProduto properties: exIpi: type: string description: Exceção do IPI ncm: type: string description: Nomenclatura Comum do Mercosul codigoProduto: type: string description: Código do produto gtinEan: type: string description: Código EAN origemMercadoria: type: string description: Origem da mercadoria controlaEntradaSaida: type: boolean description: Controle Entrada/Saida ICMS ST (PEPS) recServico: description: Informações do serviço type: object required: – codigoServico properties: nbs: type: string description: Nomenclatura Brasileira de Serviços codigoServico: type: string description: Código do serviço lc1162003: type: string description: Código da Lei complementar 116/2003 recImpostos: description: Informações dos impostoda nota fiscals type: object required: – tipoImposto properties: valorBase: type: string description: Valor base valor: type: string description: Valor imposto aliquota: type: number format: double description: Alíquota do imposto tipoImposto: type: string allOf: – #/definitions/enumTipImpDoc description: Tipo de imposto controleRegimeCaixa: type: string allOf: – #/definitions/enumRegimeCaixa description: Controle regime caixa valorOutras: type: string description: Valor Outras valorIsentas: type: string description: Valor Isentas percentualReducao: type: number format: double description: Percentual de redução da base do imposto percentualMva: type: number format: double description: Percentual da margem de valor Adicionado do ICMS ST situacaoTributaria: type: string description: Situação Tributária enquadramentoIpi: type: string description: Enquadramento de IPI motivoDesoneracao: type: string allOf: – #/definitions/enumMotDes description: Motivo desoneração ICMS origemMercadoria: type: string allOf: – #/definitions/enumOriMer description: Origem fiscal da mercadoria aplicacaoImposto: type: string allOf: – #/definitions/enumAplLiq description: Aplicação do imposto aliquotaDestino: type: number format: double description: Alíquota de ICMS interestadual da UF de destino valorRecolhidoSubstituto: type: string description: Valor recolhido pelo substituto perSuportadoConsumidorFinal: type: number format: double description: Suportado consumidor final valorIcmsStRetido: type: string description: Valor Icms St retido tipoDiferimento: type: string allOf: – #/definitions/tipoDiferimento description: Tipo de diferimento ufOrigem: type: string description: Estado de origem ufDestino: type: string description: Estado de destino finalidadeCompraVenda: type: string description: Finalidade de compra e venda municipio: type: integer format: int64 description: Municipio parametroCalculoImpostos: type: string description: Id do parametro usado para o calculo dos impostos perfilTributarioCalculoImpostos: type: string description: Id do perfil tributário que contem os parâmetros de cálculo recSerie: description: Informações da série type: object required: – id – filialId properties: id: type: string description: Identificador da série filialId: type: string description: Identificador da filial codigo: type: string description: Código descricao: type: string description: Descrição recParcela: description: Dados do título financeiro (pagar/receber) type: object required: – numeroTitulo – tipoTituloId – transacaoId – dataEmissao – dataEntrada – vencimento – valor – moeda properties: numeroTitulo: type: string maxLength: 15 description: Nº Título tipoTituloId: type: string description: Identificador do tipo de título transacaoId: type: string 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 vencimento: type: string format: date description: Vencimento valor: type: string description: Valor minimum: 0.00 maximum: 9999999999999.99 moeda: type: object allOf: – #/definitions/recMoeda description: Moeda rateio: type: object allOf: – #/definitions/recRateio description: Rateio valoresNegociados: type: object allOf: – #/definitions/recValoresNegociados description: Dados negociados informacoesAdicionais: type: object allOf: – #/definitions/recInformacoesAdicionaisTitulo description: Informações adicionais recInformacoesAdicionaisTitulo: description: Indicativo das informações adicionados do título type: object properties: observacao: type: string maxLength: 250 description: Observação naturezaGastoId: type: string description: Natureza Gasto formaPagamentoId: type: string description: Forma Pagamento portadorId: type: string description: Portador carteiraId: type: string description: Carteira recRateio: description: Indicativo das informações para geração de rateio type: object properties: projetoId: type: string description: Indicativo do projeto faseProjetoId: type: string description: Indicativo da fase do projeto contaFinanceiraId: type: string description: Indicativo da conta financeira contaContabilId: type: string description: Indicativo da conta contábil centroCustosId: type: string description: Indicativo do centro de custos recMoeda: description: Indicativo das informações da moeda do título type: object required: – moedaId properties: moedaId: type: string description: Moeda Base cotacaoEmissao: type: string description: Cotação Moeda Emissão minimum: 0.00 maximum: 999999999.9999999999 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 invoice: description: Dados da nota fiscal type: object properties: id: type: string description: Id da nota fiscal serie: type: string description: Código da série da nota fiscal number: type: integer format: int64 description: Número da nota fiscal securities: description: Dados do título no contas a receber type: object properties: id: type: string description: Id do títutlo type: type: string description: Código do tipo do título number: type: string description: Número do título dueDate: type: string format: date description: Vencimento do título recAgreement: description: Informações do contrato type: object properties: id: type: string description: Identificador do contrato type: type: string allOf: – #/definitions/enumAgreementType description: Tipo do contrato description: type: string description: Descrição do contrato branchId: type: string description: Identificador da filial number: type: integer format: int64 description: Número do contrato personId: type: string description: Identificador do contratante 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. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. 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