2.0info: 1.1.0 issuer description: issuer x-senior-domain: edocsx_nfeabi x-senior-domain-path: edocsx_nfeabi x-senior-service-path: issuer 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/edocsx_nfeabisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /issuer/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 /issuer/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/retrieveIntegrationIssueXml: post: description: Busca o XML da crítica de integração salvo no DynamoDB tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – integrationIssueId properties: integrationIssueId: type: string description: Identificador da crítica de integração responses: 200: description: Ok schema: type: object allOf: – #/definitions/integrationIssueXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o XML da crítica de integração salvo no DynamoDB tags: – Queries x-senior-visibility: PRIVATE parameters: – name: integrationIssueId description: Identificador da crítica de integração in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/integrationIssueXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/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 /issuer/queries/exportOutgoingInvoice: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE007ufs: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE008rai: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingInvoiceXml: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE070empCertificate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportE070filCertificate: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportIntegrationIssue: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingDocumentHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingHistoryDetails: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportEventOutgoingInvoice: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportEventOutgoingInvoiceXml: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingInvoiceRejection: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportEventOutgoingInvoiceDocumentHistory: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportEventOutgoingInvoiceHistoryDetails: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportEventOutgoingInvoiceRejection: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportOutgoingInvoiceContingency: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportContingency: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/queries/exportNfeParameter: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/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 /issuer/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 /issuer/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 /issuer/actions/initialLoadDefaultBase: post: description: Carga inicial de dados da base padrão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: wizardCall: type: boolean description: Indica se quem está chamando a carga inicial é o Wizard na preparação de ambiente responses: 200: description: Ok schema: type: object properties: migrationVersion: type: string description: Indica a versão do migration migrated: type: boolean description: Indica se já foi migrado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/receiveOutgoingInvoice: post: description: Endpoint que inicia o processamento de uma NFE tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – documentId – xml – documentVersion properties: branchId: type: string description: Id da filial documentId: type: string description: Id do documento no ERPX xml: type: string description: XML da nfe documentVersion: type: string description: Versão da NFe responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/receiveEventOutgoingInvoice: post: description: Endpoint que inicia o processamento de um evento de uma NF-e tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – documentId – outgoingInvoiceKey – xml – eventVersion properties: branchId: type: string description: Id da filial documentId: type: string description: Id do documento no ERPX outgoingInvoiceKey: type: string description: Chave da nota de saída xml: type: string description: XML do evento eventVersion: type: string description: Versão do evento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/rejectPendingOutgoingInvoice: post: description: Endpoint que rejeita uma NF-e com o status pendente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – accessKey properties: accessKey: type: string description: Chave de acesso da nota fiscal responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/reprocessOutgoingInvoice: post: description: Reprocessa uma nota fiscal rejeitada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – accessKey properties: accessKey: type: string description: Chave de acesso da nota fiscal responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/outgoingInvoiceSefazStatus: post: description: Consulta o status da nota fiscal saida pela chave de acesso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – accessKey properties: accessKey: type: string description: Chave de acesso da nota fiscal responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/resendResponseOutgoingInvoice: post: description: Reenvia o retorno de uma nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – accessKey properties: accessKey: type: string description: Chave de acesso da nota fiscal responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/resendResponseEventOutgoingInvoice: post: description: Reenvia o retorno de um evento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – accessKey properties: accessKey: type: string description: Chave de acesso do evento responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/downloadOutgoingInvoice: post: description: Realiza o download do XML da nota fiscal de saída tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceDownloadRecord responses: 200: description: Ok schema: type: object allOf: – #/definitions/outgoingInvoiceDownloadResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/downloadEventDocumentOutgoing: post: description: Realiza o download do XML do evento da nota fiscal de saída tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/eventNfeDownloadRecord responses: 200: description: Ok schema: type: object allOf: – #/definitions/eventNfeDownloadResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingInvoice: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE007ufs: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE008rai: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingInvoiceXml: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE070empCertificate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importE070filCertificate: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importIntegrationIssue: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingDocumentHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingHistoryDetails: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importEventOutgoingInvoice: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importEventOutgoingInvoiceXml: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingInvoiceRejection: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importEventOutgoingInvoiceDocumentHistory: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importEventOutgoingInvoiceHistoryDetails: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importEventOutgoingInvoiceRejection: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importOutgoingInvoiceContingency: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importContingency: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/actions/importNfeParameter: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/signals/assignAndSendNfe: post: description: Assina e envia a NFe para a SEFAZ tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – invoiceId – invoiceXmlId – ibgeStateCode – environmentType – xml – branchId – invoiceAccessKey – version properties: invoiceId: type: string description: ID da NFe invoiceXmlId: type: string description: ID do xml ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente xml: type: string description: XML branchId: type: string description: ID da filial invoiceAccessKey: type: string description: Chave de acesso da NFe type: string description: Versão do documento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/assignAndSendEvent: post: description: Assina e envia o evento para a SEFAZ tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventInvoiceId – invoiceId – eventInvoiceXmlId – ibgeStateCode – environmentType – xml – branchId – eventAccessKey – nfeVersion – eventVersion properties: eventInvoiceId: type: string description: ID do evento invoiceId: type: string description: ID da NFe eventInvoiceXmlId: type: string description: ID do xml ibgeStateCode: type: integer format: int64 description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente xml: type: string description: XML branchId: type: string description: ID da filial eventAccessKey: type: string description: Chave de acesso do evento nfeVersion: type: string description: Versão do layout da NF-e eventVersion: type: string description: Versão do layout do evento invoiceOrigin: type: string allOf: – #/definitions/enumInvoiceOrigin description: Origem de nota fiscal responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/uploadDocumentFile: post: description: Realiza o upload da NFe para o storage tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – outgoingInvoiceId – xml – fileName – naturalKey properties: outgoingInvoiceId: type: string description: Identificador da NFe xml: type: string description: XML fileName: type: string description: Nome do arquivo naturalKey: type: string description: Chave natural responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/uploadEventFile: post: description: Realiza o upload do Evento da NFe para o storage tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventInvoiceId – xml – fileName – accessKey – invoiceOrigin properties: eventInvoiceId: type: string description: Identificador do evento xml: type: string description: XML fileName: type: string description: Nome do arquivo accessKey: type: string description: Chave de acesso do evento invoiceOrigin: type: string allOf: – #/definitions/enumInvoiceOrigin description: Origem da nota fiscal responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/registerIntegrationIssue: post: description: Registra crítica de integração tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – issue – documentType properties: documentId: type: string description: Chave informada na requisição issue: type: string description: Mensagem da crítica de integração documentType: type: string allOf: – #/definitions/enumIntegrationIssueDocumentType description: Tipo do documento que gerou a crítica xml: type: string description: XML que gerou a crítica responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/sendOutgoingInvoiceContingency: post: description: Processa a nota fiscal em contingência tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – outgoigInvoiceId – xml – environment properties: outgoigInvoiceId: type: string description: Identificador da NFe xml: type: string description: XML da NFe environment: type: string description: Tipo de ambiente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/enqueueDocumentRetry: post: description: Enfileira reenvio da NFe para SEFAZ tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – invoiceId – branchId – accessKey properties: invoiceId: type: string description: Id da NFe branchId: type: string description: ID da filial accessKey: type: string description: Chave de acesso da nota fiscal responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/outgoingInvoiceSentResultRetry: post: description: Processa o status da NFe reprocessada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – invoiceStatus properties: invoiceStatus: type: object allOf: – #/definitions/outgoingInvoiceSentResultRetryRecord description: Retorno da SEFAZ responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/enqueueSefazStatus: post: description: Enfileira a consulta da situação da NFe na SEFAZ tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – outgoingInvoiceId properties: outgoingInvoiceId: type: string description: Identificador da nota fiscal responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/enqueueCancellationEventRetry: post: description: Enfileira reenvio do evento de cancelamento para SEFAZ tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventId – branchId – accessKey properties: eventId: type: string description: Id do evento branchId: type: string description: ID da filial accessKey: type: string description: Chave de acesso do evento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/cancellationEventStatusResponseRetry: post: description: Processa o status do evento de cancelamento reprocessado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – eventStatus properties: eventStatus: type: object allOf: – #/definitions/cancellationEventStatusResponseRetryRecord description: Retorno da SEFAZ responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/rollbackInvoice: post: description: Rejeita a nota fiscal como resultado de uma exceção durante o processo de emissão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id – message – code properties: id: type: string description: Identificador do registro da nota fiscal message: type: string description: Mensagem de erro code: type: integer format: int64 description: Código de erro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/rollbackEvent: post: description: Rejeita o evento da nota fiscal como resultado de uma exceção durante o processo de emissão tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id – message – code – invoiceOrigin properties: id: type: string description: Identificador do registro do evento message: type: string description: Mensagem de erro code: type: integer format: int64 description: Código de erro invoiceOrigin: type: string allOf: – #/definitions/enumInvoiceOrigin description: Origem da nota fiscal responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/signals/telemetryInvoiceIssuance: post: description: Endpont de telemetria tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – invoiceAcessKey – processingDate – finalProcessDate – enumIssuanceType properties: branchId: type: string description: Identificador da filial invoiceAcessKey: type: string description: Chave de acesso da NF-e processingDate: type: string format: date-time description: Data e hora do início do processamento finalProcessDate: type: string format: date-time description: Data e hora do final do processamento enumIssuanceType: type: string allOf: – #/definitions/enumIssuanceType description: Tipo de emissão da NF-e responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /issuer/events/schemaChanged: post: description: Notifica a alteração/criação de um Schema x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – environmentChanged properties: environmentChanged: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente afetado responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/alertOutgoingNfeSituation: post: description: Notifica a situação final da NFe x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – invoiceId – statusNfe – accessKey – mensagem properties: invoiceId: type: string description: Id da NFe statusNfe: type: string description: Status da NFe accessKey: type: string description: Chave da NFe contingencyAccessKey: type: string description: Chave da NFe em contingência authorizationDate: type: string format: date description: Data de autorização authorizationProtocol: type: string description: Procolo de autorização mensagem: type: string description: Mensagem do motivo da situação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/alertEventOutgoingInvoiceSituation: post: description: Notifica a situação final do Evento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventId – eventStatus – eventAccessKey – documentAccessKey – numberSequenceEvent – mensagem – eventType properties: eventId: type: string description: Id do evento eventStatus: type: string description: Status do evento eventAccessKey: type: string description: Chave do evento documentAccessKey: type: string description: Chave do documento numberSequenceEvent: type: integer format: int64 description: sequencia evento registrationDate: type: string format: date-time description: Data de registro authorizationProtocol: type: string description: Procolo de autorização mensagem: type: string description: Mensagem do motivo da situação eventType: type: string allOf: – #/definitions/enumEventType description: Tipo do evento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/eventIssueResponse: post: description: Notifica a assinatura e envio de um evento x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventIssue properties: eventIssue: type: object allOf: – #/definitions/eventIssueRecord description: Dados do evento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importOutgoingInvoiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportOutgoingInvoiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportE070empEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportE070filEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importE007ufsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportE007ufsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importE008raiEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportE008raiEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importOutgoingInvoiceXmlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportOutgoingInvoiceXmlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importE070empCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportE070empCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importE070filCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportE070filCertificateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importIntegrationIssueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportIntegrationIssueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importOutgoingDocumentHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportOutgoingDocumentHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importOutgoingHistoryDetailsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportOutgoingHistoryDetailsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importEventOutgoingInvoiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportEventOutgoingInvoiceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importEventOutgoingInvoiceXmlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportEventOutgoingInvoiceXmlEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importOutgoingInvoiceRejectionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportOutgoingInvoiceRejectionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importEventOutgoingInvoiceDocumentHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportEventOutgoingInvoiceDocumentHistoryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importEventOutgoingInvoiceHistoryDetailsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportEventOutgoingInvoiceHistoryDetailsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importEventOutgoingInvoiceRejectionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportEventOutgoingInvoiceRejectionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importOutgoingInvoiceContingencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportOutgoingInvoiceContingencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importContingencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportContingencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/importNfeParameterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/events/exportNfeParameterEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoice responses: 200: description: The created resource schema: #/definitions/outgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoice responses: 200: description: The created resource schema: #/definitions/outgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingInvoice responses: 200: description: Ok schema: #/definitions/editOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingInvoice responses: 200: description: Ok schema: #/definitions/outgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingInvoice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070emp/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070fil/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e007ufs: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e007ufs/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e008rai: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e008rai/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceXml: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceXml responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceXml responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceXml/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingInvoiceXml responses: 200: description: Ok schema: #/definitions/editOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingInvoiceXml responses: 200: description: Ok schema: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{parentId}/invoiceXmls: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/outgoingInvoiceXml responses: 200: description: The created resources schema: type: array items: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/outgoingInvoiceXml responses: 200: description: The created resources schema: type: array items: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{parentId}/invoiceXmls/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingInvoiceXml responses: 200: description: Ok schema: #/definitions/editOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingInvoiceXml responses: 200: description: Ok schema: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceXml/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingInvoiceXml responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070empCertificate: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070empCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070empCertificate/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070empCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070filCertificate: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070filCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/e070filCertificate/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070filCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/integrationIssue: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/integrationIssue 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDocumentHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDocumentHistory responses: 200: description: The created resource schema: #/definitions/outgoingDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingDocumentHistory responses: 200: description: The created resource schema: #/definitions/outgoingDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDocumentHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingDocumentHistory responses: 200: description: Ok schema: #/definitions/editOutgoingDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingDocumentHistory responses: 200: description: Ok schema: #/definitions/outgoingDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDocumentHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingDocumentHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingHistoryDetails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingHistoryDetails/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingHistoryDetails responses: 200: description: Ok schema: #/definitions/editOutgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingHistoryDetails responses: 200: description: Ok schema: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDocumentHistory/{parentId}/historyDetails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingDocumentHistory/{parentId}/historyDetails/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingHistoryDetails responses: 200: description: Ok schema: #/definitions/editOutgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingHistoryDetails responses: 200: description: Ok schema: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingHistoryDetails/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingHistoryDetails responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoice: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoice responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoice responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoice/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoice responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoice responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{parentId}/eventsOutgoingInvoice: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoice responses: 200: description: The created resources schema: type: array items: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoice responses: 200: description: The created resources schema: type: array items: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{parentId}/eventsOutgoingInvoice/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoice responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoice responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoice/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceXml: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceXml responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceXml responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceXml/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoiceXml responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoiceXml responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoice/{parentId}/eventXmls: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoiceXml responses: 200: description: The created resources schema: type: array items: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoiceXml responses: 200: description: The created resources schema: type: array items: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoice/{parentId}/eventXmls/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoiceXml responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoiceXml responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceXml/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoiceXml responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceRejection: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceRejection responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceRejection responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceRejection/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingInvoiceRejection responses: 200: description: Ok schema: #/definitions/editOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingInvoiceRejection responses: 200: description: Ok schema: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{parentId}/outgoingInvoiceRejection: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceRejection responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceRejection responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{parentId}/outgoingInvoiceRejection/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingInvoiceRejection responses: 200: description: Ok schema: #/definitions/editOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingInvoiceRejection responses: 200: description: Ok schema: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceRejection/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingInvoiceRejection responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceDocumentHistory: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceDocumentHistory responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceDocumentHistory responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoiceDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceDocumentHistory/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoiceDocumentHistory responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoiceDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoiceDocumentHistory responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceDocumentHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoiceDocumentHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceHistoryDetails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceHistoryDetails responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceHistoryDetails responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceHistoryDetails/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoiceHistoryDetails responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoiceHistoryDetails responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceDocumentHistory/{parentId}/historyDetails: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceHistoryDetails responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceHistoryDetails responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceDocumentHistory/{parentId}/historyDetails/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoiceHistoryDetails responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoiceHistoryDetails responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceHistoryDetails/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoiceHistoryDetails responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceRejection: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceRejection responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceRejection responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceRejection/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoiceRejection responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoiceRejection responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoice/{parentId}/eventOutgoingInvoiceRejection: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceRejection responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventOutgoingInvoiceRejection responses: 200: description: The created resource schema: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoice/{parentId}/eventOutgoingInvoiceRejection/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editEventOutgoingInvoiceRejection responses: 200: description: Ok schema: #/definitions/editEventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/eventOutgoingInvoiceRejection responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventOutgoingInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/eventOutgoingInvoiceRejection/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventOutgoingInvoiceRejection responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceContingency: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceContingency responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceContingency responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceContingency/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingInvoiceContingency responses: 200: description: Ok schema: #/definitions/editOutgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingInvoiceContingency responses: 200: description: Ok schema: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{parentId}/outgoingInvoiceContingency: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceContingency responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/outgoingInvoiceContingency responses: 200: description: The created resource schema: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoice/{parentId}/outgoingInvoiceContingency/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOutgoingInvoiceContingency responses: 200: description: Ok schema: #/definitions/editOutgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/outgoingInvoiceContingency responses: 200: description: Ok schema: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/outgoingInvoiceContingency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/outgoingInvoiceContingency/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingInvoiceContingency responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/nfeParameter: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/nfeParameter responses: 200: description: The created resource schema: #/definitions/nfeParameter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/nfeParameter responses: 200: description: The created resource schema: #/definitions/nfeParameter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/nfeParameter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/nfeParameter/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editNfeParameter responses: 200: description: Ok schema: #/definitions/editNfeParameter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/nfeParameter responses: 200: description: Ok schema: #/definitions/nfeParameter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/nfeParameter 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /issuer/entities/nfeParameter/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/nfeParameter responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: enumDanfeStatus: type: string enum: – IN_PROGRESS – COMPLETED – FAILED description: Status da geração da DANFE: * `IN_PROGRESS` – Geração em andamento * `COMPLETED` – Geração concluída * `FAILED` – Geração falhou enumIntegrationIssueDocumentType: type: string enum: – NFE – CANCELLATION – CONTINGENCY_OFFLINE – EVENT_CANCELLATION description: Tipo do documento da crítica de integração: * `NFE` – NFe * `CANCELLATION` – Evento de cancelamento * `CONTINGENCY_OFFLINE` – Contingência off-line * `EVENT_CANCELLATION` – Cancelamento de Evento upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumNfeVersion: type: string enum: – V1_00 description: Versão da NF-e: * `V1_00` – Versao 1.00 environmentType: type: string enum: – PROD – HOMOLOG – DISABLED description: Tipo de aplicação do ambiente: * `PROD` – Produção * `HOMOLOG` – Homolog * `DISABLED` – Desativado documentStatus: type: string enum: – AUTHORIZED – REJECTED – CANCELED – DENIED – CLOSED – IN_PROGRESS – IN_CONTINGENCY description: Situações finais da NF-e: * `AUTHORIZED` – Documento autorizado no sistema, situação final * `REJECTED` – Documento rejeitado no sistema, pode ser reintegrado usando a mesma chave/ID * `CANCELED` – Documento cancelado no sistema, situação final * `DENIED` – Documento denegado no sistema, situação final * `CLOSED` – Documento encerrado no sistema, situação final. Somente usado para MDF-e * `IN_PROGRESS` – Documento em processamento pelo sistema. A situação será alterada assim que o processamento for finalizado * `IN_CONTINGENCY` – Documento foi emitido em contingência contingencyType: type: string enum: – MANUAL description: Tipo de contingência: * `MANUAL` – Manual contingencyIssuanceType: type: string enum: – CONTINGENCY_OFFLINE description: Tipo de emissão de contingência: * `CONTINGENCY_OFFLINE` – Contingência off-line enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física enumTipEmp: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 description: Tipo de empresa: * `V1` – Indústria * `V2` – Comércio * `V3` – Distribuidor * `V4` – Transportador-Revendedor-Retalhista (TRR) * `V5` – Extração mineral/outros * `V6` – Indústria/Transporte * `V7` – Produtor rural * `V8` – Prestador de serviço * `V9` – Atividade financeira * `V10` – Atividade imobiliária * `V11` – Cooperativa * `V12` – Sociedades seguradoras de capitalização ou entidade aberta de previdência complementar * `V13` – Distribuidor de energia elétrica * `V14` – Prestador de serviço de comunicação * `V99` – Outros enumInvoiceSituation: type: string enum: – AUTHORIZED – CANCELED – REJECTED – RECEIVED – IN_PROGRESS – SEFAZ_CONNECTION_FAILURE – WAITING_FOR_SEFAZ – DISCARDED – AUTHORIZED_OUT_OF_TIME – ARCHIVED description: Situação da NFe: * `AUTHORIZED` – NFe autorizada * `CANCELED` – NFe cancelada * `REJECTED` – NFe rejeitada * `RECEIVED` – NFe recebida * `IN_PROGRESS` – NFe em processamento * `SEFAZ_CONNECTION_FAILURE` – Falha de Conexão com a SEFAZ * `WAITING_FOR_SEFAZ` – NFe aguardando sefaz * `DISCARDED` – NFe descartada * `AUTHORIZED_OUT_OF_TIME` – NFe autorizada fora do prazo * `ARCHIVED` – NFe arquivada enumInvoicePurpose: type: string enum: – REGULAR – REPLACEMENT description: Finalidade da NFe: * `REGULAR` – NFe normal * `REPLACEMENT` – NFe substituição enumProcessingMode: type: string enum: – MANUAL – AUTOMATIC description: Enum para o modo de processamento: * `MANUAL` – Processamento manual * `AUTOMATIC` – Processamento automático enumXmlType: type: string enum: – AUTHORIZED – INTEGRATED description: Tipo do XML: * `AUTHORIZED` – Autorizado * `INTEGRATED` – Integrado enumIssuanceType: type: string enum: – REGULAR – CONTINGENCY_OFFLINE description: Tipo de emissão da Nota: * `REGULAR` – Emissão normal * `CONTINGENCY_OFFLINE` – Contingência off-line enumOutgoingInvoiceCreationType: type: string enum: – INTEGRATION – IMPORTATION – MIGRATION description: Enum tipo de origem da criação do documento: * `INTEGRATION` – Origem de integração * `IMPORTATION` – Origem de importação * `MIGRATION` – Origem de migração documentType: type: string enum: – CNPJ – CPF description: Tipo de documento: * `CNPJ` – CNPJ * `CPF` – CPF enumEventSituation: type: string enum: – AUTHORIZED – CANCELED – REJECTED – RECEIVED – IN_PROGRESS – SEFAZ_CONNECTION_FAILURE description: Situação do evento: * `AUTHORIZED` – Evento autorizado * `CANCELED` – Evento cancelado * `REJECTED` – Evento rejeitado * `RECEIVED` – Evento recebido * `IN_PROGRESS` – Evento em processamento * `SEFAZ_CONNECTION_FAILURE` – Falha de Conexão com a SEFAZ enumEventType: type: string enum: – E110111 – E170110 – E190110 description: Enum dos tipos de eventos: * `E110111` – Cancelamento da NF-e ABI * `E170110` – Pagamento de Parcela * `E190110` – Apropriação de Créditos Individuais enumInvoiceOrigin: type: string enum: – OUTGOING – INCOMING description: Enum para a origem de nota fiscal: * `OUTGOING` – Nota fiscal de saída * `INCOMING` – Nota fiscal de entrada enumIssuerType: type: string enum: – SELLER_TRANSFEROR – BUYER_ACQUIRER – AUCTIONEER – NOTARY – COMMERCIAL_BOARD – BANK_FINANCIAL – FUND_MANAGER – FIDUCIARY_CREDITOR – CONSORTIUM_GROUP – CORPORATE_SUCCESSOR – OTHER description: Tipo do emitente da NF-e ABI: * `SELLER_TRANSFEROR` – Vendedor, Transmitente ou Cedente * `BUYER_ACQUIRER` – Comprador, Adquirente ou Cessionário * `AUCTIONEER` – Leiloeiro (em nome do arrematante) * `NOTARY` – Tabelionato de Notas (em nome do vendedor ou transmitente) * `COMMERCIAL_BOARD` – Junta Comercial (em nome do transmitente) * `BANK_FINANCIAL` – Banco ou instituição financeira (em nome do vendedor ou transmitente) * `FUND_MANAGER` – Organização gestora de fundo patrimonial * `FIDUCIARY_CREDITOR` – Credor fiduciário (na consolidação da propriedade) * `CONSORTIUM_GROUP` – Grupo de consórcio (na consolidação da propriedade) * `CORPORATE_SUCCESSOR` – Sucessora em virtude de incorporação, cisão ou fusão * `OTHER` – Outros Emitentes 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 fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error 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 outgoingInvoiceSentResultRetryRecord: description: Dados da NFe para consulta de status type: object required: – invoiceId – branchId – invoiceAccessKey – statusCode – statusMessage properties: invoiceId: type: string description: ID da NFe branchId: type: string description: ID da filial invoiceAccessKey: type: string description: Chave de acesso da NFe statusCode: type: string description: Código de retorno SEFAZ statusMessage: type: string description: Mensagem de retorno SEFAZ responseXml: type: string description: XML de retorno authorizationDate: type: string format: date description: Data de autorização authorizationProtocol: type: string description: Procolo de autorização digestValue: type: string description: Digest value cancellationEventStatusResponseRetryRecord: description: Dados do evento para consulta de status type: object required: – eventOutgoingInvoiceId – invoiceId – branchId – statusCode – statusMessage properties: eventOutgoingInvoiceId: type: string description: ID do evento invoiceId: type: string description: ID da NFe branchId: type: string description: ID da filial batchId: type: string description: ID do lote statusCode: type: string description: Código de retorno SEFAZ statusMessage: type: string description: Mensagem de retorno SEFAZ responseXml: type: string description: XML de retorno dhRegEvento: type: string description: Data de registro nProt: type: string description: Procolo de autorização outgoingInvoiceDownloadRecord: description: Record utilizado para solicitar o download do XML de uma NF-e type: object required: – xmlType properties: accessKey: type: string description: Chave de acesso da NF-e xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML outgoingInvoiceDownloadResponse: description: Record utilizado para retornar o XML da NF-e type: object required: – invoiceId – accessKey – xmlUrl properties: invoiceId: type: string description: Identificador do XML da NF-e accessKey: type: string description: Chave de acesso da NF-e xmlUrl: type: string description: URL do XML da NF-e eventNfeDownloadRecord: description: Record utilizado para solicitar o download do XML do evento de uma NF-e type: object required: – eventAccessKey – xmlType properties: eventAccessKey: type: string description: Chave de acesso do evento da NF-e xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML eventNfeDownloadResponse: description: Record utilizado para retornar o XML do evento da NF-e type: object required: – eventId – eventAccessKey – xmlUrl properties: eventId: type: string description: Identificador do evento eventAccessKey: type: string description: Chave de acesso do evento da NF-e xmlUrl: type: string description: URL do XML do evento da NF-e eventIssueRecord: description: Dados do evento para emissão type: object required: – eventId – invoiceId – ibgeStateCode – environmentType – signedXml – branchId – eventAccessKey – nfeVersion – eventVersion – invoiceOrigin properties: eventId: type: string description: ID do evento invoiceId: type: string description: Id da NFe ibgeStateCode: type: string description: Código IBGE do estado environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente signedXml: type: string description: XML assinado branchId: type: string description: ID da filial eventAccessKey: type: string description: Chave de acesso do evento nfeVersion: type: string description: Versão do layout da NF-e eventVersion: type: string description: Versão do layout do evento invoiceOrigin: type: string description: Origem da nota fiscal integrationIssueXml: description: Dados do xml da crítica de no DynamoDB type: object required: – id – integratedXml – expirationDate properties: id: type: string description: Identificador da crítica de integração integratedXml: type: string description: XML integrado expirationDate: type: string format: date-time description: Tempo restante para expiração outgoingInvoice: description: Documento de saída type: object required: – accessKey – situation – series – number – issuerCorporateName – issuerDocument – version – issueDateTime – totalValue – processingDate – outgoingInvoiceCreationType – finalProcessDate – environmentType properties: id: type: string format: uuid description: ID da NFe e070fil: type: object allOf: – #/definitions/e070fil description: Filial accessKey: type: string description: Chave de acesso da NFe situation: type: string allOf: – #/definitions/enumInvoiceSituation description: Situação da NFe series: type: integer format: int64 description: Série da NFe number: type: integer format: int64 description: Número da NFe issuerCorporateName: type: string description: Razão Social do Emissor issuerDocument: type: string description: Documento do Emissor issuerDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Emissor type: string description: Versão do documento issueDateTime: type: string format: date-time description: Data de emissão do documento outgoingDateTime: type: string format: date-time description: Data de saída do documento totalValue: type: string description: Valor Total da NFe issueUF: type: object allOf: – #/definitions/e007ufs description: UF de emissão da NFe naturalKey: type: string description: Chave natural authorizationDate: type: string format: date description: Data de autorização authorizationProtocol: type: string description: Procolo de autorização digestValue: type: string description: Digest value invoiceXmls: type: array items: type: object allOf: – #/definitions/outgoingInvoiceXml description: XML da NFe processingDate: type: string format: date-time description: Data de processamento issuanceType: type: string allOf: – #/definitions/enumIssuanceType description: Tipo de emissão da Nota outgoingInvoiceRejection: type: object allOf: – #/definitions/outgoingInvoiceRejection description: Rejeição da Nota processingAttempts: type: integer format: int64 description: Numero de tentativas de processamento default: 0 outgoingInvoiceParent: type: object allOf: – #/definitions/outgoingInvoice description: Nota de origem (pai) outgoingInvoiceCreationType: type: string allOf: – #/definitions/enumOutgoingInvoiceCreationType description: Origem da criação da nota outgoingInvoiceContingency: type: object allOf: – #/definitions/outgoingInvoiceContingency description: Informações de contingência da Nota finalProcessDate: type: string format: date-time description: Data e hora da finalização do processamento da NF-e environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente da emissao eventsOutgoingInvoice: type: array items: type: object allOf: – #/definitions/eventOutgoingInvoice description: Eventos da NFe de saída situationDate: type: string format: date-time description: Data de alteração da situação da NF-e issuerType: type: string allOf: – #/definitions/enumIssuerType description: Tipo do emitente layout: type: integer format: int64 description: Modelo do documento (constante 77) authorizingWebsite: type: integer format: int64 description: Site autorizador (posição 9 da chave) purpose: type: string allOf: – #/definitions/enumInvoicePurpose description: Finalidade da NF-e ABI usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingInvoice: type: object required: – id allOf: – #/definitions/outgoingInvoice e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação e070empCertificate: type: object allOf: – #/definitions/e070empCertificate description: Certificado eDocs X usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa e008rai: type: object allOf: – #/definitions/e008rai description: Código cidade ISS numCgc: type: string maxLength: 18 description: CPF/CNPJ excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação e070filCertificate: type: object allOf: – #/definitions/e070filCertificate description: Certificado eDocs X e007ufsSigUfs: type: object allOf: – #/definitions/e007ufs description: Estado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e007ufs: description: Estado type: object properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome code: type: integer format: int64 description: Código estado minimum: 0 maximum: 9999999 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e008rai: description: Cidade type: object properties: id: type: string format: uuid description: Id da entidade nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado codIbg: type: integer format: int64 description: Código IBGE município minimum: 0 maximum: 9999999 excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: outgoingInvoiceXml: description: XML da NFe type: object required: – invoiceAccessKey – fileName – targetObjectId – version – xmlType properties: id: type: string format: uuid description: ID da NFe outgoingInvoice: type: object allOf: – #/definitions/outgoingInvoice description: NFe de saída invoiceAccessKey: type: string description: Chave de acesso da NFe fileName: type: string description: Nome do arquivo da NFe targetObjectId: type: string description: ID do arquivo no blobService type: string description: Versão do arquivo xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingInvoiceXml: type: object required: – id allOf: – #/definitions/outgoingInvoiceXml e070empCertificate: description: Certificado de eDocs X para Empresa type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa fileName: type: string description: Nome do arquivo targetObjectId: type: string description: Id do arquivo type: string description: Versão do arquivo expirationDate: type: string format: date-time description: Data de validade subject: type: string description: Nome do certificado issuedBy: type: string description: Certificado emitido por issuedTo: type: string description: Certificado emitido para privateKey: type: boolean description: Chave privada password: type: string description: Senha do certificado validCertificateChain: type: boolean description: Cadeia de certificados válida extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação excluido: type: boolean description: Indica se o registro foi excluído default: false fileNameExt: type: string description: Nome do arquivo extendido targetObjectIdExt: type: string description: Id do arquivo extendido versionExt: type: string description: Versão do arquivo extendido usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filCertificate: description: Certificado de eDocs X para Filial type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial fileName: type: string description: Nome do arquivo targetObjectId: type: string description: Id do arquivo type: string description: Versão do arquivo expirationDate: type: string format: date-time description: Data de validade subject: type: string description: Nome do certificado issuedBy: type: string description: Certificado emitido por issuedTo: type: string description: Certificado emitido para privateKey: type: boolean description: Chave privada password: type: string description: Senha do certificado validCertificateChain: type: boolean description: Cadeia de certificados válida extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação excluido: type: boolean description: Indica se o registro foi excluído default: false fileNameExt: type: string description: Nome do arquivo extendido targetObjectIdExt: type: string description: Id do arquivo extendido versionExt: type: string description: Versão do arquivo extendido usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: integrationIssue: description: Críticas de integração type: object required: – documentType properties: id: type: string format: uuid description: Identificador da crítica de integração requisitionId: type: string description: Chave informada na requisição issue: type: string description: Mensagem da crítica de integração issueDateTime: type: string format: date-time description: Data e hora da crítica de integração documentType: type: string allOf: – #/definitions/enumIntegrationIssueDocumentType description: Tipo do documento que gerou a crítica usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: outgoingDocumentHistory: description: Histórico das movimentações do documento fiscal type: object required: – invoiceStatus – historyDateTime – firedBy properties: id: type: string format: uuid description: Id da entidade invoiceStatus: type: string allOf: – #/definitions/enumInvoiceSituation description: Situação do documento historyDateTime: type: string format: date-time description: Data e hora da movimentação do histórico firedBy: type: string description: Usuário que disparou o evento historyOccurrence: type: string description: Ocorrência do histórico invoice: type: object allOf: – #/definitions/outgoingInvoice description: Identificador do documento historyDetails: type: object allOf: – #/definitions/outgoingHistoryDetails description: Detalhes do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingDocumentHistory: type: object required: – id allOf: – #/definitions/outgoingDocumentHistory outgoingHistoryDetails: description: Detalhes do histórico type: object required: – message – code properties: id: type: string format: uuid description: Id da entidade documentHistory: type: object allOf: – #/definitions/outgoingDocumentHistory description: Identificador do documento message: type: string maxLength: 255 description: Mensagem do histórico code: type: string maxLength: 5 description: Código do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingHistoryDetails: type: object required: – id allOf: – #/definitions/outgoingHistoryDetails eventOutgoingInvoice: description: Evento de NFe type: object required: – accessKey – outgoingInvoiceAccessKey – situation – series – number – issuerCorporateName – version – issueDateTime – eventType – processingDate – eventSequence properties: id: type: string format: uuid description: ID do Evento e070fil: type: object allOf: – #/definitions/e070fil description: Filial accessKey: type: string description: Chave de acesso do evento outgoingInvoiceAccessKey: type: string description: Chave de acesso da NFe outgoingInvoice: type: object allOf: – #/definitions/outgoingInvoice description: NFe de saída situation: type: string allOf: – #/definitions/enumEventSituation description: Situação do evento series: type: integer format: int64 description: Série da NFe number: type: integer format: int64 description: Número da NFe issuerCorporateName: type: string description: Razão Social do Emissor da NFe type: string description: Versão do evento issueDateTime: type: string format: date-time description: Data do evento eventType: type: string allOf: – #/definitions/enumEventType description: Tipo do evento registrationDate: type: string format: date-time description: Data de registro do evento na Sefaz authorizationProtocol: type: string description: Procolo de autorização eventXmls: type: array items: type: object allOf: – #/definitions/eventOutgoingInvoiceXml description: XML do evento processingDate: type: string format: date-time description: Data de processamento eventSequence: type: integer format: int64 description: Sequência do evento eventOutgoingInvoiceRejection: type: object allOf: – #/definitions/eventOutgoingInvoiceRejection description: Rejeição do evento processingAttempts: type: integer format: int64 description: Numero de tentativas de processamento default: 0 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventOutgoingInvoice: type: object required: – id allOf: – #/definitions/eventOutgoingInvoice eventOutgoingInvoiceXml: description: XML do evento type: object required: – eventAccessKey – xmlType properties: id: type: string format: uuid description: ID da NFe eventOutgoingInvoice: type: object allOf: – #/definitions/eventOutgoingInvoice description: Evento da NFe eventAccessKey: type: string description: Chave de acesso do evento fileName: type: string description: Nome do arquivo do evento targetObjectId: type: string description: ID do arquivo no blobService type: string description: Versão do arquivo xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventOutgoingInvoiceXml: type: object required: – id allOf: – #/definitions/eventOutgoingInvoiceXml outgoingInvoiceRejection: description: Rejeição da NFe type: object required: – rejectionMessage – rejectionCode properties: id: type: string format: uuid description: ID da rejeição outgoingInvoice: type: object allOf: – #/definitions/outgoingInvoice description: ID da NFe rejectionMessage: type: string description: Mensagem de rejeição rejectionCode: type: string maxLength: 20 description: Código de rejeição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingInvoiceRejection: type: object required: – id allOf: – #/definitions/outgoingInvoiceRejection eventOutgoingInvoiceDocumentHistory: description: Histórico das movimentações do evento de NFe type: object required: – eventStatus – historyDateTime – firedBy properties: id: type: string format: uuid description: Identificador do histórico do evento eventStatus: type: string allOf: – #/definitions/enumEventSituation description: Situação do documento historyDateTime: type: string format: date-time description: Data e hora da movimentação do histórico firedBy: type: string description: Usuário que disparou o evento historyOccurrence: type: string description: Ocorrência do histórico eventOutgoingInvoice: type: object allOf: – #/definitions/eventOutgoingInvoice description: Identificador do documento historyDetails: type: object allOf: – #/definitions/eventOutgoingInvoiceHistoryDetails description: Detalhes do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventOutgoingInvoiceDocumentHistory: type: object required: – id allOf: – #/definitions/eventOutgoingInvoiceDocumentHistory eventOutgoingInvoiceHistoryDetails: description: Detalhes do histórico type: object required: – message – code properties: id: type: string format: uuid description: Identificador dos detalhes do histórico de evento documentHistory: type: object allOf: – #/definitions/eventOutgoingInvoiceDocumentHistory description: Identificador do documento message: type: string maxLength: 255 description: Mensagem do histórico code: type: string maxLength: 5 description: Código do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventOutgoingInvoiceHistoryDetails: type: object required: – id allOf: – #/definitions/eventOutgoingInvoiceHistoryDetails eventOutgoingInvoiceRejection: description: Rejeição do evento type: object required: – rejectionMessage – rejectionCode properties: id: type: string format: uuid description: ID da rejeição eventOutgoingInvoice: type: object allOf: – #/definitions/eventOutgoingInvoice description: ID do evento rejectionMessage: type: string description: Mensagem de rejeição rejectionCode: type: string maxLength: 20 description: Código de rejeição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventOutgoingInvoiceRejection: type: object required: – id allOf: – #/definitions/eventOutgoingInvoiceRejection outgoingInvoiceContingency: description: Informações de notas em contingência type: object required: – contingencyDate – contingencyCause – issuanceType properties: id: type: string format: uuid description: Identificador da entidade outgoingInvoice: type: object allOf: – #/definitions/outgoingInvoice description: Nota fiscal (original) contingencyDate: type: string format: date-time description: Data da contingência contingencyCause: type: string maxLength: 1000 description: Motivo da contingência issuanceType: type: string allOf: – #/definitions/enumIssuanceType description: Tipo de emissão usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingInvoiceContingency: type: object required: – id allOf: – #/definitions/outgoingInvoiceContingency contingency: description: Contingência type: object required: – entryDate – contingencyType – contingencyIssuanceType – state – active properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial entryDate: type: string format: date-time description: Data de entrada exitDate: type: string format: date-time description: Data de saída contingencyType: type: string allOf: – #/definitions/contingencyType description: Tipo de contigência contingencyIssuanceType: type: string allOf: – #/definitions/contingencyIssuanceType description: Tipo de emissão de contigência state: type: integer format: int64 description: Estado cause: type: string maxLength: 1000 description: Motivo active: type: boolean description: Ativo usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: nfeParameter: description: Parâmetros do sistema type: object required: – e070emp – code – value properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Identificador da filial code: type: string description: Chave do parâmetro value: type: string maxLength: 1000 description: Valor do parâmetro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editNfeParameter: type: object required: – id allOf: – #/definitions/nfeParameter 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. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy 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 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