Consultar Avanzado

Este método consulta un documento y permite obtener una copia del PDF y/o XML y/o CDR.

Valores

Variable	Descripción	Prod	Demo
`URL_API`	URL base de la API	`https://api.emite.pe`	`https://api.demo.emite.pe`
`EMITE_ID`	Identificador asignado a la empresa	Proporcionado por Emite	Proporcionado por Emite
`EMITE_KEY`	API Key asignada a la empresa	Proporcionado por Emite	Proporcionado por Emite

Request

POST {{URL_API}}/nota-debito/numero/{{SERIE-CORRELATIVO}}

Headers

emite_id: {{EMITE_ID}}
emite_key: {{EMITE_KEY}}
Content-Type: application/json

Path Params

El valor SERIE-CORRELATIVO representa el documento a consultar.

Está compuesto por:

serie: Serie del documento.
correlativo: Correlativo del documento.

Por ejemplo:
F001-1 (Nota de débito de factura)
B001-1 (Nota de débito de boleta)

Estructura Body

El objeto configuracion contiene los parámetros de configuración de la petición.

{
  "configuracion": {...}
}

La estructura completa del body se detalla en la tabla Propiedades Body.

Implementación

Shell
Node
Java
PHP

  curl "{{URL_API}}/nota-debito/numero/{{SERIE-CORRELATIVO}}" -X POST \
    -H "emite_id: {{EMITE_ID}}" \
    -H "emite_key: {{EMITE_KEY}}" \
    -H "Content-Type: application/json" \
    -d "{\"configuracion\":{...}}"

  const axios = require('axios');

  const data = {
    configuracion: {
      // ...
    }
  };

  axios.post('{{URL_API}}/nota-debito/numero/{{SERIE-CORRELATIVO}}', data, {
    headers: {
      emite_id: '{{EMITE_ID}}',
      emite_key: '{{EMITE_KEY}}',
      'Content-Type': 'application/json'
    }
  })
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error.response?.data || error.message);
  });

  import java.io.OutputStream;
  import java.net.HttpURLConnection;
  import java.net.URL;

  public class Main {
      public static void main(String[] args) throws Exception {

          URL url = new URL("{{URL_API}}/nota-debito/numero/{{SERIE-CORRELATIVO}}");
          HttpURLConnection conn = (HttpURLConnection) url.openConnection();

          conn.setRequestMethod("POST");
          conn.setRequestProperty("emite_id", "{{EMITE_ID}}");
          conn.setRequestProperty("emite_key", "{{EMITE_KEY}}");
          conn.setRequestProperty("Content-Type", "application/json");
          conn.setDoOutput(true);

          String json = """
          {
            "configuracion": {
            }
          }
          """;

          try (OutputStream os = conn.getOutputStream()) {
              byte[] input = json.getBytes("utf-8");
              os.write(input, 0, input.length);
          }

          int statusCode = conn.getResponseCode();
          System.out.println("HTTP Status: " + statusCode);
      }
  }

  <?php

  $data = (object)[
      'configuracion' => (object)[
          // ...
      ]
  ];

  $ch = curl_init('{{URL_API}}/nota-debito/numero/{{SERIE-CORRELATIVO}}');

  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'emite_id: {{EMITE_ID}}',
      'emite_key: {{EMITE_KEY}}',
      'Content-Type: application/json'
  ]);

  curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

  $response = curl_exec($ch);

  if (curl_errno($ch)) {
      echo 'Error: ' . curl_error($ch);
  } else {
      echo $response;
  }

  curl_close($ch);

Propiedades Body

Propiedad	Obligatoriedad	Tipo	Descripción
configuracion	Requerido	object	Contiene el listado de documentos a consultar.
configuracion. retornarPdf	Requerido	boolean	Indica si se desea obtener el contenido del archivo PDF.
configuracion. retornarXml	Requerido	boolean	Indica si se desea obtener el contenido del archivo XML.
configuracion. retornarCdr	Requerido	boolean	Indica si se desea obtener el contenido del archivo CDR.

Response

Si el código de estado es 200 la petición anterior retorna un JSON estructurado de la siguiente manera:

Success

200 — Cuando el proceso se ejecute correctamente.

Nota de débito de factura
Nota de débito de boleta

{
  "ticketPeticion": "1537486212351-1024216",
  "estado": 3,
  "nombreEstado": "ACEPTADO",
  "estadoSunat": "0",
  "observaciones": [
    "La Nota de Débito numero F001-1 fue aceptada"
  ],
  "estaAnulado": false,
  "pdf": {
    "name": "20600323751-08-F001-1.pdf",
    "content": "contenido-del-archivo",
    "contentType": "application/pdf"
  },
  "xml": {
    "name": "20600323751-08-F001-1.xml",
    "content": "contenido-del-archivo",
    "contentType": "text/xml"
  },
  "cdr": {
    "name": "CDR_20600323751-08-F001-1.xml",
    "content": "contenido-del-archivo",
    "contentType": "text/xml"
  }
}

{
  "ticketPeticion": "1537486212351-1024216",
  "estado": 3,
  "nombreEstado": "ACEPTADO",
  "estadoSunat": "0",
  "observaciones": [
    "La Nota de Débito numero B001-1 fue aceptada"
  ],
  "estaAnulado": false,
  "pdf": {
    "name": "20600323751-08-B001-1.pdf",
    "content": "contenido-del-archivo",
    "contentType": "application/pdf"
  },
  "xml": {
    "name": "20600323751-08-B001-1.xml",
    "content": "contenido-del-archivo",
    "contentType": "text/xml"
  },
  "cdr": {
    "name": "CDR_20600323751-08-B001-1.xml",
    "content": "contenido-del-archivo",
    "contentType": "text/xml"
  }
}

Propiedad	Condición	Tipo	Descripción
ticketPeticion	Siempre	string	Código identificador de la petición.
estado	Siempre	integer	Código interno de estado del documento.
nombreEstado	Siempre	string	Descripción de estado interno del documento.
estadoSunat	Siempre	string	Código de validación SUNAT.
observaciones	Siempre	array[string]	Lista de mensajes asociados a la operación.
estaAnulado	Siempre	boolean	Indica si el documento fue comunicado de baja.
pdf	Cuando configuracion. retornarPdf es `true`	object	Contiene los datos del archivo PDF.
pdf. name	Cuando configuracion. retornarPdf es `true`	string	Nombre del archivo.
pdf. content	Cuando configuracion. retornarPdf es `true`	string `Base64`	Contenido del byte[] representado en Base64.
pdf. contentType	Cuando configuracion. retornarPdf es `true`	string `application/pdf`	Nombre del mime type del archivo.
xml	Cuando configuracion. retornarXml es `true`	object	Contiene los datos del archivo XML.
xml. name	Cuando configuracion. retornarXml es `true`	string	Nombre del archivo.
xml. content	Cuando configuracion. retornarXml es `true`	string `Base64`	Contenido del byte[] representado en Base64.
xml. contentType	Cuando configuracion. retornarXml es `true`	string `text/xml`	Nombre del mime type del archivo.
cdr	Cuando configuracion. retornarCdr es `true`	object	Contiene los datos del archivo CDR.
cdr. name	Cuando configuracion. retornarCdr es `true`	string	Nombre del archivo.
cdr. content	Cuando configuracion. retornarCdr es `true`	string `Base64`	Contenido del byte[] representado en Base64.
cdr. contentType	Cuando configuracion. retornarCdr es `true`	string `text/xml`	Nombre del mime type del archivo.

Si el código de estado es 400, 401, 402, 403, 404 o 500 la petición anterior retorna un JSON estructurado de la siguiente manera:

Bad Request

400 - ERROR DE ESTRUCTURA JSON O EN LOS PARÁMETROS ENVIADOS.

Unauthorized

401 - ERROR DE AUTORIZACIÓN.

Payment Required

402 - ERROR POR FALTA DE PAGO.

Forbidden

403 - ERROR POR VALIDACIONES.

Not Found

404 - RECURSO NO ENCONTRADO.

Internal Server Error

500 - ERROR EN EL SERVIDOR.

Nota de débito de factura
Nota de débito de boleta

{
  "ticketPeticion": "1537486212351-1024216",
  "estado": "NOT_FOUND",
  "mensaje": "El documento F001-1 no ha sido registrado"
}

{
  "ticketPeticion": "1537486212351-1024216",
  "estado": "NOT_FOUND",
  "mensaje": "El documento B001-1 no ha sido registrado"
}

Propiedad	Condición	Tipo	Descripción
ticketPeticion	Siempre	string	Código identificador de la petición.
estado	Siempre	string	Nombre del estado HTTP retornado: `BAD_REQUEST` `UNAUTHORIZED` `PAYMENT_REQUIRED` `FORBIDDEN` `NOT_FOUND` `INTERNAL_SERVER_ERROR`.
mensaje	Siempre	string	Descripción del resultado o error retornado por la API.

Valores​

Request​

Headers​

Path Params​

Estructura Body​

Implementación​

Propiedades Body​

Response​