Queue an async export job — returns jobId immediately

HOM

https://hom.roit.ai

POST

/assembler-documents-manager/api/v1/export/data-manager/queue

Creates a background export job processed by the worker. Poll GET /export/data-manager/job/:jobId for status and download URL.

Request

Header Params

Body Params application/jsonRequired

Example

{
    "fields": [
        "fileInternalId",
        "documentValue",
        "providerNationalRegister"
    ],
    "format": "json",
    "exportMode": "document",
    "documentType": "nfe",
    "fieldLabels": "ID do Documento,Nome do Arquivo",
    "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": "SENT",
    "finalized": "true",
    "isConsolidated": "true"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://hom.roit.ai/assembler-documents-manager/api/v1/export/data-manager/queue' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
    "fields": [
        "fileInternalId",
        "documentValue",
        "providerNationalRegister"
    ],
    "format": "json",
    "exportMode": "document",
    "documentType": "nfe",
    "fieldLabels": "ID do Documento,Nome do Arquivo",
    "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": "SENT",
    "finalized": "true",
    "isConsolidated": "true"
}'

Responses

🟢201Created

{ jobId: string }

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

Modified at 2026-07-06 22:06:05

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

Poll the status of an async export job