Ir al contenido
Documentación

Facturación

Enviar una factura por correo al comprador

POST
/v1/invoices/{invoiceId}/deliveries
curl --request POST \
--url https://api.timbro.do/v1/invoices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deliveries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'idempotency-key: example' \
--data '{ "accountClaimUrl": "https://example.com", "attachments": { "pdf": true, "xml": true }, "recipientEmail": "hello@example.com" }'

Solicita la entrega de una factura por correo. Consulta el resultado de la entrega por separado del estado de la factura.

invoiceId
obligatorio
string format: uuid
idempotency-key
obligatorio
string
>= 16 characters <= 255 characters /^[A-Za-z0-9._:-]+$/
Media typeapplication/json

Ejemplogenerated

{
"accountClaimUrl": "https://example.com",
"attachments": {
"pdf": true,
"xml": true
},
"recipientEmail": "hello@example.com"
}
object
recipientEmail
obligatorio
string format: email
>= 3 characters <= 320 characters
Campos opcionales
accountClaimUrl

Página HTTPS del comprador para esta compra. El correo incluye el link, pero este no da acceso por sí solo.

string format: uri
<= 2048 characters /^https:///
attachments
object
pdf

Adjunta la representación impresa como {RNC}{e-NCF}.pdf.

boolean
xml

Adjunta el e-CF firmado como {RNC}{e-NCF}.xml, el nombre de archivo que exige la DGII.

boolean

Respuesta predeterminada

Media typeapplication/json
Campos y códigos de la respuesta
object
attachments
obligatorio

Los archivos que este correo adjunta junto a su link.

object
pdf
obligatorio
boolean
xml
obligatorio
boolean
createdAt
obligatorio
string format: date-time
id
obligatorio
string format: uuid
invoiceId
obligatorio
string format: uuid
lastResultCode
obligatorio
string | null
link
obligatorio
string
providerDeliveryId
obligatorio
string | null
recipientEmail
obligatorio
string
state
obligatorio
string
Valores permitidos: pending submitted delivered bounced failed suppressed
updatedAt
obligatorio
string format: date-time
request-id
obligatorio
string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

Idempotent-Replayed
string
Valor permitido: true

true cuando esta respuesta repite el resultado guardado de una solicitud anterior con la misma clave de idempotencia (Idempotency-Key).