Saltar al contenido principal

Notificar

Este método envía por email, de forma asíncrona, los archivos de uno o varios documentos.

Valores

VariableDescripciónProdDemo
URL_APIURL base de la APIhttps://api.emite.pehttps://api.demo.emite.pe
EMITE_IDIdentificador asignado a la empresaProporcionado por EmiteProporcionado por Emite
EMITE_KEYAPI Key asignada a la empresaProporcionado por EmiteProporcionado por Emite

Request

POST {{URL_API}}/nota-debito/notificar

Headers

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

Estructura Body

El arreglo documentos contiene los documentos que serán notificados por correo.

  • email: objeto de cada documento que contiene la información de los destinatarios del correo.
{
"documentos": [
{
...,
"email": {...}
}
]
}

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

Implementación

curl "{{URL_API}}/nota-debito/notificar" -X POST \
-H "emite_id: {{EMITE_ID}}" \
-H "emite_key: {{EMITE_KEY}}" \
-H "Content-Type: application/json" \
-d "{\"documentos\":[{...,\"email\":{...}}]}"

Propiedades Body

PropiedadObligatoriedadTipoDescripción
documentosRequeridoarray[object]Contiene el listado de documentos a notificar.
documentos[i].
serie
Requeridostring
Tamaño: [4]
Contiene la serie del documento.
documentos[i].
correlativo
Requeridointeger
Tamaño: [1...8]
Contiene el correlativo del documento.
documentos[i].
email
RequeridoobjectContiene la información de los destinatarios del correo.
documentos[i].
email.
to
Requeridoarray[string]
Debe enviarse al menos un destinatario
Lista de emails a los que se notificará el documento en "PARA".
documentos[i].
email.
cc
Requeridoarray[string]
Debe enviarse un arreglo vacío [] cuando no existan destinatarios
Lista de emails a los que se notificará el documento en "CON COPIA".
documentos[i].
email.
bcc
Requeridoarray[string]
Debe enviarse un arreglo vacío [] cuando no existan destinatarios
Lista de emails a los que se notificará el documento en "CON COPIA OCULTA".

Response

Si el código de estado es 204 la notificación fue procesada correctamente.

Success

204 — Cuando el proceso se ejecute correctamente.


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.

{
"ticketPeticion": "1537486212351-1024216",
"estado": "FORBIDDEN",
"mensaje": "El número del comprobante no es correcto"
}
PropiedadCondiciónTipoDescripción
ticketPeticionSiemprestringCódigo identificador de la petición.
estadoSiemprestringNombre del estado HTTP retornado:
BAD_REQUEST
UNAUTHORIZED
PAYMENT_REQUIRED
FORBIDDEN
NOT_FOUND
INTERNAL_SERVER_ERROR.
mensajeSiemprestringDescripción del resultado o error retornado por la API.