fiscaldocumentissuance

2.0info: 1.80.1 fiscaldocumentissuance description: Servico x-senior-domain: erpx_dfi x-senior-domain-path: erpx_dfi x-senior-service-path: fiscaldocumentissuance contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_dfisecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /fiscaldocumentissuance/queries/getBranchIntegrationType: post: description: Query para retornar o tipo de integração da filial para autorizar a nota fiscal na SEFAZ tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: branchId: type: string description: Id da filial responses: 200: description: Ok schema: type: object properties: integrationType: type: string allOf: – #/definitions/enumTipoIntegracaoSefaz description: Tipo da integracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para retornar o tipo de integração da filial para autorizar a nota fiscal na SEFAZ tags: – Queries x-senior-visibility: PRIVATE parameters: – name: branchId description: Id da filial in: query type: string responses: 200: description: Ok schema: type: object properties: integrationType: type: string allOf: – #/definitions/enumTipoIntegracaoSefaz description: Tipo da integracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/queries/getPdfDocument: post: description: Obter o documento em PDF do eDocs tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentKey – documentType – branchId properties: documentKey: type: string description: Chave do documento documentType: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do documento branchId: type: string description: Id da filial responses: 200: description: Ok schema: type: object required: – file properties: file: type: string description: Arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/queries/exportE070filDfiXml: 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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/queries/exportE006pai: 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 /fiscaldocumentissuance/queries/exportE032edc: 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 /fiscaldocumentissuance/queries/exportE020snf: 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 /fiscaldocumentissuance/queries/exportE020snfDfiGer: 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 /fiscaldocumentissuance/queries/exportE020doc: 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 /fiscaldocumentissuance/queries/exportE020docBatch: 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 /fiscaldocumentissuance/queries/exportE070filDfiGer: 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 /fiscaldocumentissuance/queries/exportE020docRecEvent: 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 /fiscaldocumentissuance/queries/exportE020docGnre: 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 /fiscaldocumentissuance/queries/exportE070filDfiUtc: 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 /fiscaldocumentissuance/queries/exportTipoDocumentoGnre: 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 /fiscaldocumentissuance/queries/exportE020docCarrie: 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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/getSeriesLastIssueDate: post: description: Obter a data da ultima geração do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – seriesId – issueDate properties: seriesId: type: string maxLength: 36 description: Id da série issueDate: type: string format: date-time description: Data de Emissão responses: 200: description: Ok schema: type: object required: – lastIssueDate – lastIssueNumber properties: lastIssueDate: type: string format: date-time description: Última data de emissão lastIssueNumber: type: integer format: int64 description: Número da nota 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/deleteSeriesLastIssueNumber: post: description: Obter a data da ultima geração do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – seriesId – issueNumber – issueDate properties: seriesId: type: string maxLength: 36 description: Id da série issueNumber: type: integer format: int64 description: Número para exclusão issueDate: type: string format: date-time description: Data de Emissão responses: 200: description: Ok schema: type: object required: – seriesId – issueNumber – issueDate – status properties: seriesId: type: string maxLength: 36 description: Id da série issueNumber: type: integer format: int64 description: Número para exclusão issueDate: type: string format: date-time description: Data de Emissão status: type: boolean description: status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/getSeriesIssueNumber: post: description: Obter o número da última geração do documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – seriesId – issueDate properties: seriesId: type: string maxLength: 36 description: Id da série issueDate: type: string format: date-time description: Data de Emissão responses: 200: description: Ok schema: type: object required: – issueDate – issueNumber properties: issueDate: type: string format: date-time description: Data de emissão issueNumber: type: integer format: int64 description: Número da nota 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/getLastInvoice: post: description: Obter o número da última nota da série tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – seriesId properties: seriesId: type: string maxLength: 36 description: Id da série responses: 200: description: Ok schema: type: object required: – lastInvoiceNumber properties: lastInvoiceNumber: type: integer format: int64 description: Número da nota 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/deleteDocument: post: description: Primitiva para exclusão de documento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – seriesId – documentNumber properties: seriesId: type: string description: Id da série documentNumber: type: integer format: int64 description: Número do documento responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: True se excluído / false não excluído 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/validateIssueDateChange: post: description: Validar data do número disponibilizado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – seriesId – documentNumber – newIssueDate properties: seriesId: type: string description: Id da série documentNumber: type: integer format: int64 description: Número do documento newIssueDate: type: string format: date-time description: Nova data de emissão responses: 200: description: Ok schema: type: object properties: validationStatus: type: boolean description: Situação da validação constraintDocumentNumber: type: integer format: int64 description: Número do documento de consistência constraintDocumentIssueDate: type: string format: date-time description: Data de emissão do documento de consistência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/issueCargoManifest: post: description: Emitir MDF-e SEFAZ tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – issueCargoManifest properties: issueCargoManifest: type: object allOf: – #/definitions/recCargoManifest description: Id da nota fiscal responses: 200: description: Ok schema: type: object required: – issuanceBatchId – externalId properties: issuanceBatchId: type: string description: Id do batch de emissão externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/closingCargoManifest: post: description: Encerramento MDF-e tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – closingCargoManifest properties: closingCargoManifest: type: object allOf: – #/definitions/recClosingCargoManifest description: Record com os dados do MDF-e responses: 200: description: Ok schema: type: object required: – issuanceBatchId – externalId properties: issuanceBatchId: type: string description: Id do batch de emissão externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/cancelCargoManifest: post: description: Cancelamento MDF-e tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cancelCargoManifest properties: cancelCargoManifest: type: object allOf: – #/definitions/recCancelCargoManifest description: Record com os dados do MDF-e responses: 200: description: Ok schema: type: object required: – issuanceBatchId – externalId properties: issuanceBatchId: type: string description: Id do batch de emissão externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/addDriverCargoManifest: post: description: Adicionar Condutor MDF-e tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – addDriverCargoManifest properties: addDriverCargoManifest: type: object allOf: – #/definitions/recAddDriverCargoManifest description: Record com os dados do MDF-e responses: 200: description: Ok schema: type: object required: – issuanceBatchId – externalId properties: issuanceBatchId: type: string description: Id do batch de emissão externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/addDocumentCargoManifest: post: description: Adicionar Documento MDF-e tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – addDocumentCargoManifest properties: addDocumentCargoManifest: type: object allOf: – #/definitions/recAddDocumentCargoManifest description: Record com os dados do MDF-e responses: 200: description: Ok schema: type: object required: – issuanceBatchId – externalId properties: issuanceBatchId: type: string description: Id do batch de emissão externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/issueInvoice: post: description: Emissão de nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – issueInvoice properties: issueInvoice: type: object allOf: – #/definitions/recIssueInvoice description: Requisição da emissão responses: 200: description: Ok schema: type: object required: – issuanceBatchId – externalId properties: issuanceBatchId: type: string description: Id do batch de emissão externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/issueServiceInvoice: post: description: Emissão de nota fiscal de serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – issueServiceInvoice properties: issueServiceInvoice: type: object allOf: – #/definitions/recIssueServiceInvoice description: Requisição da emissão responses: 200: description: Ok schema: type: object required: – issuanceBatchId – externalId properties: issuanceBatchId: type: string description: Id do batch de emissão externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/deleteDocumentEvent: post: description: Exclusão de evento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – externalId properties: externalId: type: string description: Id externo responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: Situação da exclusão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/issueAdjustmentLetter: post: description: Emissão da carta de correção tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – documentKey – sequence – issueDate – adjustmentDescription – externalId properties: branchId: type: string description: Id filial documentKey: type: string description: Chave do documento eletrônico sequence: type: integer format: int64 description: Número da sequencia issueDate: type: string format: date-time description: Data do evento adjustmentDescription: type: string description: Texto da correção externalId: type: string description: Id da série da nota fiscal responses: 200: description: Ok schema: type: object required: – externalId properties: externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/cancelInvoice: post: description: Cancelamento de nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cancelInvoice properties: cancelInvoice: type: object allOf: – #/definitions/recCancelInvoice description: Requisição do cancelamento responses: 200: description: Ok schema: type: object required: – externalId properties: externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/cancelServiceInvoice: post: description: Cancelamento da nota fiscal de serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cancelServiceInvoice properties: cancelServiceInvoice: type: object allOf: – #/definitions/recCancelServiceInvoice description: Requisição do cancelmanento responses: 200: description: Ok schema: type: object required: – externalId properties: externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/disableInvoice: post: description: Inutilização de nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – disableInvoice properties: disableInvoice: type: object allOf: – #/definitions/recDisableInvoice description: Requisição da inutilização responses: 200: description: Ok schema: type: object required: – externalId properties: externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/issueInvoiceConsult: post: description: Consulta da nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentKeys properties: documentKeys: type: array items: type: string minimum: 1 description: Identificadores das Notas Fiscais responses: 200: description: Ok schema: type: object required: – returnConsultDocuments properties: returnConsultDocuments: type: array items: type: object allOf: – #/definitions/returnConsultDocument minimum: 1 description: Retorno das consultas das Notas Fiscais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/consultInvoice: post: description: Consulta da nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – externalId properties: documentKey: type: string description: Identificadores das Notas Fiscais externalId: type: string description: ID de controle externo responses: 200: description: Ok schema: type: object required: – externalId properties: externalId: type: string description: ID de controle externo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/consultContingencyStatus: post: description: Consultar a situação da contingência no eDocs tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId properties: branchId: type: string description: Id da filial disAut: type: string allOf: – #/definitions/enumDisAut description: Dispositivo autorizado responses: 200: description: Ok schema: type: object required: – isInContingency properties: isInContingency: type: boolean description: Indicativo se est? em contingência 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/actions/issueCarrie: post: description: Emissão de CTe tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – issueCarrie properties: branchId: type: string description: Id filial ERP issueCarrie: type: array items: type: object allOf: – #/definitions/recIssueCarrie minimum: 1 description: Dados de entrada para a emissão do CTe responses: 200: description: Ok schema: type: object required: – retornoIssueCarrie properties: retornoIssueCarrie: type: array items: type: object allOf: – #/definitions/recIssueCarrieOutput minimum: 1 description: Id do batch de emissão 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/actions/importE070filDfiXml: 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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/actions/importE006pai: 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 /fiscaldocumentissuance/actions/importE032edc: 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 /fiscaldocumentissuance/actions/importE020snf: 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 /fiscaldocumentissuance/actions/importE020snfDfiGer: 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 /fiscaldocumentissuance/actions/importE020doc: 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 /fiscaldocumentissuance/actions/importE020docBatch: 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 /fiscaldocumentissuance/actions/importE070filDfiGer: 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 /fiscaldocumentissuance/actions/importE020docRecEvent: 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 /fiscaldocumentissuance/actions/importE020docGnre: 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 /fiscaldocumentissuance/actions/importE070filDfiUtc: 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 /fiscaldocumentissuance/actions/importTipoDocumentoGnre: 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 /fiscaldocumentissuance/actions/importE020docCarrie: 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 /fiscaldocumentissuance/signals/checkPendingIssueInvoice: post: description: Consulta no e-Doc documentos pendentes tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/signals/checkPendingIssueCarrie: post: description: Consulta no e-Doc Cte pendentes tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/signals/checkContingencyAuthorizedInvoices: post: description: Consulta no e-Doc documentos em contingência tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/signals/generateGNRE: post: description: Sinal para geração de guia tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – infos – branchId – anticipationNoteId properties: infos: type: object allOf: – #/definitions/recGNRE description: Requisicao de GNRE branchId: type: string description: Id da filial anticipationNoteId: type: string description: Id da Guia responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/signals/retornoSituacaoDocumentos: post: description: Evento enviado pelo eDocs para notificar que um documento deve seu status atualizado tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – situacoes properties: situacoes: type: array items: type: object allOf: – #/definitions/situacaoDocumentoEdocs minimum: 1 description: Situações dos documentos retornados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/saleInvoiceSent: post: description: Evento para envio de nota x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – integrationId properties: integrationId: type: string description: Identificador da integração de emissão da nota fiscal de saída responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/cargoManifestBatchCreated: post: description: Evento de lote criado para emissão de MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – batchId – cargoManifest properties: batchId: type: string description: Id do lote cargoManifest: type: object allOf: – #/definitions/recCargoManifest description: Requisição de emissão responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/addDocumentCargoManifestBatchCreated: post: description: Evento de lote criado para inclusão de documento no MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – batchId – addDocumentCargoManifest properties: batchId: type: string description: Id do lote addDocumentCargoManifest: type: object allOf: – #/definitions/recAddDocumentCargoManifest description: Requisição de emissão responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/addDriverCargoManifestBatchCreated: post: description: Evento de lote criado para inclusão de documento no MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – batchId – addDriverCargoManifest properties: batchId: type: string description: Id do lote addDriverCargoManifest: type: object allOf: – #/definitions/recAddDriverCargoManifest description: Requisição de emissão responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/cancelCargoManifestBatchCreated: post: description: Evento de lote criado para inclusão de documento no MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – batchId – cancelCargoManifest properties: batchId: type: string description: Id do lote cancelCargoManifest: type: object allOf: – #/definitions/recCancelCargoManifest description: Requisição de emissão responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/closingCargoManifestBatchCreated: post: description: Evento de lote criado para inclusão de documento no MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – batchId – closingCargoManifest properties: batchId: type: string description: Id do lote closingCargoManifest: type: object allOf: – #/definitions/recClosingCargoManifest description: Requisição de emissão responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/issueCargoManifestSuccess: post: description: Evento de sucesso da emissão do MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocolNumber – autorizationDateTime properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização contingencyDocumentKey: type: string description: Chave do documento em contingência responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/issueCargoManifestError: post: description: Evento de erro da emissão do MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – issueErrorList properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico issueErrorList: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/eventCargoManifestSuccess: post: description: Evento de sucesso dos eventos do MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – protocolNumber – autorizationDateTime properties: externalId: type: string description: Identificador externo protocolNumber: type: string description: Protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/eventCargoManifestError: post: description: Evento de erro dos eventos do MDF-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – issueErrorList properties: externalId: type: string description: Identificador externo issueErrorList: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/cancelarNotaFiscalEntradaSucesso: post: description: Evento de sucesso na inutilização da nota de entrada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocolNumber – autorizationDateTime – issuingUser properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização issuingUser: type: string description: Usuário solicitante da inutilização da NF responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/cancelarNotaFiscalEntradaErro: post: description: Evento de erro na inutilização da nota de entrada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – issuingUser – invoiceIssueErrors properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave eletrônica do documento issuingUser: type: string description: Usuário inutilização NF invoiceIssueErrors: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/pendingIssueInvoiceConsult: post: description: Evento para informar consulta da nota x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId properties: externalId: type: string description: Identificador externo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/batchCreated: post: description: Evento de lote criado para emissão da nota fiscal eletrônica de produto x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – batchId – issueInvoice properties: batchId: type: string description: Id do lote issueInvoice: type: object allOf: – #/definitions/recIssueInvoice description: Requisição de emissão responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/batchServiceInvoiceIssueCreated: post: description: Evento de lote criado para emissão da nota fiscal eletrônica de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – batchId – issueServiceInvoice properties: batchId: type: string description: Id do lote issueServiceInvoice: type: object allOf: – #/definitions/recIssueServiceInvoice description: Requisição de emissão responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/saleInvoiceIssueSuccess: post: description: Evento de sucesso na emissão da nota x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocoloNumber – autorizationDateTime properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocoloNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização documentNumber: type: integer format: int64 description: Número do documento gerado (para NFSe) contingencyDocumentKey: type: string description: Chave do documento em contingência contingencyAutorizationDateTime: type: string format: date-time description: Data e hora da autorização em contingência contingencyType: type: string allOf: – #/definitions/enumTipCtg description: Tipo da contingência responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/saleInvoiceIssueError: post: description: Evento de erro na emissão da nota de saída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – invoiceIssueErrors properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave eletrônica do documento invoiceIssueErrors: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/saleInvoiceIssueDenied: post: description: Evento de nota denegada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocoloNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/notaFiscalEntradaEmissaoSuccesso: post: description: Evento de sucesso na emissão da nota x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocolNumber – autorizationDateTime – issuingUser properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização issuingUser: type: string description: Usuário emissão NF responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/notaFiscalEntradaEmissaoErro: post: description: Evento de erro na emissão da nota de saída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – issuingUser – invoiceIssueErrors properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave eletrônica do documento issuingUser: type: string description: Usuário emissão NF invoiceIssueErrors: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/disableSaleInvoiceSuccess: post: description: Evento de sucesso na inutilização da nota x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocolNumber – autorizationDateTime – disableReason properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização disableReason: type: string description: Justificativa da inutilização responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/disableSaleInvoiceError: post: description: Evento de erro na emissão da nota de saída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – invoiceIssueErrors properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave eletrônica do documento invoiceIssueErrors: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/saleInvoiceCancelSuccess: post: description: Evento de sucesso do cancelamento da nota x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocoloNumber – autorizationDateTime properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocoloNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/saleInvoiceCancelError: post: description: Evento de erro do cancelamento da nota de saída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – invoiceCancelErrors properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave eletrônica do documento invoiceCancelErrors: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/consultaEmissaoNFe: post: description: Evento para informar consulta da emissao NFE x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId properties: externalId: type: string description: Identificador externo responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/inutilizacaoNotaFiscalEntradaSuccesso: post: description: Evento de sucesso na inutilização da nota de entrada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocolNumber – autorizationDateTime – issuingUser properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização issuingUser: type: string description: Usuário solicitante da inutilização da NF responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/inutilizacaoNotaFiscalEntradaErro: post: description: Evento de erro na inutilização da nota de entrada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – issuingUser – invoiceIssueErrors properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave eletrônica do documento issuingUser: type: string description: Usuário inutilização NF invoiceIssueErrors: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/cancelServiceInvoiceSucess: post: description: Evento de sucesso no Cancelamento da NFSe x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocolNumber – autorizationDateTime – issuingUser properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização issuingUser: type: string description: Usuário solicitante da inutilização da NFs-e responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/cancelServiceInvoiceError: post: description: Evento de erro no Cancelamento da NFSe x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – issuingUser – invoiceIssueErrors properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave eletrônica do documento issuingUser: type: string description: Usuário inutilização NFs-e invoiceIssueErrors: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/issueAdjustmentLetterSuccess: post: description: Evento de sucesso da emissão da carta de correção x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocolNumber – autorizationDateTime properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/issueAdjustmentLetterError: post: description: Evento de erro da emissão da carta de correção x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – adjustmentLetterIssueError properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico adjustmentLetterIssueError: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/gnreSuccess: post: description: Evento de sucesso na geração da GNRE x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – anticipationNoteId – barCode properties: anticipationNoteId: type: string description: Identificador da Guia de Documento barCode: type: string description: Codigo de barras para pagamento da GNRE responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/gnreError: post: description: Evento de erro na geração da GNRE x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – anticipationNoteId – errors properties: anticipationNoteId: type: string description: Identificador da Guia de Documento errors: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/issueCarrieSuccess: post: description: Evento de sucesso da emissão de Conhecimento Eletrônico x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – protocolNumber – autorizationDateTime – tipoAmbiente – tipoDocumento properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização tipoAmbiente: type: string allOf: – #/definitions/enumTipoAmbienteEdocs description: Tipo do Ambiente tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do Documento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/issueCarrieError: post: description: Evento de erro na emissão de Conhecimento Eletrônico x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – externalId – documentKey – issueCarrieError – tipoAmbiente – tipoDocumento properties: externalId: type: string description: Identificador externo documentKey: type: string description: Chave do documento eletrônico issueCarrieError: type: array items: type: object allOf: – #/definitions/recInvoiceIssueError minimum: 1 description: Lista de erros tipoAmbiente: type: string allOf: – #/definitions/enumTipoAmbienteEdocs description: Tipo do Ambiente tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do Documento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/carrieBatchListCreated: post: description: Evento de lote criado para emissão de CT-e x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – carrieBatchListCreated properties: branchId: type: string description: Id filial ERP carrieBatchListCreated: type: array items: type: object allOf: – #/definitions/recCarrieBatchCreated minimum: 1 description: Lista de lotes responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/events/xmlInvoiceImportedReceived: post: description: Nota Importada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/xmlInvoice responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/events/importE070filDfiXmlEvent: 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 /fiscaldocumentissuance/events/exportE070filDfiXmlEvent: 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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/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 /fiscaldocumentissuance/events/importE006paiEvent: 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 /fiscaldocumentissuance/events/exportE006paiEvent: 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 /fiscaldocumentissuance/events/importE032edcEvent: 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 /fiscaldocumentissuance/events/exportE032edcEvent: 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 /fiscaldocumentissuance/events/importE020snfEvent: 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 /fiscaldocumentissuance/events/exportE020snfEvent: 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 /fiscaldocumentissuance/events/importE020snfDfiGerEvent: 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 /fiscaldocumentissuance/events/exportE020snfDfiGerEvent: 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 /fiscaldocumentissuance/events/importE020docEvent: 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 /fiscaldocumentissuance/events/exportE020docEvent: 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 /fiscaldocumentissuance/events/importE020docBatchEvent: 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 /fiscaldocumentissuance/events/exportE020docBatchEvent: 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 /fiscaldocumentissuance/events/importE070filDfiGerEvent: 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 /fiscaldocumentissuance/events/exportE070filDfiGerEvent: 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 /fiscaldocumentissuance/events/importE020docRecEventEvent: 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 /fiscaldocumentissuance/events/exportE020docRecEventEvent: 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 /fiscaldocumentissuance/events/importE020docGnreEvent: 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 /fiscaldocumentissuance/events/exportE020docGnreEvent: 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 /fiscaldocumentissuance/events/importE070filDfiUtcEvent: 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 /fiscaldocumentissuance/events/exportE070filDfiUtcEvent: 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 /fiscaldocumentissuance/events/importTipoDocumentoGnreEvent: 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 /fiscaldocumentissuance/events/exportTipoDocumentoGnreEvent: 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 /fiscaldocumentissuance/events/importE020docCarrieEvent: 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 /fiscaldocumentissuance/events/exportE020docCarrieEvent: 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 /fiscaldocumentissuance/entities/e070filDfiXml: 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: array items: #/definitions/e070filDfiXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e070filDfiXml/{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/e070filDfiXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020snfDfiGer: 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/e020snfDfiGer responses: 200: description: The created resource schema: #/definitions/e020snfDfiGer 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/e020snfDfiGer responses: 200: description: The created resource schema: #/definitions/e020snfDfiGer 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: array items: #/definitions/e020snfDfiGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020snfDfiGer/{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/e020snfDfiGer responses: 200: description: Ok schema: #/definitions/e020snfDfiGer 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/e020snfDfiGer responses: 200: description: Ok schema: #/definitions/e020snfDfiGer 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/e020snfDfiGer 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 /fiscaldocumentissuance/entities/e020snfDfiGer/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e020snfDfiGer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020doc: 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/e020doc responses: 200: description: The created resource schema: #/definitions/e020doc 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/e020doc responses: 200: description: The created resource schema: #/definitions/e020doc 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: array items: #/definitions/e020doc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020doc/{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/e020doc responses: 200: description: Ok schema: #/definitions/e020doc 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/e020doc responses: 200: description: Ok schema: #/definitions/e020doc 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/e020doc 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 /fiscaldocumentissuance/entities/e020doc/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e020doc responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020docBatch: 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/e020docBatch responses: 200: description: The created resource schema: #/definitions/e020docBatch 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/e020docBatch responses: 200: description: The created resource schema: #/definitions/e020docBatch 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: array items: #/definitions/e020docBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020docBatch/{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/e020docBatch responses: 200: description: Ok schema: #/definitions/e020docBatch 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/e020docBatch responses: 200: description: Ok schema: #/definitions/e020docBatch 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/e020docBatch 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 /fiscaldocumentissuance/entities/e020docBatch/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e020docBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e070filDfiGer: 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/e070filDfiGer responses: 200: description: The created resource schema: #/definitions/e070filDfiGer 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/e070filDfiGer responses: 200: description: The created resource schema: #/definitions/e070filDfiGer 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: array items: #/definitions/e070filDfiGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e070filDfiGer/{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/e070filDfiGer responses: 200: description: Ok schema: #/definitions/e070filDfiGer 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/e070filDfiGer responses: 200: description: Ok schema: #/definitions/e070filDfiGer 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/e070filDfiGer 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 /fiscaldocumentissuance/entities/e070filDfiGer/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e070filDfiGer responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020docRecEvent: 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/e020docRecEvent responses: 200: description: The created resource schema: #/definitions/e020docRecEvent 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/e020docRecEvent responses: 200: description: The created resource schema: #/definitions/e020docRecEvent 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: array items: #/definitions/e020docRecEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020docRecEvent/{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/e020docRecEvent responses: 200: description: Ok schema: #/definitions/e020docRecEvent 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/e020docRecEvent responses: 200: description: Ok schema: #/definitions/e020docRecEvent 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/e020docRecEvent 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 /fiscaldocumentissuance/entities/e020docRecEvent/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e020docRecEvent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020docGnre: 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/e020docGnre responses: 200: description: The created resource schema: #/definitions/e020docGnre 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/e020docGnre responses: 200: description: The created resource schema: #/definitions/e020docGnre 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: array items: #/definitions/e020docGnre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e020docGnre/{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/e020docGnre responses: 200: description: Ok schema: #/definitions/e020docGnre 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/e020docGnre responses: 200: description: Ok schema: #/definitions/e020docGnre 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/e020docGnre 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 /fiscaldocumentissuance/entities/e020docGnre/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e020docGnre responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e070filDfiUtc: 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/e070filDfiUtc responses: 200: description: The created resource schema: #/definitions/e070filDfiUtc 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/e070filDfiUtc responses: 200: description: The created resource schema: #/definitions/e070filDfiUtc 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: array items: #/definitions/e070filDfiUtc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/e070filDfiUtc/{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/e070filDfiUtc responses: 200: description: Ok schema: #/definitions/e070filDfiUtc 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/e070filDfiUtc responses: 200: description: Ok schema: #/definitions/e070filDfiUtc 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/e070filDfiUtc 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 /fiscaldocumentissuance/entities/e070filDfiUtc/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e070filDfiUtc responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/tipoDocumentoGnre: 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/tipoDocumentoGnre responses: 200: description: The created resource schema: #/definitions/tipoDocumentoGnre 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/tipoDocumentoGnre responses: 200: description: The created resource schema: #/definitions/tipoDocumentoGnre 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: array items: #/definitions/tipoDocumentoGnre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fiscaldocumentissuance/entities/tipoDocumentoGnre/{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/tipoDocumentoGnre responses: 200: description: Ok schema: #/definitions/tipoDocumentoGnre 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/tipoDocumentoGnre responses: 200: description: Ok schema: #/definitions/tipoDocumentoGnre 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/tipoDocumentoGnre 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 /fiscaldocumentissuance/entities/tipoDocumentoGnre/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoDocumentoGnre responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumTipoICMS: description: Indicativo do Tipo type: string enum: – ICMS00 – ICMS20 – ICMS45 – ICMS60 – ICMS90 – ICMS_OUTRA_UF – ICMSSN enumTipoAmbienteEdocs: description: Tipo do Ambiente eDocs type: string enum: – PRODUCAO – HOMOLOGACAO enumIndTomador: description: Indicador do papel do tomador na prestação do serviço type: string enum: – CONTRIBUINTE_ICMS – CONTRIBUINTE_ISENTO – NAO_CONTRIBUINTE enumTipoServico: description: Indicativo do Tipo de impressão do DACTE type: string enum: – SERVICO_NORMAL – SUBCONTRATACAO – REDESPACHO – REDESPACHO_INTERMEDIARIO – SERVICO_VINCULADO_MULTIMODAL enumTipoImpressao: description: Indicativo do Tipo de impressão do DACTE type: string enum: – RETRATO – PAISAGEM enumTipoCTe: description: Indicativo do Tipo do CTe type: string enum: – OPERACAO_NORMAL – COMPLEMENTO_VALORES – SUBSTITUICAO enumTipoTomador: description: Indicativo do Tipo do Tomador do Serviço type: string enum: – REMETENTE – EXPEDIDOR – RECEBEDOR – DESTINATARIO – OUTROS enumModal: description: Indicativo do Modal type: string enum: – RODOVIARIO – AEREO – AQUAVIARIO – FERROVIARIO – DUTOVIARIO – MULTIMODAL enumVehicleCombinationCategory: description: Categoria de Combinação Veicular type: string enum: – V2 – V4 – V6 – V7 – V8 – V10 – V11 – V12 – V13 – V14 enumTollCardType: description: Tipo do Vale Pedágio type: string enum: – V1 – V2 – V3 enumTpoTra: description: Tipo do transportador type: string enum: – V1 – V2 – V3 enumTipRod: description: Tipo do rodado do veículo type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 enumTipCrr: description: Tipo da corroceria do veículo type: string enum: – V00 – V01 – V02 – V03 – V04 – V05 enumTipPrt: description: Tipo do proprietário type: string enum: – V0 – V1 – V2 enumEmitTypeMdfe: description: Tipo Emitente MDF-e type: string enum: – V1 – V2 – V3 enumEmissionTypeMdfe: description: Tipo Emissao MDF-e type: string enum: – V1 – V2 enumTranspTypeMdfe: description: Tipo Transporte MDF-e type: string enum: – V1 – V2 – V3 – V4 enumRespSegTypeMdfe: description: Tipo Transporte MDF-e type: string enum: – V1 – V2 enumImpostoGuia: description: Impostos guia type: string enum: – FCP – DIFAL – ICMS_ST – FCP_ST enumMotDes: description: Mot Des type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V16 – V90 enumTipImpDoc: description: Tipo de imposto documento type: string enum: – IPI – IPI_PRESUMIDO – IPI_DEVOLVIDO – IPI_CREDITADO – ICMS – ICMS_SIMPLES – ICMS_FUTURO – ICMS_DIFERIDO – ICMS_DESONERADO – ICMS_ST – ICMS_UF_DESTINO – ICMS_ISENTAS_OUTRAS – ICMS_CREDITADO – ICMS_EFETIVO – ICMS_ST_RETIDO_ANT – ICMS_ST_FUTURO – ICMS_ST_SOLIDARIO – ICMS_IMPORTACAO – ICMS_DESTINO – FCP – FCP_ST – FCP_UF_DESTINO – FCP_ST_RETIDO_ANT – ISS – COFINS – COFINS_RETIDO – COFINS_RECUPERAR_IMPORTACAO – COFINS_RECUPERAR – COFINS_DEVOLVIDO – PIS – PIS_RETIDO – PIS_RECUPERAR_IMPORTACAO – PIS_RECUPERAR – PIS_DEVOLVIDO – CSLL – ISS_RETIDO – IRRF – INSS – INSS_PATRONAL – IMPOSTO_IMPORTACAO – DIFAL – DIFAL_DEVOLVIDO – CIDE_TECNOLOGIA – FUNRURAL_TOTAL – FUNRURAL_INSS – FUNRURAL_RAT – FUNRURAL_SENAR enumExiIss: description: Exibigilidade do ISS type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 enumAplNop: description: Aplicação da natureza da operação type: string enum: – VN – VS – VI – VR – VO – VT – VD – VA – VB – VE – VC – VF – VG – VV – VX enumProSer: description: Enumeração de Produto serviço type: string enum: – VP – VS enumBanOpe: description: Bandeira da operadora de cartão de crédito/débito type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 – V07 – V08 – V09 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 – V21 – V22 – V23 – V24 – V25 – V26 – V27 – V99 enumTipInt: description: Enumeração do tipo de Integração type: string enum: – V1 – V2 – V3 enumTipFpg: description: Tipo pagamento type: string enum: – V01 – V02 – V03 – V04 – V05 – V10 – V11 – V12 – V13 – V15 – V16 – V17 – V18 – V19 – V90 – V99 enumIndPag: description: Forma de pagamento type: string enum: – V0 – V1 enumCifFob: description: Tipo de frete type: string enum: – V0 – V1 – V2 – V3 – V4 – V9 enumOriMer: description: Origem fiscal da mercadoria type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 enumJurFis: description: Tipo Pessoa type: string enum: – VJ – VF enumTipMer: description: Tipo de mercado type: string enum: – VI – VE – VP enumCodCrt: description: Código do Regime Tribut?rio type: string enum: – V1 – V2 – V3 enumCrt: description: Código do Regime Tribut?rio type: string enum: – SIMPLES_NACIONAL – SIMPLES_NACIONAL_EXCESSO – REGIME_NORMAL enumDisAut: description: Dispositivo autorizado type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 enumAplSnf: description: Aplicação type: string enum: – VS – VM – VE – VF – VD enumUtcType: description: Fuso Horario UTC type: string enum: – UTC_1 – UTC_2 – UTC_3 – UTC_4 – UTC_5 enumSitDoe: description: Tipo de documento – eDocs type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 – V07 – V08 – V09 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 enumTipoDocumento: description: Tipo de documento – eDocs type: string enum: – V1 – V2 – V3 – V5 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 enumTipoProcessamento: description: Tipo de processamento – eDocs type: string enum: – V1 – V2 enumTipCtg: description: Tipo da contingência NF-e type: string enum: – V1 – V2 – V4 – V5 – V6 – V7 enumTipOpe: description: Status do lote de processamento type: string enum: – V0 – V1 enumNatOps: description: Natureza da operação type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 enumRegEst: description: Regime Especial de Tributação type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 enumBatchProcessingType: description: Status do lote de processamento type: string enum: – V1 – V2 – V3 – V4 enumBatchStatus: description: Status do lote de processamento type: string enum: – PENDENTE – PROCESSANDO – SUCESSO – ERRO enumFinNfe: description: Tipo da nota fiscal type: string enum: – V1 – V2 – V3 – V4 – VS enumTipNfs: description: Tipo da nota fiscal type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V20 – V21 – V22 – V99 enumIndicativeIntermediation: description: Indicativo de intermediação type: string enum: – V0 – V1 – V9 enumIndPre: description: Indicativo de presença do consumidor type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V9 enumIssueErrorType: description: Indicativo de tipo de erro na emissão type: string enum: – VERRO – VNAOAUTORIZADA enumTipVii: description: Tipo de via internacional type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 enumTipItd: description: Forma de importação quanto ? intermediação type: string enum: – V1 – V2 – V3 enumTipoIntegracaoSefaz: description: Indicativo de tipo de integração com a Sefaz type: string enum: – VSINCRONO – VASSINCRONO tipoDiferimento: description: Indicativo de como ser? o tipo de diferimento type: string enum: – BASE – VALOR enumTipEve: description: Tipo do evento da carta de correção type: string enum: – CCE – ENCERRAR_MDFE – CANCELAR_MDFE – INCLUIR_CONDUTOR_MDFE – INCLUIR_DOCUMENTO_MDF – CANCELAR_SERVICO enumAplLiq: description: Enumeração do tipo de aplicação do valor do imposto type: string enum: – VA – VS – VN environmentStepStatus: description: Status do step de duplicação de empresas e filiais type: string enum: – IN_PROGRESS – DONE – ERROR enumLoadType: description: Tipo da carga type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN recIssueCarrieOutput: description: Record de retorno da action issueCarrie type: object required: – issuanceBatchId – externalId properties: issuanceBatchId: type: string description: Id do batch de emissão externalId: type: string description: ID de controle externo recCarrieBatchCreated: description: Record de itens de lote para processamento type: object required: – batchId – issueCarrie properties: batchId: type: string description: Id do lote issueCarrie: type: object allOf: – #/definitions/recIssueCarrie description: CTes para emissão recVPrest: description: Valores da Prestação de Serviço type: object properties: vTPrest: type: string description: Valor Total da Prestação do Serviço minimum: 0.00 maximum: 9999999999999.99 default: 0 vRec: type: string description: Valor a Receber minimum: 0.00 maximum: 9999999999999.99 default: 0 comp: type: array items: type: object allOf: – #/definitions/recComp description: Componentes do Valor da Prestação recComp: description: Componentes do Valor da Prestação type: object properties: xNome: type: string description: Nome do componente vComp: type: string description: Valor do componente minimum: 0.00 maximum: 9999999999999.99 recImp: description: Informações relativas aos Impostos type: object properties: icms: type: object allOf: – #/definitions/recICMS description: Informações relativas ao ICMS vTotTrib: type: string description: Valor Total dos Tributos minimum: 0.00 maximum: 9999999999999.99 default: 0 infAdFisco: type: string description: Informações adicionais de interesse do Fisco iCMSUFFim: type: object allOf: – #/definitions/recICMSUFFim description: Informações do ICMS de partilha com a UF de término do serviço de transporte na operação interestadual recICMSUFFim: description: Informações do ICMS de partilha com a UF de término do serviço de transporte na operação interestadual type: object properties: vBCUFFim: type: string description: Valor da BC do ICMS na UF de término da prestação do serviço de transporte minimum: 0.00 maximum: 9999999999999.99 default: 0 pFCPUFFim: type: string description: Percentual do ICMS relativo ao Fundo de Combate à pobreza (FCP) na UF de término da prestação do serviço de transporte minimum: 0.00 maximum: 9999999999999.99 default: 0 pICMSUFFim: type: string description: Alíquota interna da UF de término da prestação do serviço de transporte minimum: 0.00 maximum: 9999999999999.99 default: 0 pICMSInter: type: string description: Alíquota interestadual das UF envolvidas minimum: 0.00 maximum: 9999999999999.99 default: 0 vFCPUFFim: type: string description: Valor do ICMS relativo ao Fundo de Combate á Pobreza (FCP) da UF de término da prestação minimum: 0.00 maximum: 9999999999999.99 default: 0 vICMSUFFim: type: string description: Valor do ICMS de partilha para a UF de término da prestação do serviço de transporte minimum: 0.00 maximum: 9999999999999.99 default: 0 vICMSUFIni: type: string description: Valor do ICMS de partilha para a UF de início da prestação do serviço de transporte minimum: 0.00 maximum: 9999999999999.99 default: 0 recICMS: description: Informações relativas ao ICMS type: object properties: tipoICMS: type: string allOf: – #/definitions/enumTipoICMS description: tipo do ICMS cst: type: string description: Classificação Tributária do Serviço vBC: type: string description: Valor da BC do ICMS minimum: 0.00 maximum: 9999999999999.99 default: 0 pICMS: type: string description: Alíquota do ICMS minimum: 0.00 maximum: 9999999999999.99 default: 0 vICMS: type: string description: Valor do ICMS minimum: 0.00 maximum: 9999999999999.99 default: 0 pRedBC: type: string description: Percentual de redução da BC minimum: 0.00 maximum: 9999999999999.99 default: 0 vCred: type: string description: Valor do Crédito outorgado/Presumido minimum: 0.00 maximum: 9999999999999.99 default: 0 recInfCTeNorm: description: Grupo de informações do CTe Normal e Substituto type: object properties: infCarga: type: object allOf: – #/definitions/recInfCarga description: Informações da Carga do CTe infDoc: type: object allOf: – #/definitions/recInfDoc description: Informações dos documentos transportados pelo CTe Opcional para Redespacho Intermediario e Serviço vinculado a multimodal infModal: type: object allOf: – #/definitions/recInfModal description: Informações do modal recInfCarga: description: Informações da Carga do CTe type: object properties: vCarga: type: string description: Valor total da carga minimum: 0.00 maximum: 9999999999999.99 default: 0 proPred: type: string description: Produto predominante xOutCat: type: string description: Outras características da carga infQ: type: array items: type: object allOf: – #/definitions/recInfQ description: Informações de quantidades da Carga do CTe vCargaAverb: type: string description: Valor da Carga para efeito de averbação minimum: 0.00 maximum: 9999999999999.99 default: 0 recInfQ: description: Informações de quantidades da Carga do CTe type: object properties: cUnid: type: string description: Código da Unidade de Medida tpMed: type: string description: Tipo da Medida qCarga: type: number format: double description: Quantidade minimum: 0.00 maximum: 9999999999999.99 default: 0.00 recInfDoc: description: Informações dos documentos transportados pelo CTe Opcional para Redespacho Intermediario e Serviço vinculado a multimodal. type: object properties: infNFe: type: array items: type: object allOf: – #/definitions/recInfNFe description: Informações das NFe infOutros: type: array items: type: object allOf: – #/definitions/recInfOutros description: Informações dos demais documentos recInfOutros: description: Informações dos demais documentos type: object properties: tpDoc: type: string description: Tipo de documento originário descOutros: type: string description: Descrição do documento nDoc: type: string description: Número dEmi: type: string description: Data de Emissão vDocFisc: type: string description: Valor do documento dPrev: type: string description: Data prevista de entrega infUnidCarga: type: array items: type: object allOf: – #/definitions/recInfUnidCarga description: Informações das Unidades de Carga(Containeres/ULD/Outros) infUnidTransp: type: array items: type: object allOf: – #/definitions/recInfUnidTransp description: Informações das Unidades de Transporte (Carreta/Reboque/Vagão) recInfNFe: description: Informações das NFe type: object properties: chave: type: string description: Chave de acesso da NF-e pin: type: string description: PIN SUFRAMA dPrev: type: string description: Data prevista de entrega infUnidCarga: type: array items: type: object allOf: – #/definitions/recInfUnidCarga description: Informações das Unidades de Carga(Containeres/ULD/Outros) infUnidTransp: type: array items: type: object allOf: – #/definitions/recInfUnidTransp description: Informações das Unidades de Transporte (Carreta/Reboque/Vagão) recInfUnidCarga: description: Informações das Unidades de Carga(Containeres/ULD/Outros) type: object properties: tpUnidCarga: type: string description: Tipo da Unidade de Carga idUnidCarga: type: string description: Identificação da Unidade de Carga lacUnidCarga: type: array items: type: object allOf: – #/definitions/recLacUnidCarga description: Lacres das Unidades de Carga qtdRat: type: string description: Quantidade rateada (Peso,Volume) recInfUnidTransp: description: Informações das Unidades de Transporte (Carreta/Reboque/Vagão) type: object properties: tpUnidTransp: type: string description: Tipo da Unidade de Transporte idUnidTransp: type: string description: Identificação da Unidade de Transporte lacUnidTransp: type: array items: type: object allOf: – #/definitions/recLacUnidTransp description: Lacres das Unidades de Transporte infUnidCarga: type: array items: type: object allOf: – #/definitions/recInfUnidCarga description: Informações das Unidades de Carga (Containeres/ULD/Outros) qtdRat: type: string description: Quantidade rateada (Peso,Volume) recLacUnidTransp: description: Lacres das Unidades de Transporte type: object properties: nLacre: type: string description: Número do lacre recLacUnidCarga: description: Lacres das Unidades de Carga type: object properties: nLacre: type: string description: Número do lacre recInfModal: description: Informações do modal type: object properties: rodo: type: object allOf: – #/definitions/recRodo description: Informações do modal Rodoviário recRodo: description: Informações do modal Rodoviário type: object properties: rntrc: type: string description: Registro Nacional de Transportadores Rodoviários de Carga recPessoa: description: Pessoa type: object properties: cnpj: type: string description: CNPJ cpf: type: string description: CPF ie: type: string description: Inscrição Estadual xNome: type: string description: Razão social ou Nome xFant: type: string description: Nome fantasia fone: type: string description: Telefone ender: type: object allOf: – #/definitions/recEnderecoCTe description: Endereço email: type: string description: Endereço de email iest: type: string description: IE do Substituto Tribut?rio crt: type: string allOf: – #/definitions/enumCrt description: Código de Regime Tributário recEnderecoCTe: description: Record de dados de endereço type: object properties: xLgr: type: string description: Logradouro nro: type: string description: Número xCpl: type: string description: Complemento xBairro: type: string description: Bairro cMun: type: integer format: int64 description: Código do município maximum: 9999999 xMun: type: string description: Nome do município uf: type: string description: Sigla da UF cep: type: string description: Código do CEP cPais: type: string description: Código do País xPais: type: string description: Nome do País fone: type: string description: Telefone email: type: string description: Endereço de email recObsCont: description: Campo de uso livre do contribuinte type: object properties: xTexto: type: string description: Conteúdo do campo recObsFisco: description: Campo de uso livre do contribuinte type: object properties: xTexto: type: string description: Conteúdo do campo recFluxo: description: Previsão do fluxo da carga type: object properties: xOrig: type: string description: Sigla ou código interno da Filial/Porto/Estação/ Aeroporto de Origem pass: type: object allOf: – #/definitions/recPass description: xDest: type: string description: Sigla ou código interno da Filial/Porto/Estação/Aeroporto de Destino xRota: type: string description: Código da Rota de Entrega recPass: description: type: object properties: xPass: type: string description: Sigla ou código interno da Filial/Porto/Estação/Aeroporto de Passagem recCompl: description: Dados complementares da GTVe para fins operacionais ou comerciais type: object properties: xCaracAd: type: string description: Característica adicional do transporte xCaracSer: type: string description: Característica adicional do serviço xEmi: type: string description: Funcionário emissor do CTe fluxo: type: object allOf: – #/definitions/recFluxo description: Previsão do fluxo da carga entrega: type: object allOf: – #/definitions/recEntregaCompl description: Informações ref. a previsão de entrega origCalc: type: string description: Município de origem para efeito de cálculo do frete destCalc: type: string description: Município de destino para efeito de cálculo do frete xObs: type: string description: Observações Gerais obsCont: type: object allOf: – #/definitions/recObsCont description: Campo de uso livre do contribuinte obsFisco: type: object allOf: – #/definitions/recObsFisco description: Campo de uso livre do contribuinte recEntregaCompl: description: Informações ref. a previsão de entrega type: object properties: semData: type: object allOf: – #/definitions/recSemData description: Entrega sem data definida semHora: type: object allOf: – #/definitions/recSemHora description: Entrega sem hora definida recSemData: description: Entrega sem data definida type: object properties: tpPer: type: integer format: int64 description: Tipo de data/período programado para entrega recSemHora: description: Entrega sem hora definida type: object properties: tpHor: type: integer format: int64 description: Tipo de hora recIde: description: Identificação do CTe type: object properties: cUF: type: string description: Código da UF do emitente do CTe. cfop: type: string description: Código Fiscal de Operações e Prestações natOp: type: string description: Natureza da Operação mod: type: string description: Modelo do documento fiscal dhEmi: type: string description: Data e hora de emissão do CTe tpImp: type: string allOf: – #/definitions/enumTipoImpressao description: Formato de impressão do DACTE tpCTe: type: string allOf: – #/definitions/enumTipoCTe description: Tipo do CTe verProc: type: string description: Versão do processo de emissão indGlobalizado: type: string description: Indicador de CTe globalizado cMunEnv: type: integer format: int64 description: Código do Município de envio do CTe maximum: 9999999 xMunEnv: type: string description: Nome do Município de envio do CTe ufEnv: type: string description: Sigla da UF de envio do CTe modal: type: string allOf: – #/definitions/enumModal description: Modal tpServ: type: string allOf: – #/definitions/enumTipoServico description: Tipo do Serviço cMunIni: type: string description: Código do Município de início da prestação xMunIni: type: string description: Nome do Município do início da prestação ufIni: type: string description: UF do início da prestação cMunFim: type: string description: Código do Município de término da prestação xMunFim: type: string description: Nome do Município do término da prestação ufFim: type: string description: UF do término da prestação retira: type: string description: Indicador se o Recebedor retira no Aeroporto, Filial, Porto ou Estação de Destino? xDetRetira: type: string description: Detalhes do retira indIEToma: type: string allOf: – #/definitions/enumIndTomador description: Indicador do papel do tomador na prestação do serviço toma: type: object allOf: – #/definitions/recToma description: Indicador do papel do tomador do serviço no CTe dhCont: type: string description: Data e Hora da entrada em contingência xJust: type: string description: Justificativa da entrada em contingência recToma: description: Indicador do papel do tomador do serviço no CTe type: object required: – tipoTomador properties: tipoTomador: type: string allOf: – #/definitions/enumTipoTomador description: Tomador do Serviço dadosToma: type: object allOf: – #/definitions/recPessoa description: Dados do Tomador recIssueCarrie: description: Record de dados do CTe type: object required: – externalId – serie – nCT properties: externalId: type: string description: Id externo do CTe accessKey: type: string description: Chave de Acesso serie: type: string description: Série nCT: type: integer format: int64 description: Número do CTe ide: type: object allOf: – #/definitions/recIde description: Identificação do CTe compl: type: object allOf: – #/definitions/recCompl description: Dados complementares da GTVe para fins operacionais ou comerciais emit: type: object allOf: – #/definitions/recPessoa description: Dados do emitente (filial) rem: type: object allOf: – #/definitions/recPessoa description: Informações do Remetente das mercadorias transportadas pelo CTe exped: type: object allOf: – #/definitions/recPessoa description: Informações do Expedidor da Carga receb: type: object allOf: – #/definitions/recPessoa description: Informações do Recebedor da Carga dest: type: object allOf: – #/definitions/recPessoa description: Dados do destinatário (cliente) vPrest: type: object allOf: – #/definitions/recVPrest description: Valores da Prestação de Serviço imp: type: object allOf: – #/definitions/recImp description: Informações relativas aos Impostos infCTeNorm: type: object allOf: – #/definitions/recInfCTeNorm description: Grupo de informações do CTe Normal e Substituto returnConsultDocument: description: Record da consulta da situação da emissão da nota fiscal type: object required: – documentKey – contingencyDocumentKey – protocolNumber – autorizationDateTime – documentNumber – documentStatus properties: documentKey: type: string description: Chave eletrônica do documento contingencyDocumentKey: type: string description: Chave eletrônica do documento em contingência protocolNumber: type: string description: Número do protocolo de autorização autorizationDateTime: type: string format: date-time description: Data e hora de autorização documentNumber: type: integer format: int64 description: Numero do Documento documentStatus: type: string allOf: – #/definitions/enumSitDoe description: Situação do Documento recIssueInvoice: description: Record de requisição de emissão de nota fiscal type: object required: – serieId – branchId – invoiceNumber – transactionDescription – operationType – cfop – issuancePurpose – finalConsumer – consumerPresence – externalId – prod – total properties: serieId: type: string description: Id da série da nota fiscal branchId: type: string description: Id filial invoiceNumber: type: integer format: int64 description: Número da nota fiscal transactionDescription: type: string description: Descrição da transação operationType: type: string allOf: – #/definitions/enumTipOpe description: Tipo da operação cfop: type: string description: CFOP issuancePurpose: type: string allOf: – #/definitions/enumFinNfe description: Finalidade da nota fiscal finalConsumer: type: boolean description: Venda ao consumidor consumerPresence: type: string allOf: – #/definitions/enumIndPre description: Indicativo de presença do consumidor intermediaryIndicative: type: string allOf: – #/definitions/enumIndicativeIntermediation description: Indicativo intermediador departureDateTime: type: string format: date-time description: Id da série da nota fiscal externalId: type: string description: Id da série da nota fiscal emit: type: object allOf: – #/definitions/recEmit description: Dados do emitente (filial) cnpjAutXml: type: string maxLength: 14 description: CNPJ ou CPF das pessoas autorizadas a fazer download do xml cpfAutXml: type: string maxLength: 11 description: CNPJ ou CPF das pessoas autorizadas a fazer download do xml dest: type: object allOf: – #/definitions/recDest description: Dados do destinatário (cliente) retirada: type: object allOf: – #/definitions/recEntrega description: Dados do endereço de entrega entrega: type: object allOf: – #/definitions/recEntrega description: Dados do endereço de entrega prod: type: array items: type: object allOf: – #/definitions/recProd minimum: 1 description: Dados dos itens do documento total: type: object allOf: – #/definitions/recTotal description: Valores totais do documento transp: type: object allOf: – #/definitions/recTransp description: Dados de transporte infAdic: type: object allOf: – #/definitions/recInfAdic description: Informações adicionais tipNfs: type: string allOf: – #/definitions/enumTipNfs description: Tipo da nota fiscal pag: type: object allOf: – #/definitions/recPag description: Dados do pagamento infIntermed: type: object allOf: – #/definitions/recInfIntermed description: Dados do intermediador sourceInvoice: type: array items: type: object allOf: – #/definitions/recNFRef description: Notas relacionadas cobr: type: object allOf: – #/definitions/recCobr description: Dados da cobran?a exporta: type: object allOf: – #/definitions/recExporta description: Dados de embarque recNFRef: description: Record de notas fiscais referenciadas type: object properties: refNFe: type: string description: Chave eletrônica da nota fiscal original refNF: type: object allOf: – #/definitions/recRefNF description: Informação da NF modelo 1/1A ou NF modelo 2 referenciada refNFeSig: type: string description: Informação da NF referenciada sigilosa refNFP: type: object allOf: – #/definitions/recRefNFP description: Informações da NF de produtor rural referenciada recDisableIssueInvoice: description: Record de requisição de emissão de nota fiscal type: object required: – branchId – serieId – initialNumber – finalNumber – disableReason properties: branchId: type: string description: Id filial serieId: type: string description: Id da série da nota fiscal initialNumber: type: integer format: int64 description: Número inicial da faixa finalNumber: type: integer format: int64 description: Número final da faixa disableReason: type: string description: Justificativa da inutilização recInfIntermed: description: Dados do intermediário type: object properties: cnpj: type: string description: Cnpj idCadIntTran: type: string maxLength: 60 description: Identificador Cadastro Intermediador recPag: description: Record de dados do pagamento type: object properties: detPag: type: array items: type: object allOf: – #/definitions/recDetPag description: Dados de detalhamento do pagamento vTroco: type: string description: Valor do troco minimum: 0.00 maximum: 9999999999999.99 recCobr: description: Record de dados da cobran?a type: object properties: installmentTotalValue: type: string description: Valor total das parcelas minimum: 0.00 maximum: 9999999999999.99 dup: type: array items: type: object allOf: – #/definitions/recDup description: Dados das duplicatas recExporta: description: Record de dados da cobran?a type: object properties: boardingState: type: string description: UF de embarque boardingPlace: type: string description: local de embarque dispatchPlace: type: string description: local de despacho recDup: description: Record de dados das duplicatas type: object properties: nDup: type: integer format: int64 description: Número da duplicata default: 0 dVenc: type: string format: date description: Data de vencimento da duplicata vDup: type: string description: Valor da duplicata minimum: 0.00 maximum: 9999999999999.99 recInfAdic: description: Record de informações adicionais type: object properties: infAdFisco: type: string description: Informações Adicionais do Fisco infCpl: type: string maxLength: 2000 description: Informações Adicionais do Contribuinte recCard: description: Record com os dados de pagamento em cartão de crédito/débito type: object required: – tpIntegra properties: tpIntegra: type: string allOf: – #/definitions/enumTipInt description: Tipo de Integração para pagamento cnpj: type: string description: CNPJ da Credenciadora de cartão de crédito e/ou débito tBand: type: string allOf: – #/definitions/enumBanOpe description: Bandeira da operadora de cartão de crédito e/ou débito cAut: type: string description: Número de autorização da operação cartão de crédito e/ou débito recDetPag: description: Record com os dados de detalhamento do pagamento type: object properties: indPag: type: string allOf: – #/definitions/enumIndPag description: Indicador da Forma de Pagamento tPag: type: string allOf: – #/definitions/enumTipFpg description: Meio de pagamento xPag: type: string description: Descrição forma de pagamento vPag: type: string description: Valor do Pagamento minimum: 0.00 maximum: 9999999999999.99 card: type: object allOf: – #/definitions/recCard description: Dados de pagamento em cartão de crédito/débito recTransp: description: Record de dados de transporte type: object required: – modFrete properties: modFrete: type: string allOf: – #/definitions/enumCifFob description: Modalidade do frete transporta: type: object allOf: – #/definitions/recTransporta description: Dados da transportadora veicTransp: type: object allOf: – #/definitions/recVeiculo description: Dados do veículo reboque: type: array items: type: object allOf: – #/definitions/recVeiculo description: Dados dos reboques vagao: type: string description: Identificação do vagão balsa: type: string description: Identificação da balsa vol: type: array items: type: object allOf: – #/definitions/recVol description: Dados dos volumes transportados recVol: description: Record de dados dos volumes transportados type: object properties: qVol: type: integer format: int64 description: Quantidade de volumes transportados esp: type: string description: Espécie dos volumes transportados marca: type: string description: Marca dos volumes transportados nVol: type: string description: Numeração dos volumes transportados pesoL: type: number format: double description: Peso Líquido pesoB: type: number format: double description: Peso Bruto recVeiculo: description: Record de dados do veículo type: object required: – placa – uf properties: placa: type: string description: Placa do veículo uf: type: string description: Sigla da UF recTransporta: description: Record de dados da transportadora type: object required: – cnpjCpf – tipPes properties: cnpjCpf: type: string description: CNPJ/CPF tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo da pessoa xNome: type: string description: Razão Social ou nome ie: type: string description: Inscrição Estadual do Transportador xEnder: type: string description: Endereço Completo xMun: type: string description: Nome do município uf: type: string description: Sigla da UF tipMer: type: string allOf: – #/definitions/enumTipMer description: Tipo de mercado recTotal: description: Record de valores totais do documento type: object required: – vBC – vICMS – vICMSDeson – vFCP – vBCST – vST – vFCPST – vProd – vFrete – vSeg – vDesc – vII – vIPI – vIPIDevol – vPIS – vCOFINS – vOutro – vNF – retTrib properties: vBC: type: string description: Base de Cálculo do ICMS minimum: 0.00 maximum: 9999999999999.99 vICMS: type: string description: Valor Total do ICMS minimum: 0.00 maximum: 9999999999999.99 vICMSDeson: type: string description: Valor Total do ICMS desonerado minimum: 0.00 maximum: 9999999999999.99 vFCPUFDest: type: string description: Valor total do ICMS relativo Fundo de Combate a Pobreza (FCP) da UF de destino minimum: 0.00 maximum: 9999999999999.99 vICMSUFDest: type: string description: Valor total do ICMS Interestadual para a UF de destino minimum: 0.00 maximum: 9999999999999.99 vFCP: type: string description: Valor Total do FCP minimum: 0.00 maximum: 9999999999999.99 vBCST: type: string description: Base de Cálculo do ICMS ST minimum: 0.00 maximum: 9999999999999.99 vST: type: string description: Valor Total do ICMS ST minimum: 0.00 maximum: 9999999999999.99 vFCPST: type: string description: Valor Total do FCP (Fundo de Combate a Pobreza) retido por substituição tributária minimum: 0.00 maximum: 9999999999999.99 vProd: type: string description: Valor Total dos produtos e serviços minimum: 0.00 maximum: 9999999999999.99 vFrete: type: string description: Valor Total do Frete minimum: 0.00 maximum: 9999999999999.99 vSeg: type: string description: Valor Total do Seguro minimum: 0.00 maximum: 9999999999999.99 vDesc: type: string description: Valor Total do Desconto minimum: 0.00 maximum: 9999999999999.99 vII: type: string description: Valor Total do II minimum: 0.00 maximum: 9999999999999.99 vIPI: type: string description: Valor Total do IPI minimum: 0.00 maximum: 9999999999999.99 vIPIDevol: type: string description: Valor Total do IPI devolvido minimum: 0.00 maximum: 9999999999999.99 vPIS: type: string description: Valor do PIS minimum: 0.00 maximum: 9999999999999.99 vCOFINS: type: string description: Valor da COFINS minimum: 0.00 maximum: 9999999999999.99 vOutro: type: string description: Outras Despesas acessórias minimum: 0.00 maximum: 9999999999999.99 vNF: type: string description: Valor Total da NF-e minimum: 0.00 maximum: 9999999999999.99 vTotTrib: type: string description: Valor aproximado total de tributos federais, estaduais e municipais minimum: 0.00 maximum: 9999999999999.99 vICMSDiferido: type: string description: Valor de ICMS diferido minimum: 0.00 maximum: 9999999999999.99 retTrib: type: object allOf: – #/definitions/recRetTrib description: Grupo Retençães de Tributos issqnTot: type: object allOf: – #/definitions/recIssqnTot description: Grupo Totais referentes ao ISSQN vFCPSTRet: type: string description: Valor Total do FCP (Fundo de Combate a Pobreza) retido anteriormente por substituição tributária minimum: 0.00 maximum: 9999999999999.99 recIssqnTot: description: Record do Grupo Totais referentes ao ISSQN type: object required: – dCompet properties: vServ: type: string description: Valor total dos serviços sob não incidência ou não tributados pelo ICMS minimum: 0.00 maximum: 9999999999999.99 vBC: type: string description: Valor total Base de Cálculo do ISS minimum: 0.00 maximum: 9999999999999.99 vISS: type: string description: Valor total do ISS minimum: 0.00 maximum: 9999999999999.99 vPIS: type: string description: Valor total do PIS sobre serviços minimum: 0.00 maximum: 9999999999999.99 vCOFINS: type: string description: Valor total da COFINS sobre serviços minimum: 0.00 maximum: 9999999999999.99 dCompet: type: string format: date description: Data da prestação do serviço vDescIncond: type: string description: Valor total desconto minimum: 0.00 maximum: 9999999999999.99 vISSRet: type: string description: Valor total retenção ISS minimum: 0.00 maximum: 9999999999999.99 recProd: description: Record de dados dos itens do documento type: object required: – proSer – cProd – xProd – ncm – cfop – uCom – qCom – vUnCom – vProd – uTrib – qTrib – vUnTrib properties: proSer: type: string allOf: – #/definitions/enumProSer description: Produto ou serviço aplNop: type: string allOf: – #/definitions/enumAplNop description: Aplicação da natureza da operação cProd: type: string description: Código do produto ou serviço xProd: type: string description: Descrição do produto ou serviço ncm: type: string description: Código NCM cest: type: string description: Código CEST cBenef: type: string description: Código de Benefício Fiscal na UF extipi: type: integer format: int64 description: EX_TIPI cfop: type: string description: Código Fiscal de Operações e Prestações uCom: type: string description: Unidade Comercial qCom: type: number format: double description: Quantidade Comercial minimum: 0.00 maximum: 99999999999.9999 vUnCom: type: string description: Valor Unitário de Comercialização minimum: 0.00 maximum: 99999999999.9999999999 vProd: type: string description: Valor Total Bruto dos Produtos ou serviços minimum: 0.00 maximum: 9999999999999.99 uTrib: type: string description: Unidade tributável qTrib: type: number format: double description: Quantidade tributável minimum: 0.00 maximum: 99999999999.9999 vUnTrib: type: string description: Valor Unitário de tributação minimum: 0.00 maximum: 99999999999.9999999999 vFrete: type: string description: Valor Total do Frete minimum: 0.00 maximum: 9999999999999.99 vSeg: type: string description: Valor Total do Seguro minimum: 0.00 maximum: 9999999999999.99 vDesc: type: string description: Valor do Desconto minimum: 0.00 maximum: 9999999999999.99 vOutro: type: string description: Outras despesas acessórias minimum: 0.00 maximum: 9999999999999.99 qOri: type: number format: double description: Quantidade original minimum: 0.00 maximum: 99999999999.9999 imposto: type: array items: type: object allOf: – #/definitions/recImposto description: Dados dos impostos do item gruIst: type: boolean description: Gerar grupo de repasse de ICMS ST na NF-e mesmo com CST 60 default: false codFim: type: string maxLength: 10 description: Código fiscal municipal do serviço serImp: type: string description: Tipo de serviço baseado LC116/2003 di: type: array items: type: object allOf: – #/definitions/recDI description: Declaração de Importação vTotTrib: type: string description: Valor aproximado de tributos federais, estaduais e municipais minimum: 0.00 maximum: 9999999999999.99 nFCI: type: string maxLength: 36 description: Número de controle da FCI – Ficha de Conte?do de Importação rastro: type: array items: type: object allOf: – #/definitions/recRastro description: Detalhamento de produto sujeito a rastreabilidade xPed: type: string description: Número do pedido nItemPed: type: string description: Item do pedido detExport: type: array items: type: object allOf: – #/definitions/recDetExport description: Informações de exportação infAdProd: type: string description: Informações adicionais do produto codBar: type: string maxLength: 14 description: Código de barras codBa2: type: string maxLength: 30 description: Código barras livre codGtn: type: string maxLength: 14 description: Gtin uni. trib comb: type: object allOf: – #/definitions/recComb description: Detalhamento específico de combustíveis cBarraTrib: type: string maxLength: 30 description: Código de barras da unidade tributável recImposto: description: Record de dados dos impostos do item type: object required: – tipImp properties: tipImp: type: string allOf: – #/definitions/enumTipImpDoc description: Tipo do imposto orig: type: string allOf: – #/definitions/enumOriMer description: Origem da mercadoria cst: type: string description: Situação tributária basImp: type: string description: Valor Base minimum: 0.00 maximum: 9999999999999.99 default: 0 aliImp: type: number format: double description: Alíquota do imposto minimum: 0.00 maximum: 99999999999.9999 vlrImp: type: string description: Valor Base minimum: 0.00 maximum: 9999999999999.99 default: 0 perRed: type: string description: Percentual redução minimum: 0.00 maximum: 9999999999999.99 default: 0 perMva: type: string description: Percentual MVA minimum: 0.00 maximum: 9999999999999.99 default: 0 motDes: type: string allOf: – #/definitions/enumMotDes description: Motivo desoneração codEnq: type: integer format: int64 description: Enquadramento de IPI default: 0 aliDes: type: number format: double description: Alíquota de ICMS interestadual da UF de destino minimum: 0.00 maximum: 99999999999.9999 default: 0.00 vlrOui: type: string description: Valor outros impostos minimum: 0.00 maximum: 9999999999999.99 default: 0.00 exiIss: type: string allOf: – #/definitions/enumExiIss description: Exige imposto de serviço – ISS tipDif: type: string allOf: – #/definitions/tipoDiferimento description: Tipo de diferimento vlrRec: type: string description: Valor recolhido pelo substituto minimum: 0.00 maximum: 99999999999.9999 supCon: type: number format: double description: Suportado consumidor final minimum: 0.00 maximum: 99999999999.9999 vlrRet: type: string description: Valor Icms ST retido minimum: 0.00 maximum: 99999999999.9999 indDeduzDeson: type: boolean description: Desconta ICMS desonerado do valor líquido default: false recRastro: description: Record de detalhamento de produto sujeito a rastreabilidade type: object required: – nLote – qLote – dFab – dVal properties: nLote: type: string description: Número do Lote do produto qLote: type: number format: double description: Quantidade de produto no Lote minimum: 0.00 maximum: 99999999.999 dFab: type: string format: date description: Data de Fabricação/Produção dVal: type: string format: date description: Data de validade recDetExport: description: Detalhe da exportação type: object properties: nDraw: type: integer format: int64 description: Número do ato concessário de Drawback maximum: 99999999999 exportInd: type: object allOf: – #/definitions/recExportInd description: Exportação indireta recComb: description: Detalhamento específico de combustíveis type: object properties: cProdANP: type: string description: Código de produto da ANP descANP: type: string description: Descrição do produto conforme ANP ufCons: type: string description: Sigla da UF de consumo recRetTrib: description: Record do Grupo Retençães de Tributos type: object properties: vRetPIS: type: string description: Valor Retido de PIS minimum: 0.00 maximum: 9999999999999.99 vRetCOFINS: type: string description: Valor Retido de COFINS minimum: 0.00 maximum: 9999999999999.99 vRetCSLL: type: string description: Valor Retido de CSLL minimum: 0.00 maximum: 9999999999999.99 vBCIRRF: type: string description: Base de Cálculo do IRRF minimum: 0.00 maximum: 9999999999999.99 vIRRF: type: string description: Valor Retido do IRRF minimum: 0.00 maximum: 9999999999999.99 vBCRetPrev: type: string description: Base de Cálculo da Retenção da Previdência Social minimum: 0.00 maximum: 9999999999999.99 vRetPrev: type: string description: Valor da Retenção da Previdência Social minimum: 0.00 maximum: 9999999999999.99 recExportInd: description: Dados de exportação indireta type: object required: – nRE – chNFe – qExport properties: nRE: type: string maxLength: 12 description: Número do Registro de Exportação chNFe: type: string maxLength: 44 description: Chave de Acesso da NF-e recebida para exportação qExport: type: number format: double description: Quantidade do item realmente exportado minimum: 0.00 maximum: 99999999999.9999 recDI: description: Record de Declaração de Importação type: object required: – nDI – dDI – xLocDesemb – ufDesemb – dDesemb – tpViaTransp – tpIntermedio – cExportador – adi properties: nDI: type: string description: Número do Documento de Importação dDI: type: string format: date description: Data de Registro do documento xLocDesemb: type: string maxLength: 60 description: Local de desembara?o ufDesemb: type: string maxLength: 2 description: Sigla da UF onde ocorreu o Desembara?o Aduaneiro dDesemb: type: string format: date description: Data do Desembara?o Aduaneiro tpViaTransp: type: string allOf: – #/definitions/enumTipVii description: Via de transporte internacional informada na Declaração de Importação (DI) vAFRMM: type: string description: Valor da AFRMM – Adicional ao Frete para Renovação da Marinha Mercante minimum: 0.00 maximum: 9999999999999.99 tpIntermedio: type: string allOf: – #/definitions/enumTipItd description: Forma de importação quanto a intermediação cpf: type: string maxLength: 11 description: CNPJ do adquirente ou do encomendante cnpj: type: string maxLength: 14 description: CNPJ do adquirente ou do encomendante ufTerceiro: type: string maxLength: 2 description: Sigla da UF do adquirente ou do encomendante cExportador: type: string maxLength: 60 description: Código do Exportador adi: type: array items: type: object allOf: – #/definitions/recAdi minimum: 1 description: Adições recAdi: description: Record de Adições type: object required: – nAdicao – nSeqAdic – cFabricante properties: nAdicao: type: integer format: int64 description: Numero da Adição maximum: 999 nSeqAdic: type: integer format: int64 description: Numero sequencial do item dentro da Adição maximum: 999 cFabricante: type: string maxLength: 60 description: Código do fabricante estrangeiro vDescDI: type: string description: Valor do desconto do item da DI V Adição minimum: 0.00 maximum: 9999999999999.99 nDraw: type: integer format: int64 description: Número do ato concessário de Drawback maximum: 99999999999 recEntrega: description: Record de dados do endereço de entrega type: object required: – cnpjCpf – tipPes – endereco properties: cnpjCpf: type: string description: CNPJ/CPF tipMer: type: string allOf: – #/definitions/enumTipMer description: Tipo de mercado tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo da pessoa xNome: type: string description: Razão Social ou Nome do Recebedor endereco: type: object allOf: – #/definitions/recEndereco description: Endereço da entrega email: type: string description: email ie: type: string description: Inscrição Estadual do Estabelecimento Recebedor recEmit: description: Record de dados do emitente (filial) type: object required: – crt properties: cnae: type: integer format: int64 description: CNAE fiscal iest: type: string description: IE do Substituto Tribut?rio crt: type: string allOf: – #/definitions/enumCodCrt description: Código de Regime Tribut?rio recDest: description: Record de dados do destinatário (cliente) type: object required: – tipPes properties: cnpjCpf: type: string description: CNPJ/CPF idEstrangeiro: type: string description: Identificação do destinatário no caso de comprador estrangeiro tipMer: type: string allOf: – #/definitions/enumTipMer description: Tipo de mercado tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo da pessoa xNome: type: string description: Razão Social ou nome do destinatário enderDest: type: object allOf: – #/definitions/recEndereco description: Endereço do Destinatário isTaxPayer: type: boolean description: Indicativo se o cliente é contribuinte ie: type: string description: Inscrição Estadual do Destinatário isuf: type: string description: Inscrição na SUFRAMA im: type: string description: Inscrição Municipal do Tomador do serviço email: type: string description: email recEndereco: description: Record de dados de endereço type: object required: – xLgr – nro – xBairro – cMun – xMun – uf properties: xLgr: type: string description: Logradouro nro: type: string description: Número xCpl: type: string description: Complemento xBairro: type: string description: Bairro cMun: type: integer format: int64 description: Código do município maximum: 9999999 xMun: type: string description: Nome do município uf: type: string description: Sigla da UF cep: type: integer format: int64 description: Código do CEP maximum: 99999999 cPais: type: string description: Código do País xPais: type: string description: Nome do País fone: type: string description: Telefone recCancelInvoice: description: Record de requisição de cancelamento de nota fiscal type: object required: – serieId – branchId – invoiceNumber – cancelingReason – externalId properties: serieId: type: string description: Id da série da nota fiscal branchId: type: string description: Id filial invoiceNumber: type: integer format: int64 description: Número da nota fiscal cancelingReason: type: string description: Justificativa do cancelamento externalId: type: string description: ID de controle externo recCancelServiceInvoice: description: Record de requisição de cancelamento de nota fiscal de serviço type: object required: – serieId – branchId – invoiceServiceNumber – cancelingReason – externalId – tipMer properties: serieId: type: string description: Id da série da nota fiscal de serviço branchId: type: string description: Id filial invoiceServiceNumber: type: integer format: int64 description: Número da nota fiscal de serviço cancelingReason: type: string description: Justificativa do cancelamento externalId: type: string description: ID de controle externo numRps: type: integer format: int64 description: Número RPS minimum: 0 maximum: 999999999999999 tipMer: type: string allOf: – #/definitions/enumTipMer description: Indicativo do fornecedor recInvoiceIssueError: description: Record de erro da autorização da nota fiscal type: object required: – code – errorDescription properties: code: type: string description: Código do erro errorDescription: type: string description: Descrição do erro recRefNF: description: Record de erro da autorização da nota fiscal type: object required: – cUF – AAMM – CNPJ – mod – serie – nNF properties: cUF: type: string description: Código da UF do emitente AAMM: type: string description: Ano e Mês de emissão da NF-e CNPJ: type: string description: CNPJ do emitente mod: type: string description: Modelo do Documento Fiscal serie: type: string description: série do Documento Fiscal nNF: type: string description: Número do Documento Fiscal recRefNFP: description: Record de Informações da NF de produtor rural referenciada type: object required: – cUF – AAMM – IE – mod – serie – nNF properties: cUF: type: string description: Código da UF do emitente AAMM: type: string description: Ano e Mês de emissão da NF-e CNPJ: type: string description: CNPJ do emitente CPF: type: string description: CPF do emitente IE: type: string description: IE do emitente mod: type: string description: Modelo do Documento Fiscal serie: type: string description: série do Documento Fiscal nNF: type: string description: Número do Documento Fiscal refCTe: type: string description: Chave de acesso do CT-e referenciada recGNRE: description: Record da geração GNRE type: object required: – ufFavorecida – contribuinteEmitente – itemGNRE properties: ufFavorecida: type: string maxLength: 2 description: Sigla da UF modeloDocumento: type: string maxLength: 3 description: Modelo de documento contribuinteEmitente: type: object allOf: – #/definitions/recContribuinteEmitente description: Informações do contribuinte emitente itemGNRE: type: object allOf: – #/definitions/recItemGNRE description: Itens da GNRE recContribuinteEmitente: description: Record de informações do contribuinte emitente type: object required: – identificacao properties: identificacao: type: object allOf: – #/definitions/recIdentificacaoContribuinte description: Identificação do contribuinte emitente recItemGNRE: description: Record dos itens da GNRE type: object required: – receitaGnre – documentoOrigem – numeroDocumento – referencia – dataVencimento – destinatario – valor – tipoImposto properties: receitaGnre: type: string description: Código de receita detalhamentoReceita: type: string description: Detalhamento da receita documentoOrigem: type: string description: Chave do documento Fiscal numeroDocumento: type: string description: Número Documento Origem produtoGnre: type: string description: Código de-para Produto GNRE referencia: type: object allOf: – #/definitions/recPeriodoReferencia description: Período do documento Fiscal dataVencimento: type: string format: date description: Data vencimento destinatario: type: object allOf: – #/definitions/recContribuinteDestinatario description: Destinatário valor: type: string description: Valor imposto tipoImposto: type: string allOf: – #/definitions/enumImpostoGuia description: Tipo de Imposto Guia recPeriodoReferencia: description: Referencia GNRE type: object required: – mes – ano properties: mes: type: string maxLength: 2 description: Mês ano: type: string maxLength: 4 description: Ano recVehicleOwner: description: Record para Proprietário do veículo type: object required: – rntrc – name – ownerType properties: cpf: type: string maxLength: 11 description: CPF cnpj: type: string maxLength: 14 description: CNPJ rntrc: type: string maxLength: 8 description: RNTRC name: type: string maxLength: 60 description: Nome stateRegistration: type: string description: Inscrição Estadual stateId: type: string description: Estado ownerType: type: string allOf: – #/definitions/enumTipPrt description: Tipo Proprietário recDriver: description: Record para Condutor/Motorista type: object required: – name properties: name: type: string maxLength: 60 description: Nome cpf: type: string maxLength: 11 description: CPF recVehicle: description: Record para Veiculo: recVehicle type: object required: – plate – tareKg – bodyType – stateId properties: plate: type: string maxLength: 7 description: Placa do veículo renavam: type: string maxLength: 11 description: RENAVAM tareKg: type: integer format: int64 description: Tara em KG capacityKg: type: integer format: int64 description: Capacidade em KG capacityM3: type: integer format: int64 description: Capacidade em M3 owner: type: object allOf: – #/definitions/recVehicleOwner description: Proprietário do veículo wheelsetType: type: string allOf: – #/definitions/enumTipRod description: Tipo do Rodado bodyType: type: string allOf: – #/definitions/enumTipCrr description: Tipo de Carroceria stateId: type: string description: Estado recInsured: description: Record para Seguro type: object required: – responsibleInsurance – nameInsuranceCompany – cnpjInsuranceCompany – apolicyNumber properties: responsibleInsurance: type: string allOf: – #/definitions/enumRespSegTypeMdfe description: Responsável pelo seguro cnpjResponsibleInsurance: type: string maxLength: 14 description: CNPJ do responsável pelo seguro cpfResponsibleInsurance: type: string maxLength: 11 description: CPF do responsável pelo seguro nameInsuranceCompany: type: string maxLength: 30 description: Nome da Seguradora cnpjInsuranceCompany: type: string maxLength: 14 description: CNPJ da Seguradora apolicyNumber: type: string maxLength: 20 description: Número da Apólice numberAnnotationList: type: array items: type: string description: Lista de Número da Averbação recCargoTotals: description: Record para totalizadores da carga type: object required: – codeMeasureUnit – totalValue – totalWeight properties: quantityCte: type: integer format: int64 description: Quantidade de CT-e quantityNfe: type: integer format: int64 description: Quantidade de NF-e quantityMdfe: type: integer format: int64 description: Quantidade de MDF-e codeMeasureUnit: type: string description: Quantidade de MDF-e totalValue: type: number format: double description: Valor total da carga/mercadorias transportadas totalWeight: type: number format: double description: Peso Bruto Total da Carga/Mercadorias transportadas recAddDocumentLoading: description: Record para Descarregamento type: object required: – cityId – nfeKey properties: cityId: type: string description: Id do Município nfeKey: type: string description: Chave da NFe recLoadingInfo: description: Record para Descarregamento type: object properties: cityId: type: string description: Id do Município nfeKey: type: array items: type: string description: Chave da NFe recRoadModality: description: Record para Modalidade Rodoviaria type: object required: – vehicle – driverList properties: vehicle: type: object allOf: – #/definitions/recVehicle description: Veículo tração driverList: type: array items: type: object allOf: – #/definitions/recDriver minimum: 1 description: Lista de condutores trailerList: type: array items: type: object allOf: – #/definitions/recVehicle description: Lista de reboques rntrc: type: string maxLength: 8 description: RNTRC ciotList: type: array items: type: object allOf: – #/definitions/recCiot description: Lista de CIOT tollList: type: array items: type: object allOf: – #/definitions/recToll description: Lista de vale pedágio contractorList: type: array items: type: object allOf: – #/definitions/recContractor description: Lista de contratantes vehicleCombination: type: string allOf: – #/definitions/enumVehicleCombinationCategory description: Categoria de Combinação Veicular recCiot: description: Record do CIOT type: object required: – ciot properties: ciot: type: string maxLength: 12 description: Código Identificador da Operação de Transporte (CIOT) cpf: type: string maxLength: 11 description: CPF cnpj: type: string maxLength: 14 description: CNPJ recToll: description: Record do vale pedágio type: object required: – supplierCnpj – tollValue properties: supplierCnpj: type: string maxLength: 14 description: CNPJ da empresa fornecedora do Vale pedágio paymentCpf: type: string maxLength: 11 description: CPF do responsável pelo pagamento do Vale Pedágio paymentCnpj: type: string maxLength: 14 description: CNPJ do responsável pelo pagamento do Vale Pedágio voucherNumber: type: string maxLength: 20 description: Número do comprovante de compra tollValue: type: string description: Valor do Vale pedágio tollCardType: type: string allOf: – #/definitions/enumTollCardType description: Tipo do Vale Pedágio recContractor: description: Record do contratante type: object required: – tradeName properties: tradeName: type: string maxLength: 60 description: Razão social ou nome do contratante cpf: type: string maxLength: 11 description: CPF cnpj: type: string maxLength: 14 description: CNPJ recRouteInfo: description: Record para percurso type: object required: – stateId properties: stateId: type: string description: Id do estado do percurso recBoardingInfo: description: Record para carregamento type: object required: – cityId properties: cityId: type: string description: Id do município do carregamento recCargoManifest: description: Record para o Manifesto MDF-e type: object required: – externalId – serieId – branchId – issuerType – number – modalTransportType – emissionType – issueDate – boardingStateId – loadingStateId – roadModality – cargoTotals properties: externalId: type: string description: Id da nota fiscal serieId: type: string description: Id da série da nota fiscal branchId: type: string description: Id da filial issuerType: type: string allOf: – #/definitions/enumEmitTypeMdfe description: Tipo do emitente shippingCompanyType: type: string allOf: – #/definitions/enumTpoTra description: Tipo do transportador number: type: integer format: int64 description: Número do manifesto modalTransportType: type: string allOf: – #/definitions/enumTranspTypeMdfe description: Modalidade de transporte emissionType: type: string allOf: – #/definitions/enumEmissionTypeMdfe description: Tipo da emissão issueDate: type: string format: date-time description: Data e hora da emissão boardingStateId: type: string description: Estado inicial de carregamento: loadingStateId: type: string description: Estado final de descarregamento boardingInfoList: type: array items: type: object allOf: – #/definitions/recBoardingInfo description: Lista de informação do carregamento routeInfoList: type: array items: type: object allOf: – #/definitions/recRouteInfo description: Lista de informação do percurso roadModality: type: object allOf: – #/definitions/recRoadModality description: Informações modalidade rodoviária loadingInfoList: type: array items: type: object allOf: – #/definitions/recLoadingInfo description: Lista de municipios de descarregamento insuredList: type: array items: type: object allOf: – #/definitions/recInsured description: Lista de seguros da carga cargoTotals: type: object allOf: – #/definitions/recCargoTotals description: Totalizadores da carga transportada e seus documentos cnpjCpfDownloadXml: type: array items: type: string description: CNPJ ou CPF autorizados a fazer download do xml inclusionDocumentsLater: type: boolean description: Indicador de MDF-e com inclusão da carga posterior default: false predominantProduct: type: object allOf: – #/definitions/recPredominantProduct description: Informações produto predominante recPredominantProduct: description: Record do produto predominante type: object required: – loadType – description properties: loadType: type: string allOf: – #/definitions/enumLoadType description: Tipo da carga description: type: string maxLength: 120 description: Descrição do produto predominante barCode: type: string maxLength: 14 description: Código de barras ncm: type: string maxLength: 8 description: Código NCM lotLoad: type: object allOf: – #/definitions/recLotLoad description: Informações da carga lotação recLotLoad: description: Record da carga lotação type: object properties: loadCep: type: string maxLength: 8 description: CEP onde foi carregado o MDF-e loadLatitude: type: number format: double description: Latitude do ponto geográfico onde foi carregado o MDF-e minimum: -99.999999 maximum: 99.999999 loadLongitude: type: number format: double description: Longitude do ponto geográfico onde foi carregado o MDF-e minimum: -999.999999 maximum: 999.999999 unloadCep: type: string maxLength: 8 description: CEP onde foi descarregado o MDF-e unloadLatitude: type: number format: double description: Latitude do ponto geográfico onde foi descarregado o MDF-e minimum: -99.999999 maximum: 99.999999 unloadLongitude: type: number format: double description: Longitude do ponto geográfico onde foi descarregado o MDF-e minimum: -999.999999 maximum: 999.999999 recClosingCargoManifest: description: Record para Encerramento do MDF-e allOf: – #/definitions/recEventCargoManifest – type: object required: – protocolNumber – closingDate – stateId properties: protocolNumber: type: string description: Numero do protocolo de autorizao do MDFe closingDate: type: string format: date description: Data de encerramento stateId: type: string description: Id do Estado do Encerramento cityId: type: string description: Id do Municipio do Encerramento recCancelCargoManifest: description: Record para Cancelamento do MDF-e allOf: – #/definitions/recEventCargoManifest – type: object required: – protocolNumber – cancelingReason properties: protocolNumber: type: string description: Numero do protocolo de autorizao do MDFe cancelingReason: type: string description: Justificativa do cancelamento recAddDriverCargoManifest: description: Record para Adicionar Condutor na MDF-e allOf: – #/definitions/recEventCargoManifest – type: object required: – sequence – driver properties: sequence: type: integer format: int64 description: Numero da sequencia driver: type: object allOf: – #/definitions/recDriver description: Condutor/Motorista recAddDocumentCargoManifest: description: Record para Adicionar Documento na MDF-e allOf: – #/definitions/recEventCargoManifest – type: object required: – protocolNumber – sequence – cityId – loadingInfoList properties: protocolNumber: type: string description: Numero do protocolo de autorizao do MDFe sequence: type: integer format: int64 description: Numero da sequencia cityId: type: string description: Id do Municipio do Encerramento loadingInfoList: type: array items: type: object allOf: – #/definitions/recAddDocumentLoading minimum: 1 description: Lista de Descarregamentos recEventCargoManifest: description: discriminator: _discriminator type: object required: – externalId – branchId – serieId – manifestNumber – documentKey – eventDateTime – _discriminator properties: externalId: type: string description: Id do Evento do MDF-e branchId: type: string description: Id da filial serieId: type: string description: Id da serie da MDF-e manifestNumber: type: integer format: int64 description: Numero do MDF-e documentKey: type: string description: Chave do documento eletronico eventDateTime: type: string format: date-time description: Data do evento _discriminator: type: string description: recContribuinteDestinatario: description: Record do contribuinte type: object required: – identificacao properties: identificacao: type: object allOf: – #/definitions/recIdentificacaoContribuinte description: Identificação do contribuinte Destinatário recIdentificacaoContribuinte: description: Record de identifcação do contribuinte type: object required: – razaoSocial – endereco – municipio – uf properties: cpf: type: string description: CPF do contribuinte cnpj: type: string description: CNPJ do contribuinte ie: type: string description: Inscrição estadual do contribuinte razaoSocial: type: string description: Razão social do contribuinte endereco: type: string description: Endereço do contribuinte municipio: type: string description: Município do contribuinte uf: type: string description: UF do contribuinte recDisableInvoice: description: Record de requisição de inutilização de nota fiscal type: object required: – serieId – branchId – operationType – initialNumber – finalNumber – disableReason – externalId properties: serieId: type: string description: Id da série da nota fiscal branchId: type: string description: Id filial operationType: type: string allOf: – #/definitions/enumTipOpe description: Tipo da operação initialNumber: type: integer format: int64 description: Número inicial finalNumber: type: integer format: int64 description: Número final disableReason: type: string description: Justificativa da inutilização externalId: type: string description: Id da série da nota fiscal recIssueServiceInvoice: description: Record de requisição de emissão de nota fiscal de serviços type: object required: – rps – externalId properties: rps: type: object allOf: – #/definitions/recRPS description: RPS externalId: type: string description: Identificador externo recRPS: description: Record da RPS type: object required: – rpsInformation – serviceInformation – customerInformation – branchInformation – installmentsInformation properties: rpsInformation: type: object allOf: – #/definitions/recRpsInformation description: Informações da RPS serviceInformation: type: array items: type: object allOf: – #/definitions/recRpsServiceInformation minimum: 1 description: Informações do serviço customerInformation: type: object allOf: – #/definitions/recRpsCustomerInformation description: Informações do cliente (tomador) branchInformation: type: object allOf: – #/definitions/recRpsBranchInformation description: Informações da filial (prestador) installmentsInformation: type: array items: type: object allOf: – #/definitions/recInstallmentsInformation minimum: 1 description: Informações das parcelas recRpsInformation: description: Record de Informações da RPS type: object required: – rpsNumber – branchId – seriesId – operationType – issueDate – serviceOperationNature – culturalPromoter – municipalCode properties: rpsNumber: type: integer format: int64 description: Número da RPS branchId: type: string description: Id da filial da RPS seriesId: type: string description: Id da série da RPS operationType: type: string allOf: – #/definitions/enumTipOpe description: Tipo de operação issueDate: type: string format: date-time description: Data da Emissão serviceOperationNature: type: string allOf: – #/definitions/enumNatOps description: Natureza da operação especialTaxationRegime: type: string allOf: – #/definitions/enumRegEst description: Regime especial de tributação simpleNationalTaxRegime: type: string allOf: – #/definitions/enumCodCrt description: Optante do Simples Nacional culturalPromoter: type: boolean description: Indicativo de incentivador cultural municipalCode: type: integer format: int64 description: Código da cidade para recolhimento do ISS (Tabela RAIS) rpsNote: type: string description: Observação da RPS rpsNumberReplaced: type: integer format: int64 description: RPS Substituido recRpsServiceInformation: description: Informações de serviço da RPS type: object required: – serviceItemListCode – serviceDiscrimination – serviceCode – grossValue – netValue – itemPrice – discountValue – invoicedQuantity – measureUnit – deductionPercentual – deductionValue – issBasisValue – issPercentual – issValue – issWithheldBasisValue – issWithheldPercentual – issWithheldValue – inssBasisValue – inssPercentual – inssValue – irrfBasisValue – irrfPercentual – irrfValue – cofinsWithheldBasisValue – cofinsWithheldPercentual – cofinsWithheldValue – csllWithheldBasisValue – csllWithheldPercentual – csllWithheldValue – pisWithheldBasisValue – pisWithheldPercentual – pisWithheldValue properties: serviceItemListCode: type: string description: Código do tipo de serviço da lei complementar 116 2003 municipalTaxationCode: type: string description: Código de tributação NFS-e (e140ins.codigo_tributacao_nfse) serviceDiscrimination: type: string description: Discriminação do serviço para nota fiscal serviceCode: type: string description: Código do serviço grossValue: type: string description: Valor bruto netValue: type: string description: Valor l?quido itemPrice: type: string description: Valor unit?rio discountValue: type: string description: Valor de desconto invoicedQuantity: type: number format: double description: Quantidade measureUnit: type: string description: Unidade de medida itemNote: type: string description: Observação deductionPercentual: type: string description: Percentual de dedução deductionValue: type: string description: Valor de dedução collectionTaxType: type: string allOf: – #/definitions/enumAplLiq description: Tipo de aplicação do valor do imposto issBasisValue: type: string description: Valor base do ISS issPercentual: type: number format: double description: Percentual do ISS issValue: type: string description: Valor do ISS issCstCode: type: string description: Código da situação tributária do ISS issWithheldBasisValue: type: string description: Valor base do ISS retido issWithheldPercentual: type: number format: double description: Percentual do ISS issWithheldValue: type: string description: Valor do ISS retido issWithheldCstCode: type: string description: Código da situação tributária do ISS Retido inssBasisValue: type: string description: Valor base do INSS inssPercentual: type: number format: double description: Percentual do INSS inssValue: type: string description: Valor do INSS irrfBasisValue: type: string description: Valor base do IRRF irrfPercentual: type: number format: double description: Percentual do IRRF irrfValue: type: string description: Valor do IRRF cofinsWithheldBasisValue: type: string description: Valor base do COFINS retido cofinsWithheldPercentual: type: number format: double description: Percentual do COFINS retido cofinsWithheldValue: type: string description: Valor do COFIS retido csllWithheldBasisValue: type: string description: Valor base da CSLL retida csllWithheldPercentual: type: number format: double description: Percentual da CSLL retida csllWithheldValue: type: string description: Valor da CSLL retida pisWithheldBasisValue: type: string description: Valor base do PIS retido pisWithheldPercentual: type: number format: double description: Percentual do PIS retido pisWithheldValue: type: string description: Valor do PIS retido recRpsCustomerInformation: description: Informações do cliente da RPS (tomador do serviço) type: object required: – name – address – marketType – personType properties: name: type: string description: Razão social address: type: object allOf: – #/definitions/recAddress description: Endereço phoneNumber: type: string description: Número do telefone marketType: type: string allOf: – #/definitions/enumTipMer description: Tipo de mercado personType: type: string allOf: – #/definitions/enumJurFis description: Tipo da pessoa emailAddress: type: string description: Email stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal do tomador cnpCpf: type: string description: CPF ou CNPJ do tomador taxIdentificationNumber: type: string description: Número Identificação Fiscal recRpsBranchInformation: description: Informações da filial da RPS (prestador do serviço) type: object required: – name – taxNumber – municipalRegistration – address – municipalCode properties: name: type: string description: Razão social taxNumber: type: string description: CPF CNPF da filial municipalRegistration: type: string description: Inscrição municipal do emissor cnaeCode: type: integer format: int64 description: Código do CNAE address: type: object allOf: – #/definitions/recAddress description: Endereço municipalCode: type: integer format: int64 description: Código do municipio emailAddress: type: string description: Email phoneNumber: type: string description: Número do telefone recInstallmentsInformation: description: Informações das parcelas type: object required: – billNumber – installmentDueDate – installmentValue – installmentIndex – paymentMethodType properties: billNumber: type: string description: Número do título installmentDueDate: type: string format: date description: Data de vencimento da parcela installmentValue: type: string description: Valor da parcela minimum: 0.00 maximum: 9999999999999.99 installmentIndex: type: integer format: int64 description: Sequência paymentMethodType: type: string allOf: – #/definitions/enumTipFpg description: Indicativo da forma de pagamento recAddress: description: Record de endereço type: object required: – municipalCode – state – countryCode properties: address: type: string description: Endereço number: type: string description: Número do endereço complement: type: string description: Complemento postalCode: type: integer format: int64 description: Cep do endereço neighborhood: type: string description: Bairro city: type: string description: Nome do município municipalCode: type: integer format: int64 description: Código do município state: type: string description: Estado countryCode: type: string description: Código do País countryName: type: string description: Nome do País situacaoDocumentoEdocs: description: Modelo para serialização da situação de documentos eletrônicos do eDocs. type: object required: – documento – situacao – sucesso – tipoAmbiente – tipoDocumento properties: cancelamento: type: object allOf: – #/definitions/situacaoCancelamentoEdocs description: Situação do cancelamento associado ao documento codigo: type: integer format: int64 description: Código, em casos de erro ou rejeição. Esse campo pode ter tanto o código de rejeição da entidade autorizadora do documento quanto um código gerado pelo sistema codigoBarras: type: string description: Valor do código de barras. Somente usado na consulta de GNRE. codigoMensagemAutorizador: type: integer format: int64 description: Código da mensagem retornada pelo autorizador do documento. Não é relacionado a autorização do documento, mas sim uma mensagem que o autorizador deseja passar para o emitente dataAutorizacao: type: string description: Data e hora de autorização do documento. Se a entidade autorizadora retornar um fuso horário ele também será retornado nesse campo dataConsulta: type: string format: date-time description: Data da consulta de situação do documento dataRecepcao: type: string description: Data e hora da Recepção pelo SEFAZ detalhesCritica: type: array items: type: object allOf: – #/definitions/detalhesCriticaEdocs description: Quando rejeitado retorna detalhes da critica documento: type: object allOf: – #/definitions/identificacaoDocumentoEdocs description: Dados de identificação do documento eventos: type: array items: type: object allOf: – #/definitions/situacaoEventoEdocs description: Situação dos eventos associados ao documento gnres: type: array items: type: object allOf: – #/definitions/situacaoDocumentoEdocs description: Situação das GNREs associadas ao documento identificador: type: string description: Identificador do documento quando for informado na requisição localizador: type: string description: Localizador do documento mensagem: type: string description: Mensagem em casos de erro ou rejeição mensagemAutorizador: type: string description: Mensagem retornada pelo autorizador do documento protocoloAutorizacao: type: string description: Protocolo de autorização de uso do documento situacao: type: integer format: int64 description: Situação do documento sucesso: type: boolean description: Indica se a requisição foi finalizada com sucesso tipoAmbiente: type: integer format: int64 description: Tipo de ambiente que o documento foi emitido tipoDocumento: type: integer format: int64 description: Tipo de documento xmlAutorizado: type: string description: XML autorizado na Sefaz em Base64 auditoria: type: object allOf: – #/definitions/auditoriaEdocs description: Dados da auditoria da NF-e recebida tipoProcessamento: type: integer format: int64 description: Indica se o documento é de emissão ou recebimento situacaoCancelamentoEdocs: description: Situação do cancelamento associado ao documento do eDocs type: object properties: situacao: type: integer format: int64 description: Situação do documento protocoloAutorizacao: type: string description: Número do protocolo de autorização se autorizado dataAutorizacao: type: string format: date-time description: Data e hora de autorização se autorizado detalhesCriticaEdocs: description: Representa o detalhamento de uma critica ou rejeição do eDocs type: object properties: codigo: type: string description: Código do detalhamento mensagem: type: string description: Descrição do detalhamento localizacao: type: string description: Localização dentro do XML do problema ocorrido tipo: type: integer format: int64 description: Indica se é um erro ou advertência identificacaoDocumentoEdocs: description: Dados de identificação de um documento eletrônico do eDocs type: object required: – cnpjEmissor properties: chaveDocumento: type: string description: Chave ou ID do documento chaveDocumentoContigencia: type: string description: Chave do documento na entidade autorizadora, caso a chave seja alterada devido a contingência retorna nova chave serie: type: string description: Série fiscal do documento numero: type: integer format: int64 description: Número do documento numeroFinal: type: integer format: int64 description: Número de término da faixa de inutilização numeroNfse: type: integer format: int64 description: Como o campo `Numero` retornará o número do RPS para NFS-e cnpjEmissor: type: integer format: int64 description: CNPJ do emissor do documento digestValue: type: string description: DigestValue gerado somente para NF-e e NFC-e quando disponível identificadorGerador: type: string description: Identificador do software gerador do XML inscricaoMunicipal: type: string description: Inscrição Municipal codigoSiafi: type: string description: Código SIAFI situacaoEventoEdocs: description: Situação de eventos associados a um documento do eDocs type: object properties: tipoEvento: type: string description: Tipo do evento sequencia: type: integer format: int64 description: Indica o número sequencial do evento situacao: type: integer format: int64 description: Situação do evento protocoloAutorizacao: type: string description: Número do protocolo de autorização se autorizado dataAutorizacao: type: string description: Data e hora de autorização se autorizado xmlAutorizado: type: string description: XML autorizado na Sefaz em Base64 codigo: type: integer format: int64 description: Código da rejeição quando existir mensagem: type: string description: Mensagem da rejeição quando existir itens: type: array items: type: object allOf: – #/definitions/itemEventoEdocs description: Itens do evento detalhesCritica: type: array items: type: object allOf: – #/definitions/detalhesCriticaEdocs description: Quando rejeitado retorna detalhes da crítica dataProcessamento: type: string description: Data de processamento do evento itemEventoEdocs: description: Itens do evento do documento no eDocs type: object properties: numeroItem: type: integer format: int64 description: Número do item situacao: type: integer format: int64 description: Situação do item justificativa: type: string description: Justificativa da situação do item auditoriaEdocs: description: Representa os dados da auditoria da nota do eDocs type: object properties: situacao: type: integer format: int64 description: Situação da auditoria mensagem: type: string description: Mensagem da auditoria xmlInvoice: description: type: object required: – serie – branchId – invoiceNumber – taxNumber – fileXML – documentKey – documentType – issueDate properties: serie: type: string description: Id da série da nota fiscal branchId: type: string description: Id filial invoiceNumber: type: integer format: int64 description: Número da nota fiscal taxNumber: type: string description: CPF CNPJ da filial fileXML: type: string description: Arquivo XML documentKey: type: string description: Chave documentType: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do documento issueDate: type: string format: date-time description: Data emissão e070emp: description: Cadastros – Empresas type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa e006pai: type: object allOf: – #/definitions/e006pai description: Pais da empresa 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: e070fil: description: Cadastros – Filiais type: object required: – tipPes 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: 99999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Nome Fantasia da Filial da Empresa numCgc: type: string maxLength: 18 description: Número do CPNJ/CPF da Filial da Empresa numIdf: type: string maxLength: 40 description: Número de identificação Fiscal insEst: type: string maxLength: 25 description: Inscrição estadual da filial da empresa insMun: type: string maxLength: 16 description: Inscrição municipal da filial da empresa postalCodeFil: type: string description: CEP numFon: type: string maxLength: 20 description: Telefone filMat: type: boolean description: Indicativo que a filial é matriz endFil: type: string maxLength: 100 description: Endereço da Filial da Empresa nenFil: type: string maxLength: 60 description: Número do endereço cplEnd: type: string maxLength: 200 description: Complemento do Endereço da Filial da Empresa (Sala, Andar, etc.) baiFil: type: string maxLength: 75 description: Bairro da Filial da Empresa e008rai: type: object allOf: – #/definitions/e008rai description: Cidade da Filial da Empresa e007ufsSigUfs: type: object allOf: – #/definitions/e007ufs description: Estado da Filial excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo da pessoa extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação e070filDfiUtc: type: array items: type: object allOf: – #/definitions/e070filDfiUtc description: Fusos horários da filial e070filDfiGer: type: object allOf: – #/definitions/e070filDfiGer description: Especialização insNfs: type: string maxLength: 16 description: Inscrição municipal para nota fiscal e070filDfiXml: type: object allOf: – #/definitions/e070filDfiXml description: Especialização configurações xml usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filDfiXml: description: Cadastros – Filiais – Documentos Eletrônicos – XML type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial simplifiedDeferredIcms: type: boolean description: Gerar ICMS diferido simplificado 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: Tabelas – Cidades para RAIS – SIG type: object properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código Cidade minimum: 0 maximum: 9999999 codIbg: type: integer format: int64 description: Código IBGE município minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome Cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado dataLake: type: boolean description: Indica se o dado é proveniente do data lake default: false 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: e007ufs: description: Tabelas – Estados 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 e006pai: type: object allOf: – #/definitions/e006pai description: País dataLake: type: boolean description: Indica se o dado é proveniente do data lake default: false 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: e006pai: description: Tabelas – Países type: object properties: id: type: string format: uuid description: Id da entidade codPai: type: string maxLength: 4 description: Código nomPai: type: string maxLength: 150 description: Nome dataLake: type: boolean description: Indica se o dado é proveniente do data lake default: false 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: e032edc: description: Modelo de documento type: object properties: id: type: string format: uuid description: Id da entidade codEdc: type: string maxLength: 3 description: Modelo de documento desEdc: type: string maxLength: 30 description: Descrição abrEdc: type: string maxLength: 5 description: Abreviatura 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: e020snf: description: Tabelas – séries de notas fiscais type: object 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: Filial codSnf: type: string maxLength: 3 description: Código desSnf: type: string maxLength: 30 description: Descrição abrSnf: type: string maxLength: 10 description: Abreviatura aplSnf: type: string allOf: – #/definitions/enumAplSnf description: Aplicação e032edc: type: object allOf: – #/definitions/e032edc description: Modelo do documento codSel: type: string maxLength: 3 description: série codSsl: type: string maxLength: 2 description: Subsérie qtdPar: type: integer format: int64 description: Quantidade máxima de parcelas minimum: 1 maximum: 999 indNma: type: boolean description: Indicativo de numeração manual default: false disAut: type: string allOf: – #/definitions/enumDisAut description: Dispositivo autorizado qtdPos: type: integer format: int64 description: Quantidade de números da nota fiscal minimum: 6 maximum: 9 excluido: type: boolean description: Indica se o registro foi excluído default: false e020snfDfiGer: type: object allOf: – #/definitions/e020snfDfiGer description: Numeração do documento da série 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: e020snfDfiGer: description: Tabelas – séries de notas fiscais type: object required: – ultNum properties: id: type: string format: uuid description: Id da entidade e020snf: type: object allOf: – #/definitions/e020snf description: série da nota fiscal ultNum: type: integer format: int64 description: Último número da nota fiscal minimum: 0 maximum: 999999999999999 ultDat: type: string format: date-time description: Último data da nota fiscal usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e020doc: description: Tabelas – registros de notas fiscais type: object required: – numDoc – dthEmi properties: id: type: string format: uuid description: Id da entidade e020snf: type: object allOf: – #/definitions/e020snf description: Série da nota fiscal numDoc: type: integer format: int64 description: Último número da nota fiscal minimum: 0 maximum: 999999999999999 dthEmi: type: string format: date-time description: Último data da nota fiscal docXml: type: string description: Xml gerado chvDoc: type: string description: Chave do documento eletrônico numPro: type: string description: Número do protocolo de autorização sitDoe: type: string allOf: – #/definitions/enumSitDoe description: Situação do documento fiscal dthAut: type: string format: date-time description: Data e hora de autorização chvCtg: type: string description: Chave do documento em contingência dthCtg: type: string format: date-time description: Data de autorização do documento em contingência tipCtg: type: string allOf: – #/definitions/enumTipCtg description: Tipo da contingência em que o documento foi autorizado tipoOperacao: type: string allOf: – #/definitions/enumTipOpe description: Tipo de operacao tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo de documento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e020docBatch: description: Lote de processamento da emissão de documentos type: object required: – tipBat – sitBat properties: id: type: string format: uuid description: Id entidade e020doc: type: object allOf: – #/definitions/e020doc description: e020doc ideExt: type: string description: Identificação externa codBat: type: integer format: int64 description: Código do lote tipBat: type: string allOf: – #/definitions/enumBatchProcessingType description: Tipo do lote sitBat: type: string allOf: – #/definitions/enumBatchStatus description: Situação do lote cnpCpf: type: string maxLength: 14 description: CNPJ da filial numDoc: type: integer format: int64 description: Número do documento codSel: type: string maxLength: 3 description: série legal msgBat: type: string description: Descrição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filDfiGer: description: Configuraçães para integração com eDocs type: object properties: id: type: string format: uuid description: Idenficador e070fil: type: object allOf: – #/definitions/e070fil description: Código da filial urlEDocs: type: string maxLength: 250 description: URL para acesso usuarioEDocs: type: string maxLength: 100 description: Usuário senhaEDocs: type: string maxLength: 100 description: Senha logEDocs: type: boolean description: Log tipInt: type: string allOf: – #/definitions/enumTipoIntegracaoSefaz description: Tipo de integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e020docRecEvent: description: Tabelas – Eventos do documento fiscal type: object required: – e020doc – tipEve – seqEve properties: id: type: string format: uuid description: Id da entidade e020doc: type: object allOf: – #/definitions/e020doc description: Relacionamento e020doc tipEve: type: string allOf: – #/definitions/enumTipEve description: Tipo do evento seqEve: type: integer format: int64 description: Sequência do evento minimum: 0 maximum: 9999 docXml: type: string description: Xml gerado numPro: type: string description: Número do protocolo de autorização dthAut: type: string format: date-time description: Data e hora de autorização sitEve: type: string allOf: – #/definitions/enumSitDoe description: Situação do evento ideExt: type: string description: Identificação externa usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e020docGnre: description: Tabela – Vinculação de documentos com GNRE type: object required: – id – chvDoc – e070fil – documentoGuiaId – situacao – dataEmissao properties: id: type: string format: uuid description: Identificador chvDoc: type: string description: Chave do Documento de Origem e070fil: type: object allOf: – #/definitions/e070fil description: Filial documentoGuiaId: type: string format: uuid description: Identificador da guia de documento xml: type: string description: XML gerado codigoBarras: type: string description: Código de barras situacao: type: string allOf: – #/definitions/enumSitDoe description: Situação da GNRE dataEmissao: type: string format: date-time description: Data Emissão usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filDfiUtc: description: Estrutura para armazenar os fusos horários da filial type: object required: – utcSequence – initialDate – utcType properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial utcSequence: type: integer format: int64 description: Sequência do registro initialDate: type: string format: date description: Data inicial da vigência finalDate: type: string format: date description: Data final da vigência utcType: type: string allOf: – #/definitions/enumUtcType description: Fuso Horário (UTC) usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: tipoDocumentoGnre: description: Tipo identificação da tag na GNRE type: object required: – id – e007ufs – modeloDocumento – codigoReceita – documentoOrigem – codigoCampoExtraDocumento – excecaoModelo – exigeDetalhamentoReceita – exigeProdutos – exigeDestinatario – exigeReferencia – utilizaNumeroDocumento properties: id: type: string format: uuid description: Identificador e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado modeloDocumento: type: string maxLength: 200 description: Modelo de documento codigoReceita: type: integer format: int64 description: Código de receita maximum: 999999 documentoOrigem: type: integer format: int64 description: Documento de origem maximum: 99 codigoCampoExtraDocumento: type: integer format: int64 description: Código de campo extra documento maximum: 999 excecaoModelo: type: boolean description: Exceção de modelo exigeDetalhamentoReceita: type: boolean description: Exige detalhamento de receita exigeProdutos: type: boolean description: Exige produtos exigeDestinatario: type: boolean description: Exige destinatários exigeReferencia: type: boolean description: Exige referência utilizaNumeroDocumento: type: boolean description: Utiliza número de documento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e020docCarrie: description: Tabela de relacionamento do documento com CTe type: object required: – e020doc – e070fil – tipoAmbiente properties: id: type: string format: uuid description: Identificador e020doc: type: object allOf: – #/definitions/e020doc description: Identificador documento e070fil: type: object allOf: – #/definitions/e070fil description: Identificador filial tipoAmbiente: type: string allOf: – #/definitions/enumTipoAmbienteEdocs description: Tipo do Ambiente usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE