Export structured document data processed in the Pipeline

Returns structured data about fiscal documents processed in the Pipeline.
This endpoint does not return the original file (PDF/XML), only metadata
and extracted fields (file metadata, provider, beneficiary, values, tributes, etc.).

Depending on documentType, it returns NFSe, NFe, CTe or any other document type,
always including common fields and, when available, type-specific fields.

application/json

Paginated response of documents data. The response structure varies based on document type (NFSe, NFe, CTe or others). Each document type returns only its specific fields plus common fields.

Body

Example response for a NFSe document. Contains NFSe-specific fields like authorizationCode, serviceDescription, and tribute values (PIS, COFINS, CSLL, etc.).

{
    "data": [
        {
            "documentType": "NFSe",
            "file": {
                "internalId": "33efa415-bea2-4da8-8296-e16407f0c2ff",
                "origin": "INBOUND_NFSE_SAOPAULOSERVICE",
                "name": "578b69e9402a56cf328777e82519d165/2025/09/16/22/07/54/1758060472051-0f237dbc7df9afd7340afb.xml",
                "displayName": "string",
                "step": "string",
                "stepOrder": 3,
                "message": "string",
                "uploadDate": "2025-09-16T22:07:59.394Z",
                "processStatus": "DONE",
                "visible": true,
                "duplicated": false,
                "deletedDocument": false,
                "isConsolidated": true,
                "finalized": false,
                "dueDate": "2025-10-16T12:00:00.000Z"
            },
            "fileErp": {
                "fiscalIntegrationMessage": "SUCCESS",
                "fiscalIntegrationValue": "string",
                "accountingIntegrationMessage": "SUCCESS",
                "accountingIntegrationValue": "string"
            },
            "accessKey": null,
            "number": "46811",
            "series": null,
            "issueDate": "2025-09-16T13:58:23.000Z",
            "cancelled": true,
            "value": 771.56,
            "liquidValue": 724.1,
            "dueDate": "2025-10-16T12:00:00.000Z",
            "provider": {
                "nationalRegister": "12345678000190",
                "name": "string",
                "optantSimples": false,
                "optantMei": false,
                "address": {
                    "city": "SAO PAULO",
                    "state": "SP"
                }
            },
            "beneficiary": {
                "nationalRegister": "98765432000111",
                "name": "string",
                "tradeName": "string",
                "legallyActive": true,
                "address": {
                    "city": "BARUERI",
                    "state": "SP"
                }
            },
            "authorizationCode": "string",
            "purchaseOrder": [
                "481524"
            ],
            "service": {
                "sameAddress": true,
                "description": "string",
                "discrimination": "string",
                "code": "1704",
                "serviceMadeCity": "3550308"
            },
            "serviceSheet": [],
            "claimant": null,
            "transferValue": 0,
            "paymentProviderStatus": "PAID",
            "cpom": {
                "description": null,
                "aliquot": null
            },
            "tributes": [
                {
                    "name": "cofins",
                    "aliquot": 3,
                    "value": 23.15
                },
                {
                    "name": "csll",
                    "aliquot": 1,
                    "value": 7.72
                },
                {
                    "name": "inss",
                    "aliquot": 0,
                    "value": 0
                },
                {
                    "name": "irrf",
                    "aliquot": 1.5,
                    "value": 11.57
                },
                {
                    "name": "iss",
                    "aliquot": 0,
                    "value": 0
                },
                {
                    "name": "pis",
                    "aliquot": 0.65,
                    "value": 5.02
                }
            ],
            "decrementValue": 0,
            "incrementValue": 0,
            "fineValue": 0
        }
    ],
    "total": 1,
    "page": 1,
    "limit": 1000,
    "totalPages": 1
}

Export structured document data processed in the Pipeline

Request

Request Code Samples

Responses