facade

2.0info: 2.1.0 facade description: Suprimentos (facade) x-senior-domain: ERP SENIOR X SUPRIMENTOS (ERPX_SUP_INT) x-senior-domain-path: erpx_sup_int x-senior-service-path: facade 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_sup_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /facade/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 /facade/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 /facade/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 /facade/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /facade/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /facade/actions/resetSchema: post: description: Realiza a limpeza da base de dados, mantendo somente os dados padrões (conforme carga inicial) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /facade/events/invoiceIntegratedSuccess: post: description: Evento que indica a integração com sucesso de uma nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticketId – company – branch – invoiceId – invoiceNumber – invoiceKey – series – invoiceType properties: ticketId: type: string description: Identificador do Ticket company: type: string description: Identificador da Empresa branch: type: string description: Identificador da Filial invoiceId: type: string description: Identificador da Nota Fiscal invoiceNumber: type: string description: Número da Nota Fiscal invoiceKey: type: string description: Chave da Nota Fiscal series: type: string description: Série da Nota Fiscal invoiceType: type: string allOf: – #/definitions/enumTipNfe description: Tipo da Nota Fiscal responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /facade/events/invoiceIntegratedError: post: description: Evento que indica a integração com erro de uma nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ticketId – invoiceType – message properties: ticketId: type: string description: Identificador do Ticket invoiceType: type: string allOf: – #/definitions/enumTipNfe description: Tipo da Nota Fiscal message: type: string description: Mensagem de erro ao gerar uma nota responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /facade/events/invoiceClosedSuccess: post: description: Evento que indica o fechamento com sucesso de uma nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – invoiceId properties: invoiceId: type: string description: Identificador da nota responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /facade/events/invoiceClosedError: post: description: Evento que indica o fechamento com erro de uma nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – invoiceId – message properties: invoiceId: type: string description: Identificador da nota message: type: string description: Mensagem de erro ao fechar uma nota responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /facade/apis/incomingInvoice/{id}: get: description: Consulta dos dados da nota fiscal de entrada tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/incomingInvoiceFacade 400: description: Requisição inválida, parâmetros obrigatórios não fornecidos ou campo informado incorretamente 401: description: Usuário não autenticado 403: description: Usuário sem permissão 404: description: Registro não encontrado pelo ID ERPX ou código de negócio fornecido default: description: Error response schema: #/definitions/genericError /facade/apis/integrateThirdPartyIncomingInvoice: post: description: API integrar nota fiscal de entrada de terceiros tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/integrateThirdPartyIncomingInvoiceFacadeInput responses: 200: description: Ok schema: #/definitions/integrateThirdPartyIncomingInvoiceFacadeOutput 400: description: Requisição inválida, parâmetros obrigatórios não fornecidos ou campo informado incorretamente 401: description: Usuário não autenticado 403: description: Usuário sem permissão 404: description: Registro não encontrado pelo ID ERPX ou código de negócio fornecido default: description: Error response schema: #/definitions/genericError /facade/apis/closeIncomingInvoice: post: description: API para fechamento da nota fiscal de entrada tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/closeIncomingInvoiceFacadeInput responses: 200: description: Ok schema: #/definitions/closeIncomingInvoiceFacadeOutput 400: description: Requisição inválida, parâmetros obrigatórios não fornecidos ou campo informado incorretamente 401: description: Usuário não autenticado 403: description: Usuário sem permissão 404: description: Registro não encontrado pelo ID ERPX ou código de negócio fornecido default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumBaseDueDate: type: string enum: – ISSUE_DATE – ENTRY_DATE description: Tipo de base de vencimento: * `ISSUE_DATE` – Data de Emissão * `ENTRY_DATE` – Data de Entrada enumTipNfe: type: string enum: – V1 – V2 – V4 – V6 – V8 – V9 – V10 – V12 description: Tipos de nota fiscal de entrada: * `V1` – Nota de entrada * `V2` – Devolução * `V4` – Retorno de terceiros/serviços agregados * `V6` – NF Produtor – Contranota * `V8` – Frete * `V9` – Nota complementar * `V10` – Nota de ajuste * `V12` – Estorno originGoods: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 description: Origem fiscal da mercadoria: * `V0` – 0 – Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 * `V1` – 1 – Estrangeira – Importação direta, exceto a indicada no código 6 * `V2` – 2 – Estrangeira – Adquirida no mercado interno, exceto a indicada no código 7 * `V3` – 3 – Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% (quarenta por cento) e inferior ou igual a 70% (setenta por cento) * `V4` – 4 – Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam o Decreto-Lei nº 288/67, e as Leis nºs 8.248/91, 8.387/91, 10.176/01 e 11.484/07 * `V5` – 5 – Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40% (quarenta por cento) * `V6` – 6 – Estrangeira – Importação direta, sem similar nacional, constante em lista de Resolução CAMEX e gás natural * `V7` – 7 – Estrangeira – Adquirida no mercado interno, sem similar nacional, constante em lista de Resolução CAMEX e gás natural * `V8` – 8 – Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70% (setenta por cento) taxType: type: string enum: – PIS_RECUPERAR – COFINS_RECUPERAR – ICMS – ICMS_CREDITADO description: Tipo de imposto: * `PIS_RECUPERAR` – PIS a recuperar * `COFINS_RECUPERAR` – COFINS a Recuperar * `ICMS` – ICMS * `ICMS_CREDITADO` – ICMS Efetivamente Creditado enumInvoiceStatus: type: string enum: – V0 – V2 – V3 – V4 – V5 – InutilizacaoProcessamento – Inutilizada – Estornada – ProcessandoCalculo – Inconsistente – ProcessandoFechamento description: Situação da nota fiscal de entrada: * `V0` – Em digitação * `V2` – Fechada * `V3` – Cancelada * `V4` – Em reabilitação * `V5` – Em Cancelamento * `InutilizacaoProcessamento` – Inutilização em Processamento * `Inutilizada` – Inutilizada * `Estornada` – Estornada * `ProcessandoCalculo` – Processando cálculo * `Inconsistente` – Inconsistente * `ProcessandoFechamento` – Processando Fechamento enumCifFob: type: string enum: – V0 – V1 – V2 – V3 – V4 – V9 description: Tipo de cobrança de frete: * `V0` – Contratação do frete por conta do remetente (CIF) * `V1` – Contratação do frete por conta do destinatário (FOB) * `V2` – Contratação do frete por conta de terceiros * `V3` – Transporte próprio por conta do remetente * `V4` – Transporte próprio por conta do destinatário * `V9` – Sem ocorrência de transporte userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – 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 genericRecord: description: Dados de registro genérico discriminator: _discriminator type: object required: – _discriminator properties: id: type: string description: Identificador code: type: string description: Código de registro name: type: string description: Nome do registro shortName: type: string description: Descrição curta _discriminator: type: string description: transaction: description: Representa uma transação allOf: – #/definitions/genericRecord – type: object properties: cfop: type: string description: batch: description: Representa um lote de produto type: object required: – code – batchQuantity properties: code: type: string description: Código do lote (obrigatório se o lote for fornecido) batchQuantity: type: string description: Quantidade do lote manufactureDate: type: string format: date description: Data de fabricação do lote expirationDate: type: string format: date description: Data de validade do lote invoiceServiceItem: description: Representa um item de nota fiscal (produto ou serviço) allOf: – #/definitions/genericRecord – type: object required: – transaction – quantity – unitPrice properties: transaction: type: object allOf: – #/definitions/transaction description: Transação do item entryUnit: type: string description: Código da unidade de entrada quantity: type: string description: Quantidade do item unitPrice: type: string description: Preço unitário do item warehouse: type: object allOf: – #/definitions/genericRecord description: Depósito discountValue: type: string description: Valor do desconto taxes: type: array items: type: object allOf: – #/definitions/invoiceItemTax description: Impostos do item costCenter: type: object allOf: – #/definitions/genericRecord description: Centro de custo financialAccount: type: object allOf: – #/definitions/genericRecord description: Conta Financeira series: description: Representa um objeto de série de distribuição type: object required: – seriesNumber properties: seriesNumber: type: string description: Número da série manufactureDate: type: string format: date description: Data de fabricação da série expirationDate: type: string format: date description: Data de validade da série invoiceItem: description: Representa um item de nota fiscal (produto ou serviço) allOf: – #/definitions/invoiceServiceItem – type: object properties: batch: type: array items: type: object allOf: – #/definitions/batch description: Informações do lote series: type: array items: type: object allOf: – #/definitions/series description: Informações da Série de Distribuição person: description: Representa um objeto pessoa allOf: – #/definitions/genericRecord – type: object properties: documentNumber: type: string description: CPF, CNPJ ou NIF (Número de Identificação Fiscal) paymentData: description: Representa um objeto de dados de pagamento type: object required: – expirationDateIndicator properties: paymentCondition: type: object allOf: – #/definitions/genericRecord description: Código da condição de pagamento expirationDateIndicator: type: string allOf: – #/definitions/enumBaseDueDate description: Indicador da base de vencimento (Data de Emissão ou Data de Entrada) installments: type: array items: type: object allOf: – #/definitions/invoiceInstallment description: Parcelas da nota fiscal recalculateInstallments: type: boolean description: Inidica se será feiro o recalculo das parcelas default: true invoiceInstallment: description: Representa um objeto de parcela da nota fiscal type: object required: – sequence – dueDate – percentage – amount – paymentMethod – titleType – titleNumber properties: id: type: string description: id sequence: type: integer format: int64 description: Sequência da parcela dueDate: type: string format: date description: Data de vencimento percentage: type: number format: double description: Percentual da parcela minimum: 0 maximum: 100 amount: type: string description: Valor referente a parcela minimum: 0.00 maximum: 9999999999999.99 paymentMethod: type: object allOf: – #/definitions/genericRecord description: Forma de pagamento (Id ou Código) titleType: type: object allOf: – #/definitions/genericRecord description: Tipo de Título (Id ou código) titleNumber: type: string description: Número do Título barCode: type: string description: Código de Barras observation: type: string description: Observação invoiceItemTax: description: Representa um objeto de imposto do item da nota fiscal type: object required: – taxType – taxBase – taxRate – taxValue – taxReductionPercentage – otherValues – exemptValues properties: taxType: type: string allOf: – #/definitions/taxType description: Tipo de imposto aplicado cst: type: object allOf: – #/definitions/genericRecord description: Código da Situação Tributária origin: type: string allOf: – #/definitions/originGoods description: Origem fiscal da mercadoria taxBase: type: string description: Base de cálculo do imposto (valor sobre o qual o imposto será calculado) minimum: 0.00 maximum: 9999999999999.99 taxRate: type: number format: double description: Alíquota do imposto (percentual aplicado sobre a base de cálculo) minimum: 0.00 maximum: 99999999999.9999 taxValue: type: string description: Valor do imposto calculado minimum: 0.00 maximum: 9999999999999.99 taxReductionPercentage: type: number format: double description: Percentual de redução da base de cálculo do imposto minimum: 0.00 maximum: 999.99999 otherValues: type: number format: double description: Valor outras minimum: 0.00 maximum: 99999999999.9999 exemptValues: type: number format: double description: Valor isentas minimum: 0.00 maximum: 99999999999.9999 manualTax: type: boolean description: Indica se o imposto foi inserido manualmente default: false otherValues: description: Outros Valores type: object properties: insuranceValue: type: string description: Valor de seguro minimum: 0.00 maximum: 9999999999999.99 packagingValue: type: string description: Valor de embalagens minimum: 0.00 maximum: 9999999999999.99 chargesValue: type: string description: Valor de encargos minimum: 0.00 maximum: 9999999999999.99 thirdPartyValue: type: string description: Valor cobrado em nome de terceiros minimum: 0.00 maximum: 9999999999999.99 otherExpensesValue: type: string description: Valor de outras despesas minimum: 0.00 maximum: 9999999999999.99 highlightedOtherExpensesValue: type: string description: Valor de outras despesas destacado minimum: 0.00 maximum: 9999999999999.99 additionalDiscountValue: type: string description: Valor de desconto adicional minimum: 0 maximum: 100 additionalDiscountPercentage: type: number format: double description: Pecentual de desconto adicional minimum: 0 maximum: 100 roundingValue: type: string description: Valor de arredondamento minimum: -9999999999999.99 maximum: 9999999999999.99 transport: description: Dados do transporte type: object properties: typeFreight: type: string allOf: – #/definitions/enumCifFob description: Tipo de frete shippingCost: type: string description: Valor de frete minimum: 0 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 incomingInvoiceFacade: description: Consulta dos dados da nota fiscal de entrada type: object required: – id – company – branch – sender – fiscalSeries – invoiceNumber – entryDate – issueDate – items properties: id: type: string format: uuid description: Identificador da Nota Fiscal company: type: object allOf: – #/definitions/genericRecord description: Empresa branch: type: object allOf: – #/definitions/person description: Filial sender: type: object allOf: – #/definitions/person description: Remetente fiscalSeries: type: object allOf: – #/definitions/genericRecord description: Código ou Sigla da Série invoiceNumber: type: string description: Número da Nota Fiscal invoiceStatus: type: string description: Situação da Nota Fiscal entryDate: type: string format: date description: Data de Entrada issueDate: type: string format: date description: Data de Emissão productTransaction: type: object allOf: – #/definitions/transaction description: Transação de Produto (Id, código de registro, CFOP) serviceTransaction: type: object allOf: – #/definitions/transaction description: Transação de Serviço (Id, código de registro, CFOP) invoiceKey: type: string description: Chave da Nota Fiscal observation: type: string description: Observação payment: type: object allOf: – #/definitions/paymentData description: Informações de Pagamento items: type: array items: type: object allOf: – #/definitions/invoiceItem minimum: 1 description: Itens da Nota Fiscal (produtos ou serviços) message: type: string description: Mensagem otherValues: type: object allOf: – #/definitions/otherValues description: Outros valores transport: type: object allOf: – #/definitions/transport description: Transporte integrateThirdPartyIncomingInvoiceFacadeInput: description: API integrar nota fiscal de entrada de terceiros type: object required: – company – branch – sender – series – invoiceNumber – entryDate – issueDate – items properties: id: type: string format: uuid description: Identificador company: type: object allOf: – #/definitions/genericRecord description: Empresa branch: type: object allOf: – #/definitions/person description: Filial sender: type: object allOf: – #/definitions/person description: Remetente series: type: object allOf: – #/definitions/genericRecord description: Id/serie da Série invoiceNumber: type: integer format: int64 description: Número da Nota Fiscal entryDate: type: string format: date-time description: Data de Entrada issueDate: type: string format: date-time description: Data de Emissão productTransaction: type: object allOf: – #/definitions/transaction description: Transação de Produto (Id, código de registro, CFOP) serviceTransaction: type: object allOf: – #/definitions/transaction description: Transação de Serviço (Id, código de registro, CFOP) invoiceKey: type: string description: Chave da Nota Fiscal observation: type: string description: Observação payment: type: object allOf: – #/definitions/paymentData description: Informações de Pagamento items: type: array items: type: object allOf: – #/definitions/invoiceItem minimum: 1 description: Itens da Nota Fiscal (produtos ou serviços) taxCity: type: object allOf: – #/definitions/genericRecord description: Município de tributação otherValues: type: object allOf: – #/definitions/otherValues description: Informações adicionais – outros valores transport: type: object allOf: – #/definitions/transport description: Dados do transporte integrateThirdPartyIncomingInvoiceFacadeOutput: description: API integrar nota fiscal de entrada de terceiros type: object required: – ticket properties: ticket: type: string description: Id do processo assíncrono closeIncomingInvoiceFacadeInput: description: API para fechamento da nota fiscal de entrada type: object required: – invoiceId properties: invoiceId: type: string format: uuid description: Identificador da Nota Fiscal closeIncomingInvoiceFacadeOutput: description: API para fechamento da nota fiscal de entrada type: object required: – ticket properties: ticket: type: string description: Id do processo assíncrono genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage