PUBLIC SERVICES [PROD]
    PUBLIC SERVICES [PROD]
    • Introduction
    • Document Management
    • External Integration
    • Authentication
      • Generate a token to access ROIT APIs
    • Invoice-to-Pay
      • Documents Manager
        • Create document export request
        • Get export request by id
        • Delete export request by id
        • Generate signed URLs for export files by id
        • Export structured document data processed in the Pipeline
      • External System Integration
        • Get pending entities to be integrated
        • Register delivery integration
        • Update integration status
        • Get all documents attached to a request
        • Reprocess a specific request
      • Upload Document
        • Upload document as base64
      • Account Payable
        • This operation will list the Account payable events
        • This operation will count all the Account payable
        • This operation will search the Account payable by id
        • This operation will search all the Account payable
        • This operations is designed to search an account payable by metadata information
    • Tax Reform
      • Data Integration
        • Create a new request
        • Update request status
        • Generate signed URL
      • CClasTrib Data
        • Get cclasstrib data
    • Schemas
      • Schemas
        • nationalRegisterGeneric
        • ProcessUpload
        • CompanyDTO
        • Date
        • InstallmentDetailsModel
        • QueryOperatorFormat
        • FileUploadBase64DTO
        • CurrencyDTO
        • QueryOperators
        • ValueDTO
        • QueryOperatorStep
        • AccountPayableMetadataDTO
        • ReceiptModel
        • costCenterGeneric
        • CanceledAccountPayableUser
        • DocumentTributeDTO
        • CanceledAccountPayable
        • CreateTokenDTO
        • Status
        • PaymentPurpose
        • IsLocked
        • AccountPayableTaxDataModel
        • AccountPayable
        • BarcodeDetailDTO
        • BankAccountDTO
        • PixDetailDTO
        • TedDetailDTO
        • AbstractPaymentDetailDTO
        • TaxWithBarcodeDetailDTO
        • TableMetadata
        • DARFDetailDTO
        • DARJDetailDTO
        • DPVATDetailDTO
        • GAREDetailDTO
        • HeaderResponse
        • IPVADetailDTO
        • LicensingDetailDTO
        • SimpleDARFDetailDTO
        • CteCargoQuantityDetail
        • PayrollDetailDTO
        • InstallmentDTO
        • CteTomadorDto
        • PaymentPurposeDTO
        • AccountPayableTaxDataDTO
        • AccountPayableDTO
        • UserDetailDTO
        • AccountPayableUpdateDTO
        • AccountPayableUpdateStatusMetadataModel
        • AccountPayableUpdateStatusDTO
        • AccountPayableUpdateIsOpenDTO
        • MassUnlockDTO
        • AccountPayableUpdateDefaultHolderBankDTO
        • AccountPayableReceiptDTO
        • AccountPayableRescheduleDTO
        • RequestPaymentDTO
        • IntegrationEventMetadata
        • IntegrationEvent
        • IntegrationEventDTO
        • AccountPayableDeleteDTO
        • AccountPayableEvent
        • Number
        • UniqueFiltersModel
        • PaginatedAccountPayable
        • SearchDTO
        • AccountPayableRedefineDetailDTO
        • AccountPayableRedefineMetadataDTO
        • AccountPayableUpdateIntegrationStatusDTO
        • AccountPayableAuthentication
        • AuthenticationDTO
        • AccountPayableExportDTO
        • AccountPayableExportMetadata
        • AccountsPayableExportLog
        • AccountPayableExportUpdateDTO
      • Currency
      • DataDto
      • UserContextModel
      • ForgotPasswordDTO
      • NationalRegisterGeneric
      • BaseResponse
      • AuditBigQueryRequest
      • DocumentFileDTO
      • AccountsPayableDto
      • Period
      • TransitionalTokenResponseDTO
      • AddresGeneric
      • DocumentType
      • CreateResponse
      • AuditBigQueryResponse
      • DocumentFileErpDTO
      • SyncRequest
      • HeaderModel
      • BusinessPartner
      • LoginDTO
      • ProviderGeneric
      • Error
      • CreateResponseData
      • DeleteResponse
      • DataBaseDest
      • AuditBigQueryResponseData
      • DocumentAddressDTO
      • SyncResponse
      • LinkModel
      • PurchaseItem
      • CustomTokenResponseDTO
      • NfeModalityDto
      • HTTPValidationError
      • DeleteResponseData
      • AccountsPayableHeaderDto
      • AuditStorageRequest
      • DocumentPartyDTO
      • SyncResponseData
      • CostCenter
      • PaymentMethod
      • RefreshTokenResponseDTO
      • NfeDocumentHeaderDto
      • SignedUrlRequest
      • HolderDto
      • AuditStorageResponse
      • DocumentServiceDTO
      • ItemParentModel
      • PurchaseOrderDto
      • ClientTreeFilter
      • RefreshTokenDTO
      • NfeTaxDto
      • CostCenterGeneric
      • Type
      • GetResponse
      • AuditStorageResponseData
      • DocumentCpomDTO
      • Tribute
      • Contact
      • BaseFiltersModel
      • AuthorizationTokenResponseDTO
      • UpdateStatusRequest
      • CreateRequestSuccessResponse
      • ProcessStatus
      • GetResponseData
      • AccountsPayableResponseDto
      • ItemModel
      • Address
      • ExportRequestModel
      • UserInfoDTO
      • NfeItemDto
      • ValidationError
      • SignedUrlResponse
      • GenericErrorResponse
      • AccountsPayableModelResponse
      • DocumentTransportDTO
      • ServiceLocation
      • BankAccount
      • CreateRequestDTO
      • NfeDto
      • GenericUnauthorizedResponse
      • ListResponse
      • DocumentPaymentDTO
      • TaxModel
      • Branch
      • Array
      • TokenSuccessResponseDTO
      • NfeResponseDto
      • UpdateResponse
      • ListResponseData
      • DocumentTotalResumeDTO
      • DocumentCteCityDTO
      • DocumentModel
      • AdditionalInfos
      • ProcessRequestDTO
      • TokenErrorResponseDTO
      • NfeModelResponse
      • UpdateResponseData
      • PublicCreateTokenDTO
      • PaginationData
      • DecryptFilesRequest
      • DocumentCteProtocolDTO
      • GenericModel
      • SupplierDto
      • ExportRequestFileModel
      • GenericHeaderModel
      • ChangeAuthPasswordDTO
      • NfseDocumentHeaderDto
      • GenericSuccessResponse
      • DecryptFilesResponse
      • DocumentCteQuantityInformationDTO
      • EntityRequestModel
      • TaxDto
      • Blob
      • RedefinePasswordDTO
      • NfseTax
      • RequestItem
      • DecryptFilesResponseData
      • DocumentCteCargoDetailsDTO
      • Object
      • TaxCodeDto
      • ZipProcessorDTO
      • CreateMfaResponseDTO
      • ItemNfseDto
      • GetAllRequestItemSuccessResponse
      • DecryptedFileInfo
      • DocumentCteServiceComplementationDTO
      • PendingDto
      • TaxCodeIrfDto
      • ClientTreeOption
      • CreateMfaDTO
      • NfseDto
      • RequestActionUserDTO
      • EntityStatusModel
      • CostCenterDto
      • Additional
      • ActiveMfaDto
      • NfseResponseDto
      • SignedUrlResponseData
      • FileActionHistoryDTO
      • UpdateStatusDto
      • PaymentConditionDto
      • ExportFiltersModel
      • SendMfaVerificationDTO
      • NfseModelResponse
      • EntityTimelineModel
      • ItemDto
      • CreateExportFiltersDTO
      • VerifyTokenResponseDTO
      • ConsumptionBillDocumentHeaderDto
      • Table
      • GetDataResponseDto
      • FinancialNatureDto
      • UpdateExportFiltersDTO
      • AddMfaTypeDTO
      • ItemGeneric
      • PatchPriorityDto
      • InvoiceItem
      • SourceData
      • SetDefaultTypeDTO
      • ConsumptionBillDto
      • PendingResponseDto
      • OutboundInvoiceDto
      • QrCodeDTO
      • ConsumptionBillResponseDto
      • IntegrationDTO
      • DeliveryAuthorizationItem
      • OidcInterceptorDTO
      • ConsumptionBillModelResponse
      • DocumentResponseDTO
      • String
      • DeliveryAuthorizationDto
      • UserIdDTO
      • CteCityDto
      • PaginatedDocumentsResponseDTO
      • DeliveryDto
      • BlindReviewItem
      • MfaMyOptionsResponseDTO
      • CteTributesDto
      • LegacyDeliveryDTO
      • BlindReviewDto
      • CreateTrustedDeviceDTO
      • CteShippingDto
      • EventHubDTO
      • GoodsThirdPartyDto
      • AuthorizationGenerationDTO
      • ServerToServerTokenResponseDTO
      • CteCargoDetailsDto
      • MfaDTO
      • DeliverySuccessResponseDto
      • TokenExchangeDTO
      • TenantResponseDTO
      • DeliveryBadRequestResponseDto
      • CteDocumentHeaderDto
      • UserTenantResponseDTO
      • DeliveryUnauthorizedResponseDto
      • IdentificationModel
      • CteDto
      • OutputTenantDTO
      • ItemCategorizationModel
      • CteResponseDto
      • CreateTokenResponseDTO
      • CteModelResponse
      • CreateTokenRequestDTO
      • ImpersonateUserDTO
      • CnaeCode
      • LegalNature
      • SupplierData
      • SupplierContent
      • SupplierResponseDto
      • SupplierModelResponse
      • FileDto
      • DateModel
      • AttachsDto
      • LegacyGetAttachsDto
      • GetDataDto
      • UpdateStatusResponseDto
      • ManifestationStatusModel
      • ManifestationModel
      • PatchTranslatedDataDto
      • ReprocessDto
      • Entity

    NfeResponseDto

    {
        "header": {
            "nationalRegister": "93293146000153"
        },
        "documents": [
            {
                "requestId": "1234567890",
                "reference": "1234567890",
                "file": "ExampleFile.xml",
                "nationalRegister": "93293146000153",
                "type": "NFE | NFSE | CTE | CONSUMPTION_BILL",
                "provider": {
                    "name": "Empresa de Teste",
                    "personType": "CNPJ",
                    "nationalRegisterPartner": "93293146000153",
                    "address": {
                        "street": "Rua das Flores",
                        "number": "123",
                        "zipCode": "71745800",
                        "city": "São Paulo",
                        "cityUniqueCode": "3550308",
                        "complement": "Apto 123",
                        "state": "SP",
                        "district": "Bairro das Flores"
                    }
                },
                "header": {
                    "documentTotalValue": "100.00",
                    "series": "025",
                    "number": "0001",
                    "postingDate": "2025-05-05T00:00:00.000Z",
                    "issueDate": "2026-06-06T00:00:00.000Z",
                    "dueDate": "2027-07-07T00:00:00.000Z",
                    "accessKey": "1234567890543129867564538762198736451238413",
                    "shipping": {
                        "modality": "3",
                        "value": "100"
                    },
                    "authorizationCode": "1234567890543129867564538762198736451238413"
                },
                "items": [
                    {
                        "purchaseNumber": "7504120",
                        "purchaseItem": "01",
                        "code": "XYZ123",
                        "costCenter": {
                            "code": "01.02"
                        },
                        "quantity": "10",
                        "unityValue": "100.00",
                        "totalValue": "1000.00",
                        "unitMeasurement": "UN",
                        "ncm": "98765432",
                        "ean": "9876543210123",
                        "cfop": "1234",
                        "taxes": [
                            {
                                "base": 12234.68,
                                "aliquot": 0.1,
                                "value": 25,
                                "name": "ICMS"
                            }
                        ]
                    }
                ]
            }
        ]
    }
    Built with