PUBLIC SERVICES [PROD]
  1. External System Integration
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
    • External System Integration
      • Register delivery integration
        POST
      • Get pending entities to be integrated
        POST
      • Update integration status
        POST
      • Get all documents attached to a request
        POST
      • Reprocess a specific request
        POST
    • Upload Document
      • Upload document as base64
  • Tax Reform
    • Data Integration
      • Create a new request
      • Update request status
      • List requests
      • Get request by ID
      • List Requests
      • Update request by ID
      • Delete request by ID
      • Generate signed URL
      • Process callback
  1. External System Integration

Get pending entities to be integrated

HOM
https://hom.roit.ai
HOM
https://hom.roit.ai
POST
/ibs-core-entrypoint/api/v1/entrypoint/requests/pending
The document payloads in the response can be customized according to the requester's needs. Please contact our team for analysis and planning of the required adjustments.

Request

Header Params
Authorization
string 
required
token generated
Body Params application/json
entity
enum<string> 
required
Entity to be integrated
Allowed values:
DOCUMENTACCOUNTS_PAYABLEPURCHASE_ORDERERP_PARAMSSUPPLIERGENERICTAX_VALIDATIONDOCUMENT_REVERSESERVICE_ENTRY_SHEET
Example:
DOCUMENT
integrationId
string 
required
Integration ID
Example:
9876c5d4-ba32-1098-7654-321f98765432
type
string 
optional
Type of entity, if not provided, all types will be returned
Example:
NFE
Examples
Get pending NFE documents
{
    "entity": "DOCUMENT",
    "integrationId": "9876c5d4-ba32-1098-7654-321f98765432",
    "type": "NFE"
}

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
curl --location --request POST 'https://hom.roit.ai/ibs-core-entrypoint/api/v1/entrypoint/requests/pending' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entity": "DOCUMENT",
    "integrationId": "9876c5d4-ba32-1098-7654-321f98765432",
    "type": "NFE"
}'

Responses

🟢201Created
application/json
Document responses
Body
optional
One of
timestamp
number 
required
timestamp
Example:
1717171717171
message
string 
required
message
Example:
Request received successfully
status
string 
required
status
Example:
success
data
array[object (NfeResponseDto) {2}] 
required
List of pending NFe documents
Example:
[{"header":{"nationalRegister":"93293146000153"},"documents":[{"requestId":"1234567890","reference":"1234567890","file":"NFe.xml","nationalRegister":"93293146000153","type":"NFE","header":{"accessKey":"1234567890543129867564538762198736451238413","documentTotalValue":"1000.00","series":"1","number":"123456","postingDate":"2024-03-08T00:00:00.000Z","issueDate":"2024-03-08T00:00:00.000Z","dueDate":"2024-04-08T00:00:00.000Z","shipping":{"modality":"3","value":"100"},"authorizationCode":"1234567890543129867564538762198736451238413"},"items":[{"purchaseNumber":"7504120","purchaseItem":"01","code":"XYZ123","costCenter":{"code":"01.02"},"quantity":"10","unityValue":"100.00","totalValue":"1000.00","unitMeasurement":"UN","ncm":"98765432","ean":"9876543210123","cfop":"1234","taxes":[{"name":"ICMS","base":12234.68,"aliquot":0.1,"value":25}]}],"provider":{"nationalRegister":"93293146000153","name":"Empresa Exemplo","personType":"CNPJ","cityUniqueCode":"3452314","address":{"street":"Rua das Flores","number":"123","zipCode":"71745800","city":"SC#o Paulo","cityUniqueCode":"3452314","complement":"Apto 123","state":"SP","district":"Bairro das Flores"}}}]}]
Examples
{
    "timestamp": 1709913600000,
    "message": "Success",
    "status": "OK",
    "data": [
        {
            "header": {
                "nationalRegister": "93293146000153"
            },
            "documents": [
                {
                    "requestId": "1234567890",
                    "reference": "1234567890",
                    "file": "NFe.xml",
                    "nationalRegister": "93293146000153",
                    "type": "NFE",
                    "header": {
                        "accessKey": "1234567890543129867564538762198736451238413",
                        "documentTotalValue": "1000.00",
                        "series": "1",
                        "number": "123456",
                        "postingDate": "2024-03-08T00:00:00.000Z",
                        "issueDate": "2024-03-08T00:00:00.000Z",
                        "dueDate": "2024-04-08T00:00:00.000Z",
                        "shipping": {
                            "modality": "3",
                            "value": "100"
                        },
                        "authorizationCode": "1234567890543129867564538762198736451238413"
                    },
                    "items": [
                        {
                            "purchaseNumber": "7504120",
                            "purchaseItem": "01",
                            "code": "XYZ123",
                            "costCenter": {
                                "code": "01.02"
                            },
                            "quantity": "10",
                            "unityValue": "100.00",
                            "totalValue": "1000.00",
                            "unitMeasurement": "UN",
                            "ncm": "98765432",
                            "ean": "9876543210123",
                            "cfop": "1234",
                            "taxes": [
                                {
                                    "name": "ICMS",
                                    "base": 12234.68,
                                    "aliquot": 0.1,
                                    "value": 25
                                }
                            ]
                        }
                    ],
                    "provider": {
                        "nationalRegister": "93293146000153",
                        "name": "Empresa Exemplo",
                        "personType": "CNPJ",
                        "cityUniqueCode": "3452314",
                        "address": {
                            "street": "Rua das Flores",
                            "number": "123",
                            "zipCode": "71745800",
                            "city": "SC#o Paulo",
                            "cityUniqueCode": "3452314",
                            "complement": "Apto 123",
                            "state": "SP",
                            "district": "Bairro das Flores"
                        }
                    }
                }
            ]
        }
    ]
}
🟠400Bad Request
🟠403Forbidden
Modified at 2025-07-15 12:08:29
Previous
Register delivery integration
Next
Update integration status
Built with