Get pending entities to be integrated - PUBLIC SERVICES [PROD]

Request

Header Params

Body Params application/json

Get pending NFE documents

{
    "entity": "DOCUMENT",
    "integrationId": "9876c5d4-ba32-1098-7654-321f98765432",
    "type": "NFE"
}

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

{
    "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": "São Paulo",
                            "cityUniqueCode": "3452314",
                            "complement": "Apto 123",
                            "state": "SP",
                            "district": "Bairro das Flores"
                        }
                    }
                }
            ]
        }
    ]
}

🟠400Bad Request

🟠403Forbidden