PUBLIC SERVICES [PROD]
  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
    • 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
  1. Documents Manager

Create document export request

HOM
https://hom.roit.ai
HOM
https://hom.roit.ai
POST
/assembler-documents-manager/api/v1/export/requests

Request

Header Params

Body Params application/jsonRequired

Example
Request example
{
    "master": "anyMasterId",
    "preference": "original",
    "filters": {
        "type": {
            "in": [
                ".xml",
                ".pdf"
            ]
        },
        "createAt": {
            "gte": "2025-01-10T03:00:00.000Z"
        },
        "issueDate": {
            "lte": "2025-01-10T03:00:00.000Z"
        },
        "entryDate": {
            "gte": "2025-01-10T03:00:00.000Z"
        },
        "clientTree": [
            {
                "group": {
                    "eq": "1234567890"
                },
                "company": {
                    "eq": "1234567890"
                },
                "identifier": {
                    "eq": "1234567890"
                }
            }
        ],
        "classification": {
            "in": [
                "/fiscal/nfe",
                "/fiscal/cte"
            ]
        },
        "step": {
            "in": [
                "COMPLEMENTATION"
            ]
        },
        "origin": {
            "nin": [
                "SITE",
                "FORMS"
            ]
        },
        "isConsolidated": {
            "eq": false
        },
        "finalized": {
            "eq": false
        },
        "originCity": {
            "in": [
                "12345",
                "67890"
            ]
        },
        "destinyCity": {
            "in": [
                "12345",
                "67890"
            ]
        },
        "number": {
            "gte": "100"
        },
        "totalValue": {
            "gte": 100,
            "lte": 10000
        },
        "internalId": {
            "in": [
                "docId1",
                "docId2",
                "docId3"
            ]
        },
        "serviceMadeCity": {
            "in": [
                "12345",
                "67890"
            ]
        },
        "supplierDocumentNumber": {
            "in": [
                "1234567890"
            ]
        },
        "hasIssRetention": {
            "eq": true
        },
        "accessKey": {
            "eq": "accessKey123"
        },
        "purchaseOrder": {
            "in": [
                "purchaseOrder123",
                "purchaseOrder456"
            ]
        },
        "moviment": {
            "in": [
                "movementType12345",
                "movementType67890"
            ]
        },
        "classTypeEvent": {
            "eq": "eventType123"
        },
        "message": {
            "eq": "message123"
        }
    }
}

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 --request POST 'https://hom.roit.ai/assembler-documents-manager/api/v1/export/requests' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "master": "anyMasterId",
    "preference": "original",
    "filters": {
        "type": {
            "in": [
                ".xml",
                ".pdf"
            ]
        },
        "createAt": {
            "gte": "2025-01-10T03:00:00.000Z"
        },
        "issueDate": {
            "lte": "2025-01-10T03:00:00.000Z"
        },
        "entryDate": {
            "gte": "2025-01-10T03:00:00.000Z"
        },
        "clientTree": [
            {
                "group": {
                    "eq": "1234567890"
                },
                "company": {
                    "eq": "1234567890"
                },
                "identifier": {
                    "eq": "1234567890"
                }
            }
        ],
        "classification": {
            "in": [
                "/fiscal/nfe",
                "/fiscal/cte"
            ]
        },
        "step": {
            "in": [
                "COMPLEMENTATION"
            ]
        },
        "origin": {
            "nin": [
                "SITE",
                "FORMS"
            ]
        },
        "isConsolidated": {
            "eq": false
        },
        "finalized": {
            "eq": false
        },
        "originCity": {
            "in": [
                "12345",
                "67890"
            ]
        },
        "destinyCity": {
            "in": [
                "12345",
                "67890"
            ]
        },
        "number": {
            "gte": "100"
        },
        "totalValue": {
            "gte": 100,
            "lte": 10000
        },
        "internalId": {
            "in": [
                "docId1",
                "docId2",
                "docId3"
            ]
        },
        "serviceMadeCity": {
            "in": [
                "12345",
                "67890"
            ]
        },
        "supplierDocumentNumber": {
            "in": [
                "1234567890"
            ]
        },
        "hasIssRetention": {
            "eq": true
        },
        "accessKey": {
            "eq": "accessKey123"
        },
        "purchaseOrder": {
            "in": [
                "purchaseOrder123",
                "purchaseOrder456"
            ]
        },
        "moviment": {
            "in": [
                "movementType12345",
                "movementType67890"
            ]
        },
        "classTypeEvent": {
            "eq": "eventType123"
        },
        "message": {
            "eq": "message123"
        }
    }
}'

Responses

🟢200OK
application/json
Success response
Body

Example
{
    "timestamp": 1234567890,
    "status": "success",
    "data": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "user": {
            "id": "string",
            "name": "string",
            "email": "string"
        },
        "master": "anyMasterId",
        "period": {
            "from": "2024-03-01",
            "to": "2024-03-31"
        },
        "quantity": 0,
        "size": 0,
        "status": "pending",
        "preference": "original",
        "filters": {
            "type": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "createAt": {
                "gte": "2025-01-10T03:00:00.000Z"
            },
            "issueDate": {
                "gte": "2025-01-10T03:00:00.000Z"
            },
            "entryDate": {
                "gte": "2025-01-10T03:00:00.000Z"
            },
            "clientTree": [
                {
                    "group": {
                        "in": [
                            "1234567890"
                        ]
                    },
                    "company": {
                        "in": [
                            "1234567890"
                        ]
                    },
                    "identifier": {
                        "in": [
                            "1234567890"
                        ]
                    }
                }
            ],
            "classification": {
                "in": [
                    "/fiscal/nfe",
                    "/fiscal/cte"
                ]
            },
            "step": {
                "in": [
                    "COMPLEMENTATION"
                ]
            },
            "origin": {
                "nin": [
                    "SITE",
                    "FORMS"
                ]
            },
            "isConsolidated": {
                "eq": false
            },
            "finalized": {
                "eq": false
            },
            "originCity": {
                "in": [
                    "12345",
                    "67890"
                ]
            },
            "destinyCity": {
                "in": [
                    "12345",
                    "67890"
                ]
            },
            "number": {
                "gte": "100"
            },
            "totalValue": {
                "gte": 100,
                "lte": 10000
            },
            "internalId": {
                "in": [
                    "docId1",
                    "docId2",
                    "docId3"
                ]
            },
            "serviceMadeCity": {
                "in": [
                    "12345",
                    "67890"
                ]
            },
            "supplierDocumentNumber": {
                "in": [
                    "1234567890"
                ]
            },
            "hasIssRetention": {
                "eq": true
            },
            "accessKey": {
                "eq": "accessKey123"
            },
            "purchaseOrder": {
                "in": [
                    "purchaseOrder123",
                    "purchaseOrder456"
                ]
            },
            "moviment": {
                "in": [
                    "INPUT",
                    "OUTPUT"
                ]
            },
            "classTypeEvent": {
                "eq": "eventType123"
            },
            "message": {
                "eq": "message123"
            }
        },
        "totalOfParts": 0,
        "totalOfPartsProcessed": 0
    },
    "message": "Request received successfully"
}
🟠400Bad Request
🟠401Unauthorized
Modified at 2026-02-24 17:27:50
Previous
Generate a token to access ROIT APIs
Next
Get export request by id
Built with