Kit de utilidades
Configurar logotipo
Logo de documentos
:
PUT
/api/ubl2.1/config/logo
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Logo en formato Base64
{
"logo": "/9j/4AAQSkZJRgABAQEAYABgAAD/4QBYRXhpZgAATU0AKgAAAAgABAMCAAIAAAASAAAAPlEQAAEAAAABAQAAAFERAAQAAAABAAAuI1ESAAQAAAABAAAuIwAAAABzUkdCIElFQzYxOTY2LTIuMQD..."
}
Response in status 200
{
"success": true,
"message": "Logo almacenado con éxito"
}
Consultar vencimiento del certificado
Vencimiento de la firma
:
PUT
/api/ubl2.1/certificate-end-date
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Response in status 200
24/02/2022
Descargas
Descargar PDF
:
GET
/api/ubl2.1/download/nit_empresa/FES-prefijoynumerodedocumento.pdf
Puede usar BASE64 para recibir el archivo en este formato y no el PDF directo.
/api/ubl2.1/download/nit_empresa/FES-prefijoynumerodedocumento.pdf/BASE64Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
el BASE64 es opcional, sino envia el paramtreo en la URL le retornara directamente el archivo PDF.
Response in status 200
Retorna el PDF
Descargar XML
:
GET
/api/ubl2.1/download/nit_empresa/RptaFE-prefijoynumerodedocumento.xml
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Response in status 200
Retorna el XML del documento
Descargar ZipAttachment
:
GET
/api/ubl2.1/download/nit_empresa/ZipAttachm-prefijoynumerodedocumento.xml
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Response in status 200
Retorna el ZipAttachment del documento
Descargar XML - Acuse Recibido DIAN
:
GET
/api/ubl2.1/download/nit_empresa/RptaFE-prefijoynumerodedocumento.xml
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Response in status 200
Retorna el XML con el acuse de recibido!
¿
Envio de E-mails
Enviar E-Mail
:
POST
/api/ubl2.1/send-email
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Permite enviar su propia representación (PDF) del documento emitido, para lo cual las propiedades sendemail y sendemailtome deberán ser false en el envio del documento.
{
"prefix": "FE",
"number": "28",
"base64graphicrepresentation": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggNiAwIFIvRmlsdGVyIC9GbGF0ZURlY29kZT4+CnN0cmVhbQp4nO1bX2/bOBJ/96cQsPvQHE40/4mkAtxD/vWui7RNE7dYYHEPaeymOdhJ105ur/st7xstpVjST9ZMZKdO9w5I8/IzO+SQM8OZIYf6NZFC6UQWfxW4mA2Gpz65XAzK5mR+Ofh1EIQp/pUNiC9myf4o0ockT0afBlLkeW61L/"
}
Response in status 200
{
"message": "Envio realizado con éxito",
"success": true
}
Reenviar E-mail
:
POST
/api/ubl2.1/send_mail
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Permite enviar el PDF a otro Email.
{
"email": "email_cliente@dominio.com",
"number": "7",
"number_full": "FE-7"
}
Response in status 200
{
"success": true,
"message": "Email enviado con éxito."
}
Estado del correo y eventos del documento
:
POST
/api/ubl2.1/query-events-uuid-cufedeldocumento
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Permite saber si el email con la factura le fue enviado de forma correcta al cliente y los eventos de un documento Tambien puede ser consumido desde la siguiente url: /api/ubl2.1/query-events-prefix-number/prefijo/numerodeldocumento
Response in status 200
{
"success": true,
"Aceptación Tácita":true,
"send_email_success": false
}
Reenviar correo de aceptación del documento
:
POST
/api/ubl2.1/status/document/cufedeldocumento
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Permite saber si el email con la factura le fue enviado de forma correcta al cliente y los eventos de un documento atacheddocument_name_prefix permite cambiar el nombre del archivo adjunto, sendmail debe ser true para enviar el email
{
{
"sendmail": true,
"atacheddocument_name_prefix": ""
}
}
Response in status 200
{
"message": "Consulta generada con éxito",
"ResponseDian": {
"Envelope": {
"Header": {
"Action": {
"_attributes": {
"mustUnderstand": "1"
},
"_value": "http://wcf.dian.colombia/IWcfDianCustomerServices/GetStatusResponse"
},
"Security": {
"_attributes": {
"mustUnderstand": "1"
},
"Timestamp": {
"_attributes": {
"Id": "_0"
},
"Created": "2022-02-23T17:39:21.356Z",
"Expires": "2022-02-23T17:44:21.356Z"
}
}
},
"Body": {
"GetStatusResponse": {
"GetStatusResult": {
"ErrorMessage": {},
"IsValid": "true",
"StatusCode": "00",
"StatusDescription": "Procesado Correctamente.",
"StatusMessage": "La Factura electrónica FE212, ha sido autorizada.",
"XmlBase64Bytes": "",
"XmlBytes": {
"_attributes": {
"nil": "true"
}
},
"XmlDocumentKey": "99b63f2ee36d99edefc03830458ff056cbe5268a1694838614e283504453d5ed4b9695e062688b8b62031ad88826dbc5",
"XmlFileName": "fv09012492320002200000046"
}
}
}
}
},
"reqzip": "",
"rptazip": """,
"attacheddocument": """,
"cufecude": "99b63f2ee36d99edefc03830458ff056cbe5268a1694838614e283504453d5ed4b9695e062688b8b62031ad88826dbc5"
}
Otros servicios
Enviar adjuntos con la factura
:
POST
/api/ubl2.1/invoice
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Agregue el siguiente objeto en el body de la petición de la factura para enviar documentos adjuntos. El archivo se debe enviar a la API en BASE64 e indicando la extensión
"annexes": [
{
"document": "JVBERi0xLjQKJfbk/N8KMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovVmVyc2lvbiA..............................",
"extension": "pdf"
},
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCC..............................",
"extension": "docx"
}
],
Combinar descargar varios PDFs
:
GET
/api/ubl2.1/join-pdfs
Es necesario indicar el type_document_id, prefix y number de cada documento. .
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Permite bajar varios PDFs en un solo documento, name_joined_pdfs es el nombre que recibirá el documento a descargar.Es necesario indicar el type_document_id, prefix y number de cada documento. .
{
"name_joined_pdfs": "PDFs-Unidos.pdf",
"pdfs": [
{
"type_document_id": 1,
"prefix": "T",
"number": "68"
},{
"type_document_id": 1,
"prefix": "T",
"number": "67"
},{
"type_document_id": 1,
"prefix": "T",
"number": "65"
},{
"type_document_id": 4,
"prefix": "9",
"number": "70000012"
}
]
}
Response in status 200
Retorna el archivo PDF
Actualizar customer
:
PUT
/api/ubl2.1/register-update-customer
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Permite conocer los datos del adquiriente de la factura, los nuevos datos se utilizarán en envios posteriores.
{
"identification_number": 901249232,
"dv": 0,
"name": "EMPRESA SAS",
"phone": 3100000000,
"address": "CLL 18A # 11 - 21",
"email": "nuevocorreo@dominio.com",
"sendnotification": true
}
Response in status 200
{
"success": true,
"message": "Cliente creado/actualizado con exito."
}
Consultar número actual de un documento
:
GET
/api/ubl2.1/next-consecutive
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Permite conocer cual fue el último documento emitido. Recibe el Id del documento en la URL
Request
En el cuerpo de la petición deberá enviar el id del tipo de documento y el prefijo a consultar
{
"type_document_id": 10,
"prefix": "NA"
}
Response in status 200
{
"success": true,
"type_document_id": 10,
"prefix": "NA",
"number": 1
}
Consulta de terceros
:
GET
/api/ubl2.1/SearchCompany/
nit_a_consultar
Headers
Content-Type: "text/plain"
Authorization (Bearer TOKEN): "f4cc03f8ede50a53e32d74a500d4c71062e3621973645f07fc0adc55dff0297b"
Request
Response in status 200
{
"success": true,
"name": "EMPRESA SAS",
"type": "PERSONA JURIDICA",
"direction": "CLL 18A # 11 - 20",
"state": "CORDOBA",
"activity": "J6201 - ACTIVIDADES DE DESAROLLO DE SISTEMAS DE INFORMACIÓN",
}