1. Documents Manager
PUBLIC SERVICES [PROD]
  • Introduction
  • Document Management
  • External Integration
  • Authentication
    • Generate a token to access ROIT APIs
      POST
  • Invoice-to-Pay
    • Documents Manager
      • Create document export request
        POST
      • Get export request by id
        GET
      • Delete export request by id
        DELETE
      • Generate signed URLs for export files by id
        GET
      • Export structured document data processed in the Pipeline
        GET
      • Stream a structured export of document data (JSON or CSV) — small volumes only
        GET
      • Queue an async export job — returns jobId immediately
        POST
      • Poll the status of an async export job
        GET
    • 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
      • Batch update request statuses
      • Batch update status only (lightweight)
      • Generate signed URL
      • Generate upload path
      • Batch generate upload paths
      • Get file processing status
    • CClasTrib Data
      • Get cclasstrib data
  • Schemas
    • Schemas
      • nationalRegisterGeneric
      • ProcessUpload
      • Date
      • QueryOperatorFormat
      • FileUploadBase64DTO
      • QueryOperators
      • QueryOperatorStep
      • costCenterGeneric
      • DocumentTributeDTO
      • CreateTokenDTO
      • Status
      • TableMetadata
      • HeaderResponse
      • CteCargoQuantityDetail
      • CteTomadorDto
    • DataDto
    • ForgotPasswordDTO
    • NationalRegisterGeneric
    • AuditBigQueryRequest
    • CompanyDTO
    • DocumentFileDTO
    • AccountsPayableDto
    • TransitionalTokenResponseDTO
    • AddresGeneric
    • AuditBigQueryResponse
    • InstallmentDetailsModel
    • DocumentFileErpDTO
    • SyncRequest
    • BusinessPartner
    • LoginDTO
    • ProviderGeneric
    • AuditBigQueryResponseData
    • CurrencyDTO
    • DocumentAddressDTO
    • SyncResponse
    • PurchaseItem
    • CustomTokenResponseDTO
    • AccountsPayableHeaderDto
    • AuditStorageRequest
    • ValueDTO
    • DocumentPartyDTO
    • SyncResponseData
    • PaymentMethod
    • RefreshTokenResponseDTO
    • HolderDto
    • AuditStorageResponse
    • AccountPayableMetadataDTO
    • DocumentServiceDTO
    • PurchaseOrderDto
    • RefreshTokenDTO
    • AuditStorageResponseData
    • ReceiptModel
    • DocumentCpomDTO
    • Contact
    • AuthorizationTokenResponseDTO
    • BaseResponse
    • AccountsPayableResponseDto
    • CanceledAccountPayableUser
    • DocumentTransportDTO
    • Address
    • UserInfoDTO
    • AccountsPayableModelResponse
    • CanceledAccountPayable
    • DocumentPaymentDTO
    • BatchDeleteRequest
    • BankAccount
    • TokenSuccessResponseDTO
    • NfeModalityDto
    • PaymentPurpose
    • DocumentTotalResumeDTO
    • BatchDeleteResponse
    • Branch
    • TokenErrorResponseDTO
    • NfeDocumentHeaderDto
    • IsLocked
    • DocumentCteCityDTO
    • BatchStatusItem
    • AdditionalInfos
    • CostCenterGeneric
    • PublicCreateTokenDTO
    • AccountPayableTaxDataModel
    • DocumentCteProtocolDTO
    • BatchStatusRequest
    • SupplierDto
    • ChangeAuthPasswordDTO
    • NfeTaxDto
    • AccountPayable
    • DocumentCteQuantityInformationDTO
    • BatchStatusResponse
    • TaxDto
    • RedefinePasswordDTO
    • NfeItemDto
    • BarcodeDetailDTO
    • DocumentCteCargoDetailsDTO
    • BatchStatusResponseData
    • TaxCodeDto
    • CreateMfaResponseDTO
    • NfeDto
    • BankAccountDTO
    • DocumentCteServiceComplementationDTO
    • BatchUpdateResponse
    • TaxCodeIrfDto
    • CreateMfaDTO
    • NfeResponseDto
    • PixDetailDTO
    • RequestActionUserDTO
    • BatchUpdateStatusRequest
    • CostCenterDto
    • ActiveMfaDto
    • NfeModelResponse
    • TedDetailDTO
    • FileActionHistoryDTO
    • BatchUploadPathRequest
    • PaymentConditionDto
    • SendMfaVerificationDTO
    • NfseDocumentHeaderDto
    • AbstractPaymentDetailDTO
    • DocumentResponseDTO
    • BatchUploadPathResponse
    • ItemDto
    • VerifyTokenResponseDTO
    • NfseTax
    • TaxWithBarcodeDetailDTO
    • PaginatedDocumentsResponseDTO
    • ConductorCallback
    • FinancialNatureDto
    • UserContextModel
    • AddMfaTypeDTO
    • ItemNfseDto
    • CreateResponse
    • DARFDetailDTO
    • InvoiceItem
    • Period
    • SetDefaultTypeDTO
    • NfseDto
    • CreateResponseData
    • DARJDetailDTO
    • OutboundInvoiceDto
    • ClientTreeFilter
    • QrCodeDTO
    • NfseResponseDto
    • DataBaseDest
    • DPVATDetailDTO
    • DeliveryAuthorizationItem
    • BaseFiltersModel
    • OidcInterceptorDTO
    • NfseModelResponse
    • GAREDetailDTO
    • DecryptFilesRequest
    • DeliveryAuthorizationDto
    • ExportRequestModel
    • UserIdDTO
    • ConsumptionBillDocumentHeaderDto
    • IPVADetailDTO
    • DecryptFilesResponse
    • CreateRequestDTO
    • BlindReviewItem
    • MfaMyOptionsResponseDTO
    • ItemGeneric
    • LicensingDetailDTO
    • DecryptFilesResponseData
    • BlindReviewDto
    • CreateTrustedDeviceDTO
    • ConsumptionBillDto
    • CreateRequestSuccessResponse
    • SimpleDARFDetailDTO
    • DecryptedFileInfo
    • GoodsThirdPartyDto
    • AuthorizationGenerationDTO
    • ConsumptionBillResponseDto
    • GenericErrorResponse
    • DeleteResponse
    • PayrollDetailDTO
    • DeliveryDto
    • ServerToServerTokenResponseDTO
    • ConsumptionBillModelResponse
    • GenericUnauthorizedResponse
    • DeleteResponseData
    • InstallmentDTO
    • Array
    • DeliverySuccessResponseDto
    • DocumentType
    • CteCityDto
    • PaymentPurposeDTO
    • TokenExchangeDTO
    • ProcessRequestDTO
    • MfaDTO
    • DeliveryBadRequestResponseDto
    • Error
    • CteTributesDto
    • AccountPayableTaxDataDTO
    • TenantResponseDTO
    • DeliveryUnauthorizedResponseDto
    • CteShippingDto
    • GenericSuccessResponse
    • AccountPayableDTO
    • FileStatusResponse
    • LegacyDeliveryDTO
    • ExportRequestFileModel
    • UserTenantResponseDTO
    • CteCargoDetailsDto
    • UserDetailDTO
    • FileStatusResponseData
    • EventHubDTO
    • OutputTenantDTO
    • CteDocumentHeaderDto
    • GetAllRequestItemSuccessResponse
    • GetResponse
    • AccountPayableUpdateDTO
    • Blob
    • CreateTokenResponseDTO
    • CteDto
    • GetResponseData
    • AccountPayableUpdateStatusMetadataModel
    • ZipProcessorDTO
    • CreateTokenRequestDTO
    • HTTPValidationError
    • CteResponseDto
    • AccountPayableUpdateStatusDTO
    • ClientTreeOption
    • CteModelResponse
    • ImpersonateUserDTO
    • AccountPayableUpdateIsOpenDTO
    • ListByStatusResponse
    • Object
    • Additional
    • MassUnlockDTO
    • CnaeCode
    • ListByStatusResponseData
    • ExportFiltersModel
    • ListResponse
    • AccountPayableUpdateDefaultHolderBankDTO
    • LegalNature
    • CreateExportFiltersDTO
    • ListResponseData
    • AccountPayableReceiptDTO
    • SupplierData
    • UpdateExportFiltersDTO
    • PaginationData
    • AccountPayableRescheduleDTO
    • SupplierContent
    • ProcessStatus
    • RequestPaymentDTO
    • SupplierResponseDto
    • DataManagerExportDTO
    • RequestItem
    • IntegrationEventMetadata
    • SupplierModelResponse
    • FileDto
    • SignedUrlRequest
    • IntegrationEvent
    • AttachsDto
    • SignedUrlResponse
    • IntegrationEventDTO
    • Currency
    • SignedUrlResponseData
    • AccountPayableDeleteDTO
    • Table
    • AccountPayableEvent
    • DateModel
    • HeaderModel
    • Type
    • Number
    • LinkModel
    • UpdateResponse
    • UniqueFiltersModel
    • CostCenter
    • UpdateResponseData
    • PaginatedAccountPayable
    • ItemParentModel
    • UpdateStatusRequest
    • SearchDTO
    • Tribute
    • AccountPayableRedefineDetailDTO
    • UploadPathRequest
    • ItemModel
    • AccountPayableRedefineMetadataDTO
    • UploadPathResponse
    • ServiceLocation
    • AccountPayableUpdateIntegrationStatusDTO
    • UploadPathResponseData
    • TaxModel
    • ValidationError
    • AccountPayableAuthentication
    • IdentificationModel
    • AuthenticationDTO
    • ItemCategorizationModel
    • AccountPayableExportDTO
    • ManifestationStatusModel
    • AccountPayableExportMetadata
    • ManifestationModel
    • AccountsPayableExportLog
    • DocumentModel
    • AccountPayableExportUpdateDTO
    • GenericHeaderModel
    • CallbackConfig
    • GenericModel
    • AccountPayableConfig
    • EntityRequestModel
    • CallbackConfigDTO
    • Entity
    • CreateAccountPayableConfigDTO
    • PendingDto
    • UpdateCallbackConfigDTO
    • UpdateStatusResponseDto
    • UpdateAccountPayableConfigDTO
    • UpdateStatusDto
    • Boolean
    • EntityStatusModel
    • AccountsPayableDTO
    • EntityTimelineModel
    • ErpEventDataDTO
    • SourceData
    • GetDataResponseDto
    • PatchTranslatedDataDto
    • GetDataDto
    • PatchPriorityDto
    • ReprocessDto
    • PendingResponseDto
    • IntegrationDTO
    • String
    • LegacyGetAttachsDto
  1. Documents Manager

Stream a structured export of document data (JSON or CSV) — small volumes only

HOM
https://hom.roit.ai
HOM
https://hom.roit.ai
GET
/assembler-documents-manager/api/v1/export/data-manager
Streams a file download containing document data. Subject to 30s gateway timeout. For large exports use POST /export/data-manager/queue instead.

Request

Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://hom.roit.ai/assembler-documents-manager/api/v1/export/data-manager?fields=fileInternalId&fields=documentValue&fields=providerNationalRegister&format=csv&exportMode=document&documentType=nfe&fieldLabels=ID%20do%20Documento%2CNome%20do%20Arquivo&integrationDateFrom=2024-01-01&integrationDateTo=2024-12-31&uploadDateFrom=2024-01-01&uploadDateTo=2024-12-31&issueDateFrom=2024-01-01&issueDateTo=2024-12-31&providerCnpj=12345678000100&beneficiaryCnpj=98765432000199&stage=FINALIZED&finalized=true&isConsolidated=true' \
--header 'Authorization;'

Responses

🟢200OK
Streamed CSV or JSON file
This response does not have a body.
🟠400Bad Request
🟠401Unauthorized
Modified at 2026-07-06 22:06:05
Previous
Export structured document data processed in the Pipeline
Next
Queue an async export job — returns jobId immediately
Built with