PUBLIC SERVICES [PROD]
    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
        • 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
        • Register delivery integration
        • Get pending entities to be integrated
        • 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
      • Data Sync
        • Sync data
    • Schemas
      • Schemas
        • ForgotPasswordDTO
        • nationalRegisterGeneric
        • ProcessUpload
        • CompanyDTO
        • Date
        • TransitionalTokenResponseDTO
        • InstallmentDetailsModel
        • QueryOperatorFormat
        • LoginDTO
        • FileUploadBase64DTO
        • CurrencyDTO
        • QueryOperators
        • CustomTokenResponseDTO
        • ValueDTO
        • QueryOperatorStep
        • RefreshTokenResponseDTO
        • AccountPayableMetadataDTO
        • RefreshTokenDTO
        • ReceiptModel
        • AuthorizationTokenResponseDTO
        • costCenterGeneric
        • CanceledAccountPayableUser
        • DocumentTributeDTO
        • UserInfoDTO
        • CanceledAccountPayable
        • CreateTokenDTO
        • Status
        • PaymentPurpose
        • TokenSuccessResponseDTO
        • IsLocked
        • TokenErrorResponseDTO
        • PublicCreateTokenDTO
        • AccountPayableTaxDataModel
        • ChangeAuthPasswordDTO
        • AccountPayable
        • RedefinePasswordDTO
        • BarcodeDetailDTO
        • Object
        • CreateMfaResponseDTO
        • BankAccountDTO
        • CreateMfaDTO
        • PixDetailDTO
        • ActiveMfaDto
        • TedDetailDTO
        • SendMfaVerificationDTO
        • AbstractPaymentDetailDTO
        • VerifyTokenResponseDTO
        • TaxWithBarcodeDetailDTO
        • AddMfaTypeDTO
        • TableMetadata
        • DARFDetailDTO
        • SetDefaultTypeDTO
        • DARJDetailDTO
        • QrCodeDTO
        • DPVATDetailDTO
        • OidcInterceptorDTO
        • GAREDetailDTO
        • HeaderResponse
        • UserIdDTO
        • IPVADetailDTO
        • MfaMyOptionsResponseDTO
        • LicensingDetailDTO
        • CreateTrustedDeviceDTO
        • SimpleDARFDetailDTO
        • AuthorizationGenerationDTO
        • CteCargoQuantityDetail
        • PayrollDetailDTO
        • ServerToServerTokenResponseDTO
        • InstallmentDTO
        • MfaDTO
        • CteTomadorDto
        • PaymentPurposeDTO
        • TenantResponseDTO
        • AccountPayableTaxDataDTO
        • UserTenantResponseDTO
        • AccountPayableDTO
        • OutputTenantDTO
        • UserDetailDTO
        • CreateTokenResponseDTO
        • AccountPayableUpdateDTO
        • CreateTokenRequestDTO
        • AccountPayableUpdateStatusMetadataModel
        • ImpersonateUserDTO
        • 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
      • NationalRegisterGeneric
      • BaseResponse
      • AuditBigQueryRequest
      • DocumentFileDTO
      • AccountsPayableDto
      • Period
      • AddresGeneric
      • DocumentType
      • CreateResponse
      • AuditBigQueryResponse
      • DocumentFileErpDTO
      • SyncRequest
      • HeaderModel
      • BusinessPartner
      • ProviderGeneric
      • Error
      • CreateResponseData
      • DeleteResponse
      • DataBaseDest
      • AuditBigQueryResponseData
      • DocumentAddressDTO
      • SyncResponse
      • LinkModel
      • PurchaseItem
      • NfeModalityDto
      • HTTPValidationError
      • DeleteResponseData
      • AccountsPayableHeaderDto
      • AuditStorageRequest
      • DocumentPartyDTO
      • SyncResponseData
      • CostCenter
      • PaymentMethod
      • NfeDocumentHeaderDto
      • SignedUrlRequest
      • HolderDto
      • AuditStorageResponse
      • DocumentServiceDTO
      • ItemParentModel
      • PurchaseOrderDto
      • ClientTreeFilter
      • NfeTaxDto
      • CostCenterGeneric
      • Type
      • GetResponse
      • AuditStorageResponseData
      • DocumentCpomDTO
      • Tribute
      • Contact
      • BaseFiltersModel
      • UpdateStatusRequest
      • CreateRequestSuccessResponse
      • ProcessStatus
      • GetResponseData
      • AccountsPayableResponseDto
      • ItemModel
      • Address
      • ExportRequestModel
      • NfeItemDto
      • ValidationError
      • SignedUrlResponse
      • GenericErrorResponse
      • AccountsPayableModelResponse
      • DocumentTransportDTO
      • ServiceLocation
      • BankAccount
      • CreateRequestDTO
      • NfeDto
      • GenericUnauthorizedResponse
      • ListResponse
      • DocumentPaymentDTO
      • TaxModel
      • Branch
      • Array
      • NfeResponseDto
      • UpdateResponse
      • ListResponseData
      • DocumentTotalResumeDTO
      • DocumentCteCityDTO
      • DocumentModel
      • AdditionalInfos
      • ProcessRequestDTO
      • NfeModelResponse
      • UpdateResponseData
      • PaginationData
      • DecryptFilesRequest
      • DocumentCteProtocolDTO
      • GenericModel
      • SupplierDto
      • ExportRequestFileModel
      • GenericHeaderModel
      • NfseDocumentHeaderDto
      • GenericSuccessResponse
      • DecryptFilesResponse
      • DocumentCteQuantityInformationDTO
      • EntityRequestModel
      • TaxDto
      • Blob
      • NfseTax
      • RequestItem
      • DecryptFilesResponseData
      • DocumentCteCargoDetailsDTO
      • TaxCodeDto
      • ZipProcessorDTO
      • ItemNfseDto
      • GetAllRequestItemSuccessResponse
      • DecryptedFileInfo
      • DocumentCteServiceComplementationDTO
      • PendingDto
      • TaxCodeIrfDto
      • ClientTreeOption
      • NfseDto
      • RequestActionUserDTO
      • EntityStatusModel
      • CostCenterDto
      • Additional
      • NfseResponseDto
      • SignedUrlResponseData
      • FileActionHistoryDTO
      • UpdateStatusDto
      • PaymentConditionDto
      • ExportFiltersModel
      • NfseModelResponse
      • EntityTimelineModel
      • ItemDto
      • CreateExportFiltersDTO
      • ConsumptionBillDocumentHeaderDto
      • Table
      • GetDataResponseDto
      • FinancialNatureDto
      • UpdateExportFiltersDTO
      • ItemGeneric
      • PatchPriorityDto
      • InvoiceItem
      • SourceData
      • ConsumptionBillDto
      • PendingResponseDto
      • OutboundInvoiceDto
      • ConsumptionBillResponseDto
      • IntegrationDTO
      • DeliveryAuthorizationItem
      • ConsumptionBillModelResponse
      • DocumentResponseDTO
      • String
      • DeliveryAuthorizationDto
      • CteCityDto
      • PaginatedDocumentsResponseDTO
      • DeliveryDto
      • BlindReviewItem
      • CteTributesDto
      • LegacyDeliveryDTO
      • BlindReviewDto
      • CteShippingDto
      • EventHubDTO
      • GoodsThirdPartyDto
      • CteCargoDetailsDto
      • DeliverySuccessResponseDto
      • DeliveryBadRequestResponseDto
      • CteDocumentHeaderDto
      • DeliveryUnauthorizedResponseDto
      • IdentificationModel
      • CteDto
      • ItemCategorizationModel
      • CteResponseDto
      • CteModelResponse
      • CnaeCode
      • LegalNature
      • SupplierData
      • SupplierContent
      • SupplierResponseDto
      • SupplierModelResponse
      • FileDto
      • DateModel
      • AttachsDto
      • LegacyGetAttachsDto
      • GetDataDto
      • UpdateStatusResponseDto
      • ManifestationStatusModel
      • ManifestationModel
      • PatchTranslatedDataDto
      • ReprocessDto
      • Entity

    Introduction

    ROIT Public APIs#

    Welcome to the Invoice-To-Pay portal! This guide will help you integrate ROIT's public APIs with your system quickly and efficiently.

    Available Environments#

    We currently offer two environments for interacting with our APIs:
    1.
    Homologation (hom): A staging environment used for validation before moving to production.
    2.
    Production (app): The live environment accessed by end users.
    Base URL:
    https://<env>.roit.ai
    To use the APIs, replace <env> with the corresponding environment identifier (hom or app).
    Example:
    https://app.roit.ai/service/api/v1/document/status

    Authentication#

    Generate token#

    All our endpoints are authenticated using a JWT (JSON Web Token Authentication) token, which is valid for 8 hours after its generation.
    To generate a token, you can use the following endpoint, you will need to provide your apiToken available at ROIT ADMIN section:
    Access the authentication request documentation here
    Modified at 2025-03-31 12:42:21
    Next
    Document Management
    Built with