2.0info: 1.0.0 ig5_documentosfiscais description: Serviço para notificar notas fiscais autorizadas x-senior-domain: erp_dfi x-senior-domain-path: erp_dfi x-senior-service-path: ig5_documentosfiscais contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_dfisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ig5_documentosfiscais/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: 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: default: description: Error response schema: #/definitions/genericError /ig5_documentosfiscais/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 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 default: description: Error response schema: #/definitions/genericError definitions: enumProcessoNotaFiscal: description: Processo usado para a nota fiscal type: string enum: – Entrada – Saida enumTipoNotaFiscal: description: Tipos de notas fiscais type: string enum: – SimplesRemessa – SimplesFaturamneto – Devolucao – Normal – Acerto – Retorno – Transferencia – Frete enumSituacaoEletronica: description: Situação eletrônica da nota fiscal tanto de saÃda como de entrada type: string enum: – Aturorizada – Cancelada – Denegada – NaoEnviada enumTipoProduto: description: Tipos do produto type: string enum: – NaoClassificado – Mercadoria – MateriaPrima – Intermediario – Embalagem – Manufaturado – EmFabricacao – Subproduto – UsoConsumo – AtivoImobilizado – Servico – OutrosInsumos – Outros 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 recItemLigadoAoItem: description: Documentos ligados ao item type: object required: – codigoEmpresa – codigoFilial – numeroDocumentoFiscal – serieDocumentoFiscal – codigoItem properties: codigoEmpresa: type: integer format: int64 description: Código da empresa (CodEmp) codigoFilial: type: integer format: int64 description: Código da filial (CodFil) codigoPessoa: type: integer format: int64 description: Pessoa informado ao documento numeroDocumentoFiscal: type: integer format: int64 description: Número do documento fiscal serieDocumentoFiscal: type: string maxLength: 5 description: Série do documento fiscal codigoItem: type: integer format: int64 description: Código do item referenciado recDocumentoItens: description: Itens do documento autorizado type: object required: – sequencia – codigoItem – valorLiquido – quantidade – itemTipo properties: sequencia: type: integer format: int64 description: Sequência do item do documento fiscal codigoItem: type: string maxLength: 23 description: Código do produto/serviço codigoDerivacao: type: string maxLength: 10 description: Código da derivação codigoVendedor: type: integer format: int64 description: código do representante/vendedor codigoDeposito: type: string maxLength: 10 description: Código do depósito valorLiquido: type: number format: double description: Valor lÃquido (VlrLiq) quantidade: type: number format: double description: Quantidade faturada/recebida (QtdFat/QtdRec) valorDesconto: type: number format: double description: Valor de descontos (VlrDsc) valorOutro: type: number format: double description: Valor de outros e encargos financeiros(E140IPV.VlrEnc)/Valor de outros(E440IPC.VlrLou) cfop: type: string maxLength: 6 description: CFOP documentos: type: array items: type: object allOf: – #/definitions/recItemLigadoAoItem description: Documentos ligados ao item itemTipo: type: string allOf: – #/definitions/enumTipoProduto description: Tipo do item empresaOrdemCompra: type: number format: double description: Empresa da ordem de compra filialOrdemCompra: type: number format: double description: Filial da ordem de compra numeroOrdemCompra: type: number format: double description: Número da ordem de compra sequenciaOrdemCompra: type: number format: double description: Sequencia do item da ordem de compra uuidNecessidade: type: string maxLength: 40 description: UUID da necessidade de compra recDocumentoParcela: description: Parcela do documento fiscal type: object required: – sequencia – formaPagamento – valor properties: sequencia: type: integer format: int64 description: Sequência da parcela formaPagamento: type: integer format: int64 description: Forma de pagamento valor: type: number format: double description: Valor 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 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