receive_tracker

2.0info: 1.6.0 receive_tracker description: receive_tracker x-senior-domain: erpx_dfi x-senior-domain-path: erpx_dfi x-senior-service-path: receive_tracker 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: /receive_tracker/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/actions/getDocumentsToReceive: post: description: Obter XML do documento através do eDocs tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – documentType properties: transactionalId: type: string description: transactional ID branchId: type: array items: type: string minimum: 1 description: ID da filial documentType: type: string allOf: – #/definitions/enumDocumentType description: Tipo de documento responses: 200: description: Ok schema: type: object required: – receiveDocuments properties: transactionalId: type: string description: transactional ID receiveDocuments: type: array items: type: object allOf: – #/definitions/recDocumentsReceive minimum: 1 description: Lista de documentos a receber errorMessage: type: string description: Error message 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/actions/checkDocumentsStatus: post: description: Consultar situação de documentos no eDocs tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – documentType – processingType – documents properties: transactionalId: type: string description: transactional ID branchId: type: string description: ID da filial documentType: type: string allOf: – #/definitions/enumDocumentType description: Tipo de documento processingType: type: string allOf: – #/definitions/enumProcessingType description: Tipo de processamento (EMISSION = 1, RECEIPT = 2) documents: type: array items: type: object allOf: – #/definitions/recDocumentIdentification minimum: 1 description: Lista de documentos a consultar responses: 200: description: Ok schema: type: object properties: transactionalId: type: string description: transactional ID documents: type: array items: type: object allOf: – #/definitions/recDocumentStatus description: Lista de situações de documentos errorMessage: type: string description: Error message 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/actions/getDocumentXML: post: description: Get XML information for a document via eDocs tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – branchId – documentKey – documentType properties: branchId: type: string description: Branch ID documentKey: type: string description: Document key documentType: type: string allOf: – #/definitions/enumDocumentType description: Document type processingType: type: string allOf: – #/definitions/enumProcessingType description: Processing type responses: 200: description: Ok schema: type: object required: – xmlData properties: xmlData: type: object allOf: – #/definitions/recDocumentXML description: XML information 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/signals/getDocumentsToReceiveAsync: post: description: Get documents to receive asynchronously via signal. Returns results using callback. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – documentType – callback properties: transactionalId: type: string description: transactional ID branchId: type: array items: type: string minimum: 1 description: Branch ID documentType: type: string allOf: – #/definitions/enumDocumentType description: Document type callback: type: object allOf: – #/definitions/callback description: Callback data for async API response responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /receive_tracker/signals/checkDocumentsStatusAsync: post: description: Check document status asynchronously via signal. Returns results using callback. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – documentType – processingType – documents – callback properties: transactionalId: type: string description: Transactional ID branchId: type: string description: Branch ID documentType: type: string allOf: – #/definitions/enumDocumentType description: Document type processingType: type: string allOf: – #/definitions/enumProcessingType description: Processing type (EMISSION = 1, RECEIPT = 2) documents: type: array items: type: object allOf: – #/definitions/recDocumentIdentification minimum: 1 description: List of documents to check callback: type: object allOf: – #/definitions/callback description: Callback data for async API response responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/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 /receive_tracker/entities/e006pai: 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/e006pai responses: 200: description: The created resource schema: #/definitions/e006pai 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/e006pai responses: 200: description: The created resource schema: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/entities/e006pai/{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/editE006pai responses: 200: description: Ok schema: #/definitions/editE006pai 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/e006pai responses: 200: description: Ok schema: #/definitions/e006pai 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/e006pai 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 /receive_tracker/entities/e006pai/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e006pai responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/entities/e007ufs: 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/e007ufs responses: 200: description: The created resource schema: #/definitions/e007ufs 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/e007ufs responses: 200: description: The created resource schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/entities/e007ufs/{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/editE007ufs responses: 200: description: Ok schema: #/definitions/editE007ufs 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/e007ufs responses: 200: description: Ok schema: #/definitions/e007ufs 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/e007ufs 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 /receive_tracker/entities/e007ufs/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e007ufs responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/entities/e008rai: 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/e008rai responses: 200: description: The created resource schema: #/definitions/e008rai 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/e008rai responses: 200: description: The created resource schema: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/entities/e008rai/{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/editE008rai responses: 200: description: Ok schema: #/definitions/editE008rai 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/e008rai responses: 200: description: Ok schema: #/definitions/e008rai 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/e008rai 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 /receive_tracker/entities/e008rai/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e008rai responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070filDfiXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/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 /receive_tracker/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e020doc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/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/editE020doc responses: 200: description: Ok schema: #/definitions/editE020doc 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 /receive_tracker/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 /receive_tracker/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e020snfDfiGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/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/editE020snfDfiGer responses: 200: description: Ok schema: #/definitions/editE020snfDfiGer 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 /receive_tracker/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 /receive_tracker/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070filDfiUtc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/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/editE070filDfiUtc responses: 200: description: Ok schema: #/definitions/editE070filDfiUtc 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 /receive_tracker/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 /receive_tracker/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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070filDfiGer 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /receive_tracker/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/editE070filDfiGer responses: 200: description: Ok schema: #/definitions/editE070filDfiGer 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 /receive_tracker/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/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumDocumentSituation: type: string enum: – AUTHORIZED – REJECTED – CANCELED – DENIED – VOIDED – CLOSED – PROCESSING – CONTINGENCY – DRIVER_INCLUSION – EXTENSION_GRANTED – EXTENSION_DENIED – EXTENSION_PARTIALLY_GRANTED – CUSTOMS_RECTIFIED description: Situação do documento retornada pelo eDocs ConsultarSituacaoDocumentos: * `AUTHORIZED` – Documento autorizado no sistema, situação final * `REJECTED` – Documento rejeitado no sistema, pode ser reintegrado usando a mesma chave/ID * `CANCELED` – Documento cancelado no sistema, situação final * `DENIED` – Documento denegado no sistema, situação final * `VOIDED` – Documento inutilizado no sistema, situação final * `CLOSED` – Documento encerrado no sistema, situação final. Somente usado para MDF-e * `PROCESSING` – Documento ainda está em processamento pelo sistema, sua situação será alterada assim que o processamento for finalizado * `CONTINGENCY` – Documento foi emitido em contingência * `DRIVER_INCLUSION` – Evento de inclusão de condutor autorizado no sistema, somente usado para MDF-e * `EXTENSION_GRANTED` – Pedido de prorrogação deferido, somente usado para pedidos de prorrogação de suspensão do ICMS de NF-e quando todos os seus itens estiverem deferidos * `EXTENSION_DENIED` – Pedido de prorrogação indeferido, somente usado para pedidos de prorrogação de suspensão do ICMS de NF-e quando todos os seus itens estiverem indeferidos * `EXTENSION_PARTIALLY_GRANTED` – Pedido de prorrogação deferido parcialmente, somente usado para pedidos de prorrogação de suspensão do ICMS de NF-e quando alguns de seus itens estiverem deferidos e outros indeferidos * `CUSTOMS_RECTIFIED` – Evento de recinto aduaneiro retificado por um segundo evento enumSitDoe: type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 – V07 – V08 – V09 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 – V20 description: Tipo de documento – eDocs: * `V01` – Não Enviada * `V02` – Enviada * `V03` – Autorizada * `V04` – Rejeitada * `V05` – Denegada * `V06` – Solicitado Inutilização * `V07` – Solicitado Cancelamento * `V08` – Inutilizada * `V09` – Cancelada * `V10` – Erro Geração * `V11` – Erro Solicitação Cancelamento * `V12` – Erro Solicitação Inutilização * `V13` – Pendente de Cancelamento * `V14` – Solicitado Encerramento (MDF-e) * `V15` – Encerrado (MDF-e) * `V16` – Autorizado em contingência * `V17` – Evento Registrado * `V18` – Diferido Parcial * `V19` – Indeferido * `V20` – Erro Solicitação Encerramento (MDF-e) enumTipCtg: type: string enum: – V1 – V2 – V4 – V5 – V6 – V7 description: Tipo da contingência NF-e: * `V1` – Normal * `V2` – FS * `V4` – DPEC-EPEC * `V5` – FS-DA * `V6` – SVCAN * `V7` – SVCRS enumTipOpe: type: string enum: – V0 – V1 description: Status do lote de processamento: * `V0` – Entrada * `V1` – Saída enumDocumentType: type: string enum: – V1 – V2 – V3 – V5 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 description: Tipo de documento – eDocs: * `V1` – Nota Fiscal de Produto * `V2` – Nota Fiscal de serviço * `V3` – Conhecimento de Transporte * `V5` – Manifesto eletrônico de Documentos Fiscais * `V7` – eSocial * `V8` – Nota Fiscal de Consumidor Eletrônica * `V9` – Cupom fiscal eletrônico * `V10` – EFD-Reinf * `V11` – GNRE * `V12` – Conhecimento de Transporte Outros serviços * `V13` – PAF-ECF Bloco X * `V14` – GRFGTS * `V15` – Evento de Encerramento do Manifesto eletrônico de Documentos Fiscais * `V16` – Evento de Cancelamento do Manifesto eletrônico de Documentos Fiscais * `V17` – Evento de Inclusão de Motorista no Manifesto eletrônico de Documentos Fiscais * `V18` – Evento de Inclusão de DF-e no Manifesto eletrônico de Documentos Fiscais enumAplSnf: type: string enum: – VS – VM – VE – VF – VD description: Aplicação: * `VS` – Notas Fiscais de Entrada e Saída * `VM` – Geração Manual CR e CP * `VE` – Somente para NF Entrada * `VF` – Somente para Manifesto * `VD` – Somente para NF Saída enumDisAut: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 description: Dispositivo autorizado: * `V1` – Blocos * `V2` – Formulário Contínuo * `V3` – Formulário de Segurança * `V4` – Jogos Soltos * `V5` – ECF * `V6` – Nota Fiscal Eletrônica * `V7` – Conhecimento de Transporte eletrônico * `V8` – Nota Fiscal Eletrônica de serviço * `V9` – Manifesto eletrônico * `V10` – Nota Fiscal Consumidor Eletrônica * `V11` – Cupom Fiscal eletrônico (SAT) * `V12` – Recibo simples enumTipoIntegracaoSefaz: type: string enum: – VSINCRONO – VASSINCRONO description: Indicativo de tipo de integração com a Sefaz: * `VSINCRONO` – Integração Síncrona * `VASSINCRONO` – Integração Assíncrona enumJurFis: type: string enum: – VJ – VF description: Tipo Pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física enumUtcType: type: string enum: – UTC_1 – UTC_2 – UTC_3 – UTC_4 – UTC_5 description: Fuso Horario UTC: * `UTC_1` – UTC-1 – Fernando de Noronha (horário de ver?o) (-01:00) * `UTC_2` – UTC-2 – Fernando de Noronha (-02:00) * `UTC_3` – UTC-3 – Brasília (-03:00) * `UTC_4` – UTC-4 – Amazonas (-04:00) * `UTC_5` – UTC-5 – Acre (-05:00) enumBatchProcessingType: type: string enum: – V1 – V2 – V3 – V4 description: Status do lote de processamento: * `V1` – Emissão * `V2` – Cancelamento * `V3` – Inutilização * `V4` – Carta de correção enumProcessingType: type: string enum: – EMISSION – RECEIPT description: Tipo de processamento do documento: * `EMISSION` – Emissão * `RECEIPT` – Recebimento userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error recDocumentsReceive: description: Informações do XML do documento type: object required: – branch – documentKey – documentType properties: branch: type: string description: Filial documentKey: type: string description: Chave do documento documentType: type: string allOf: – #/definitions/enumDocumentType description: Tipo documento eventType: type: integer format: int64 description: Tipo Evento recDocumentIdentification: description: Identificação do documento para consulta type: object properties: documentKey: type: string description: Chave do documento issuerCnpj: type: string description: CNPJ do emissor number: type: integer format: int64 description: Número do documento series: type: integer format: int64 description: Série do documento recDocumentStatus: description: Situação de um documento no eDocs type: object properties: documentKey: type: string description: Chave do documento situation: type: string allOf: – #/definitions/enumDocumentSituation description: Situação do documento documentType: type: string allOf: – #/definitions/enumDocumentType description: Tipo do documento branch: type: string description: Filial checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck callback: description: Callback data for async API response type: object required: – domain – service – primitive properties: domain: type: string description: Domain service: type: string description: Service primitive: type: string description: Primitive recDocumentXML: description: type: object required: – branchId – issuerCnpj – issuerName – issueDate – documentModel – documentNumber – documentSeries – documentValue – documentVersion – xmlFile properties: branchId: type: string description: Branch ID issuerCnpj: type: string maxLength: 14 description: Issuer CNPJ issuerName: type: string maxLength: 60 description: Issuer name stateAbbreviation: type: string maxLength: 2 description: State abbreviation issueDate: type: string format: date-time description: Issue date documentModel: type: integer format: int64 description: Document model documentNumber: type: integer format: int64 description: Document number documentSeries: type: string description: Document series documentValue: type: string description: Document value documentVersion: type: string description: Document version xmlFile: type: string description: Full XML e006pai: description: País type: object required: – codPai – nomPai 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 excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editE006pai: type: object required: – id allOf: – #/definitions/e006pai 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: editE007ufs: type: object required: – id allOf: – #/definitions/e007ufs e008rai: description: Cidade type: object required: – codRai – nomCid – e007ufs properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editE008rai: type: object required: – id allOf: – #/definitions/e008rai e070emp: description: Empresa 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 maxLength: 20 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: 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/enumDocumentType 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: editE020doc: type: object required: – id allOf: – #/definitions/e020doc 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 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: 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: 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: editE020snfDfiGer: type: object required: – id allOf: – #/definitions/e020snfDfiGer 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: editE070filDfiUtc: type: object required: – id allOf: – #/definitions/e070filDfiUtc e070filDfiGer: description: Configurações para integração com eDocs type: object properties: id: type: string format: uuid description: Identificador 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: editE070filDfiGer: type: object required: – id allOf: – #/definitions/e070filDfiGer notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage