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
    • External System Integration
      • Get pending entities to be integrated
      • Register delivery integration
      • Update integration status
      • Get all documents attached to a request
    • Upload Document
      • Upload document as base64
  • Tax Reform
    • Data Integration
      • Create Request
      • Update Request Status
      • Generate Signed Url
  • External System Integration
    • Reprocess a specific request
      POST
  1. Documents Manager

Create document export request

HOM
HOM
POST
/assembler-documents-manager/api/v1/export/requests
Export

Request

Header Params
Authorization
string 
optional
token generated
Body Params application/json
master
string 
required
Master identifier
Example:
e9a0b1e5a71308a4d66e9f10fh851c5d
preference
enum<string> 
required
Preference
Allowed values:
roitoriginal
Default:
original
Example:
original
filters
object (BaseFiltersModel) 
required
type
object 
required
Query operators to search by extension of the file. Example: .jpg, .xml, .pdf ...
Example:
{"in":[".xml",".pdf"]}
createAt
object 
required
Query operators to search by createAt attribute. createAt is when the file first appeared on smart flow
Example:
{"gte":"2025-01-10T03:00:00.000Z"}
issueDate
object 
required
Query operators to search by issue date of the file
Example:
{"gte":"2025-01-10T03:00:00.000Z"}
entryDate
object 
required
Query operators to search by entry date of the file
Example:
{"gte":"2025-01-10T03:00:00.000Z"}
clientTree
array[object (ClientTreeFilter) {3}] 
optional
Query operators to search by client tree attributes
classification
object 
optional
Query operators to search by classification of the file
Example:
{"in":["/fiscal/nfe","/fiscal/cte"]}
step
object 
optional
Query operators to search by step of the file
Example:
{"in":["COMPLEMENTATION"]}
origin
object 
optional
Query operators to search by origin of the file
Example:
{"nin":["SITE","FORMS"]}
isConsolidated
object 
optional
Query operators to search by isConslidated. Finalized equals true means the process is in processed documents
Example:
{"eq":false}
finalized
object 
optional
Query operators to search by finalized attribute. Finalized equals true means the process already finished
Example:
{"eq":false}
originCity
object 
optional
Query operators to search by the city of the issuer. Example: for CURITIBA use the code 4106902
Example:
{"in":["4106902"]}
destinyCity
object 
optional
Query operators to search by the city of the provider. Example: for CURITIBA use the code 4106902
Example:
{"in":["4106902"]}
number
object 
optional
Query operators to search by invoice number on string format
Example:
{"gte":"100"}
totalValue
object 
optional
Query operators to search by total value shown on smart flow
Example:
{"gte":100,"lte":10000}
internalId
object 
optional
Query operators to search by document id
Example:
{"in":["b12fd1dc-c637-48b8-m33l-3g77ppgf98de","b18e8b09-96e3-442e-mab6l-b91a7b","878132e0-c7fe-4668-m86el-9f702c"]}
serviceMadeCity
object 
optional
Query operators to search by the city that the service was provided. Example: for CURITIBA use the code 4106902
Example:
{"in":["1200708","2700409"]}
supplierDocumentNumber
object 
optional
Query operators to search by supplier national register on string format
Example:
{"in":["36589547852145"]}
hasIssRetention
object 
optional
Query operators to search by hasIssRetention on boolean format
Example:
{"eq":true}
accessKey
object 
optional
Query operators to search by accessKey in a given range
purchaseOrder
object 
optional
Query operators to search by purchaseOrder that exists in an array
movement
object 
optional
Query operators to search by movement type
classTypeEvent
object 
optional
Query operators to search by event type inside classType
message
object 
optional
Query operators to search by messages
Example
{
  "master": "e9a0b1e5a71308a4d66e9f10fh851c5d",
  "preference": "original",
  "filters": {
    "type": {
      "in": {
        "0": ".xml",
        "1": ".pdf",
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "createAt": {
      "gte": {
        "gte": 75
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "issueDate": {
      "gte": {
        "gte": 75
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "entryDate": {
      "gte": {
        "gte": 75
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "clientTree": [
      {
        "group": {
          "in": {
            "0": "1234567890",
            "in": [
              ".xml",
              ".pdf"
            ]
          },
          "eq": {
            "eq": 30
          },
          "ne": {
            "ne": 30
          },
          "gt": {
            "gt": 100
          },
          "lt": {
            "lt": 50
          },
          "gte": {
            "gte": 75
          },
          "lte": {
            "lte": 20
          },
          "nin": {
            "nin": [
              ".xml",
              ".pdf"
            ]
          },
          "contains": {
            "contains": "admin"
          }
        },
        "company": {
          "in": {
            "0": "1234567890",
            "in": [
              ".xml",
              ".pdf"
            ]
          },
          "eq": {
            "eq": 30
          },
          "ne": {
            "ne": 30
          },
          "gt": {
            "gt": 100
          },
          "lt": {
            "lt": 50
          },
          "gte": {
            "gte": 75
          },
          "lte": {
            "lte": 20
          },
          "nin": {
            "nin": [
              ".xml",
              ".pdf"
            ]
          },
          "contains": {
            "contains": "admin"
          }
        },
        "identifier": {
          "in": {
            "0": "1234567890",
            "in": [
              ".xml",
              ".pdf"
            ]
          },
          "eq": {
            "eq": 30
          },
          "ne": {
            "ne": 30
          },
          "gt": {
            "gt": 100
          },
          "lt": {
            "lt": 50
          },
          "gte": {
            "gte": 75
          },
          "lte": {
            "lte": 20
          },
          "nin": {
            "nin": [
              ".xml",
              ".pdf"
            ]
          },
          "contains": {
            "contains": "admin"
          }
        }
      }
    ],
    "classification": {
      "in": {
        "0": "/fiscal/nfe",
        "1": "/fiscal/cte",
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "step": {
      "in": {
        "0": "COMPLEMENTATION",
        "in": [
          "COMPLEMENTATION"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "origin": {
      "nin": {
        "0": "SITE",
        "1": "FORMS",
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "isConsolidated": {
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "finalized": {
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "originCity": {
      "in": {
        "0": "4106902",
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "destinyCity": {
      "in": {
        "0": "4106902",
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "number": {
      "gte": {
        "gte": 75
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "totalValue": {
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "internalId": {
      "in": {
        "0": "b12fd1dc-c637-48b8-m33l-3g77ppgf98de",
        "1": "b18e8b09-96e3-442e-mab6l-b91a7b",
        "2": "878132e0-c7fe-4668-m86el-9f702c",
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "serviceMadeCity": {
      "in": {
        "0": "1200708",
        "1": "2700409",
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "supplierDocumentNumber": {
      "in": {
        "0": "36589547852145",
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "hasIssRetention": {
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "accessKey": {
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "purchaseOrder": {
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "movement": {
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "classTypeEvent": {
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    },
    "message": {
      "eq": {
        "eq": 30
      },
      "ne": {
        "ne": 30
      },
      "gt": {
        "gt": 100
      },
      "lt": {
        "lt": 50
      },
      "gte": {
        "gte": 75
      },
      "lte": {
        "lte": 20
      },
      "in": {
        "in": [
          ".xml",
          ".pdf"
        ]
      },
      "nin": {
        "nin": [
          ".xml",
          ".pdf"
        ]
      },
      "contains": {
        "contains": "admin"
      }
    }
  }
}

Request 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 'Content-Type: application/json' \
--data-raw '{
    "master": "e9a0b1e5a71308a4d66e9f10fh851c5d",
    "preference": "original",
    "filters": {
        "type": {
            "in": {
                "0": ".xml",
                "1": ".pdf",
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "createAt": {
            "gte": {
                "gte": 75
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "issueDate": {
            "gte": {
                "gte": 75
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "entryDate": {
            "gte": {
                "gte": 75
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "clientTree": [
            {
                "group": {
                    "in": {
                        "0": "1234567890",
                        "in": [
                            ".xml",
                            ".pdf"
                        ]
                    },
                    "eq": {
                        "eq": 30
                    },
                    "ne": {
                        "ne": 30
                    },
                    "gt": {
                        "gt": 100
                    },
                    "lt": {
                        "lt": 50
                    },
                    "gte": {
                        "gte": 75
                    },
                    "lte": {
                        "lte": 20
                    },
                    "nin": {
                        "nin": [
                            ".xml",
                            ".pdf"
                        ]
                    },
                    "contains": {
                        "contains": "admin"
                    }
                },
                "company": {
                    "in": {
                        "0": "1234567890",
                        "in": [
                            ".xml",
                            ".pdf"
                        ]
                    },
                    "eq": {
                        "eq": 30
                    },
                    "ne": {
                        "ne": 30
                    },
                    "gt": {
                        "gt": 100
                    },
                    "lt": {
                        "lt": 50
                    },
                    "gte": {
                        "gte": 75
                    },
                    "lte": {
                        "lte": 20
                    },
                    "nin": {
                        "nin": [
                            ".xml",
                            ".pdf"
                        ]
                    },
                    "contains": {
                        "contains": "admin"
                    }
                },
                "identifier": {
                    "in": {
                        "0": "1234567890",
                        "in": [
                            ".xml",
                            ".pdf"
                        ]
                    },
                    "eq": {
                        "eq": 30
                    },
                    "ne": {
                        "ne": 30
                    },
                    "gt": {
                        "gt": 100
                    },
                    "lt": {
                        "lt": 50
                    },
                    "gte": {
                        "gte": 75
                    },
                    "lte": {
                        "lte": 20
                    },
                    "nin": {
                        "nin": [
                            ".xml",
                            ".pdf"
                        ]
                    },
                    "contains": {
                        "contains": "admin"
                    }
                }
            }
        ],
        "classification": {
            "in": {
                "0": "/fiscal/nfe",
                "1": "/fiscal/cte",
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "step": {
            "in": {
                "0": "COMPLEMENTATION",
                "in": [
                    "COMPLEMENTATION"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "origin": {
            "nin": {
                "0": "SITE",
                "1": "FORMS",
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "isConsolidated": {
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "finalized": {
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "originCity": {
            "in": {
                "0": "4106902",
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "destinyCity": {
            "in": {
                "0": "4106902",
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "number": {
            "gte": {
                "gte": 75
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "totalValue": {
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "internalId": {
            "in": {
                "0": "b12fd1dc-c637-48b8-m33l-3g77ppgf98de",
                "1": "b18e8b09-96e3-442e-mab6l-b91a7b",
                "2": "878132e0-c7fe-4668-m86el-9f702c",
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "serviceMadeCity": {
            "in": {
                "0": "1200708",
                "1": "2700409",
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "supplierDocumentNumber": {
            "in": {
                "0": "36589547852145",
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "hasIssRetention": {
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "accessKey": {
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "purchaseOrder": {
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "movement": {
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "classTypeEvent": {
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        },
        "message": {
            "eq": {
                "eq": 30
            },
            "ne": {
                "ne": 30
            },
            "gt": {
                "gt": 100
            },
            "lt": {
                "lt": 50
            },
            "gte": {
                "gte": 75
            },
            "lte": {
                "lte": 20
            },
            "in": {
                "in": [
                    ".xml",
                    ".pdf"
                ]
            },
            "nin": {
                "nin": [
                    ".xml",
                    ".pdf"
                ]
            },
            "contains": {
                "contains": "admin"
            }
        }
    }
}'

Responses

🟢200OK
application/json
Body
timestamp
number 
optional
status
string 
optional
message
string 
optional
data
object (ExportRequestModel) 
optional
id
string 
optional
user
object (UserContextModel) 
optional
master
string 
required
period
object 
required
Default:
{"from":"","to":""}
quantity
number 
required
size
number 
required
Default:
0
status
enum<string> 
required
Allowed values:
doneprocessingexpirederrorpending
Default:
pending
preference
enum<string> 
required
Allowed values:
roitoriginal
Default:
original
filters
object (BaseFiltersModel) 
optional
totalOfParts
number 
required
Default:
0
totalOfPartsProcessed
number 
required
Default:
0
Example
{
  "timestamp": 0,
  "status": "string",
  "message": "string",
  "data": {
    "id": "string",
    "user": {
      "id": "string",
      "name": "string",
      "email": "string"
    },
    "master": "string",
    "period": {
      "from": "string",
      "to": "string"
    },
    "quantity": 0,
    "size": 0,
    "status": "pending",
    "preference": "original",
    "filters": {
      "type": {
        "in": {
          "0": ".xml",
          "1": ".pdf",
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "createAt": {
        "gte": {
          "gte": 75
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "issueDate": {
        "gte": {
          "gte": 75
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "entryDate": {
        "gte": {
          "gte": 75
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "clientTree": [
        {
          "group": {
            "in": {
              "0": "1234567890",
              "in": [
                ".xml",
                ".pdf"
              ]
            },
            "eq": {
              "eq": 30
            },
            "ne": {
              "ne": 30
            },
            "gt": {
              "gt": 100
            },
            "lt": {
              "lt": 50
            },
            "gte": {
              "gte": 75
            },
            "lte": {
              "lte": 20
            },
            "nin": {
              "nin": [
                ".xml",
                ".pdf"
              ]
            },
            "contains": {
              "contains": "admin"
            }
          },
          "company": {
            "in": {
              "0": "1234567890",
              "in": [
                ".xml",
                ".pdf"
              ]
            },
            "eq": {
              "eq": 30
            },
            "ne": {
              "ne": 30
            },
            "gt": {
              "gt": 100
            },
            "lt": {
              "lt": 50
            },
            "gte": {
              "gte": 75
            },
            "lte": {
              "lte": 20
            },
            "nin": {
              "nin": [
                ".xml",
                ".pdf"
              ]
            },
            "contains": {
              "contains": "admin"
            }
          },
          "identifier": {
            "in": {
              "0": "1234567890",
              "in": [
                ".xml",
                ".pdf"
              ]
            },
            "eq": {
              "eq": 30
            },
            "ne": {
              "ne": 30
            },
            "gt": {
              "gt": 100
            },
            "lt": {
              "lt": 50
            },
            "gte": {
              "gte": 75
            },
            "lte": {
              "lte": 20
            },
            "nin": {
              "nin": [
                ".xml",
                ".pdf"
              ]
            },
            "contains": {
              "contains": "admin"
            }
          }
        }
      ],
      "classification": {
        "in": {
          "0": "/fiscal/nfe",
          "1": "/fiscal/cte",
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "step": {
        "in": {
          "0": "COMPLEMENTATION",
          "in": [
            "COMPLEMENTATION"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "origin": {
        "nin": {
          "0": "SITE",
          "1": "FORMS",
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "isConsolidated": {
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "finalized": {
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "originCity": {
        "in": {
          "0": "4106902",
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "destinyCity": {
        "in": {
          "0": "4106902",
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "number": {
        "gte": {
          "gte": 75
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "totalValue": {
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "internalId": {
        "in": {
          "0": "b12fd1dc-c637-48b8-m33l-3g77ppgf98de",
          "1": "b18e8b09-96e3-442e-mab6l-b91a7b",
          "2": "878132e0-c7fe-4668-m86el-9f702c",
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "serviceMadeCity": {
        "in": {
          "0": "1200708",
          "1": "2700409",
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "supplierDocumentNumber": {
        "in": {
          "0": "36589547852145",
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "hasIssRetention": {
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "accessKey": {
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "purchaseOrder": {
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "movement": {
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "classTypeEvent": {
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      },
      "message": {
        "eq": {
          "eq": 30
        },
        "ne": {
          "ne": 30
        },
        "gt": {
          "gt": 100
        },
        "lt": {
          "lt": 50
        },
        "gte": {
          "gte": 75
        },
        "lte": {
          "lte": 20
        },
        "in": {
          "in": [
            ".xml",
            ".pdf"
          ]
        },
        "nin": {
          "nin": [
            ".xml",
            ".pdf"
          ]
        },
        "contains": {
          "contains": "admin"
        }
      }
    },
    "totalOfParts": 0,
    "totalOfPartsProcessed": 0
  }
}
Modified at 2025-03-24 21:19:55
Previous
Generate a token to access ROIT APIs
Next
Get export request by id
Built with