Consulta de remessa de documentos

GET

/api/v1.0/service/dup/consultar_remessa/{chaveRegistroRemessa}

Consulta de remessa de documentos enviada para processamento. Retorna uma lista com o número dos documentos registrados em caso de sucesso. Em caso de problemas, o sistema não efetua registro parcial — é necessário reenviar toda a remessa corrigida.

Requisição

Parâmetros de Caminho

Respostas

🟢200

application/json

Sucesso

Bodyapplication/json

🟠400400

🟠401401

🔴500500

Response Example

200 - Exemplo 1

{
    "statusRemessa": "AGUARDANDO-PROCESSAMENTO",
    "registros": [
        {
            "chaveRegistro": "20000000A320241010000000000000000001",
            "numeroDuplicata": "000123456789",
            "numeroParcela": "001",
            "cpfCnpjTitular": "01.234.567/0001-00",
            "cpfCnpjEmitente": "01.234.567/0001-00",
            "cpfCnpjSacado": "01.234.567/0001-00",
            "dataVencimento": "2024-12-31",
            "valorDuplicata": 1234567890123.12,
            "chaveNFe": "51080701212344000127550010000000981364117781",
            "registrado": "SIM",
            "motivoRejeicaoRegistro": "string",
            "dataHoraRegistro": "2024-08-20T20:10:30.123456Z",
            "sucessoValidacao": "SIM",
            "erros": [
                "string"
            ]
        }
    ]
}

Modificado em 2026-06-18 13:57:01

Página anterior

Inclusão de remessas de documentos

Próxima página

Consulta de documentos