{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/invoices/:id/attachment","auth":"required","examples":{"codes":[{"code":"POST /api/v1/invoices/123/attachment HTTP/1.1\nHost: api.alegra.com\nAuthorization: Basic dXN1YXJpb0BhbGVncmEuY286bWl0b2tlbg==\nContent-Type: multipart/form-data; boundary=requestBoundary\n\n--requestBoundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.png\"\n\n[FILE_DATA]\n\n--requestBoundary--","language":"http"},{"code":"var id = 1;\nvar authorization = 'dXN1YXJpb0BhbGVncmEuY286bWl0b2tlbg=='; // Token de autorización, resultado de: base64(correo:::at:::ejemplo.com:123456)\nvar fileName = 'file.txt';\nvar content = 'Este es el contenido de mi archivo.';\n\nvar xhr = new XMLHttpRequest;\nxhr.open('POST', 'https://api.alegra.com/api/v1/invoices/' + id + '/attachment', false);\nxhr.setRequestHeader('Authorization', 'Basic ' + authorization);\nxhr.setRequestHeader('Content-Type', 'multipart/form-data; boundary=requestBoundary');\n\nvar data \n = '--requestBoundary\\r\\n'\n + 'Content-Disposition: form-data; name=\"file\"; filename=\"' + fileName + '\"\\r\\n'\n + '\\r\\n'\n + content + '\\r\\n'\n + '\\r\\n'\n + '--requestBoundary--\\r\\n';\n\nxhr.send(data);\nconsole.log(JSON.parse(xhr.responseText))","language":"javascript"},{"code":"<?php\n\n /**\n * Configuración:\n */\n // Correo de alegra:\n define('ALEGRA_EMAIL', '');\n // Token extraído de https://api.alegra.com/configuration/api:\n define('ALEGRA_API_TOKEN', '');\n // ID de factura de alegra a la que se le desea adjuntar el archivo:\n define('ALEGRA_INVOICE_ID', 1);\n // URL de API donde se suben los adjuntos para las facturas:\n define('ALEGRA_API_ENDPOINT', 'https://api.alegra.com/api/v1/invoices/' . ALEGRA_INVOICE_ID . '/attachment');\n // Acá debe ir la ruta del archivo en el servidor:\n define('FILE_PATH', realpath('./imagen.png'));\n\n // Request:\n $ch = curl_init(ALEGRA_API_ENDPOINT);\n curl_setopt($ch, CURLOPT_POST, true);\n curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);\n curl_setopt($ch, CURLOPT_USERPWD, ALEGRA_EMAIL . ':' . ALEGRA_API_TOKEN);\n curl_setopt($ch, CURLOPT_POSTFIELDS, array('file' => curl_file_create(FILE_PATH)));\n curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n $result = curl_exec($ch);\n curl_close($ch);\n\n // Salida:\n echo $result;","language":"php"}]},"method":"post","params":[{"name":"id","type":"int","default":"","desc":"Identificador de la factura de venta a la cual se desea adjuntar el archivo","required":false,"in":"path","ref":"","_id":"58fa698ee68f882f00cee012"},{"name":"file","type":"file","default":"","desc":"Archivo que se desea asociar a la factura","required":false,"in":"body","ref":"","_id":"58fa698ee68f882f00cee011"},{"name":"Content-Type","type":"string","default":"multipart/form-data","desc":"","required":true,"in":"header","ref":"","_id":"58fa698ee68f882f00cee00f"}],"results":{"codes":[{"name":"","code":"{\n \"id\": \"10\",\n \"url\": \"https://cdn3.alegra.com/8a1824aeb18389bcaaa346585cd815d92a6d3b3a-1492805921-file.png?AWSAccessKeyId=XXXXXXX&Expires=1492807722&Signature=YYYYYYY\",\n \"name\": \"file.png\"\n}","language":"json","status":200}]},"settings":""},"next":{"description":"","pages":[]},"title":"Adjuntar archivos a facturas de venta","type":"endpoint","slug":"adjuntar-archivos-a-facturas-de-venta","excerpt":"","body":"Para adjuntar un archivo a una factura de venta se debe enviar un request en el cual se debe especificar el header Content-Type como multipart/form-data.\n\nSe debe tener en cuenta que solo se puede enviar un archivo por request. El tamaño máximo permitido para éste es 2MB.\n\nSi la operación fue exitosa se retorna una URL para acceder al archivo asociado. Esta URL tiene vencimiento de 30 minutos; después de este período se debe consultar la factura de venta para obtener una nueva URL válida.","updates":[],"order":6,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"58ffab0a4959f10f00d11535","parentDoc":null,"project":"56abd2434e4b730d009eb10a","user":"56abd213d4432d1900eed227","githubsync":"","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33","5e8ca028538a310018ccd2df","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272","5f172282d7522c03be08713f","5f3c4814ac3e6209c38b7615","5f4fbe7281626c006887f104","5f5242887d2f8701ff580d22","5fc1133c51c8370081b28e2a","60807d7adc33b10010370740","60d30b1745665d00237faa55","60d30b2efa7b7200235a3c93","61006d2332a29f00801deea2","610d39edae2fc2000f014232","61c9cb2afbb56b000f39c13a"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":50,"createdAt":"2016-01-29T20:57:39.712Z"},"__v":4,"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Facturas de venta","slug":"facturas-de-venta","order":3,"from_sync":false,"reference":true,"_id":"56b4b32deed075230097d689","__v":0,"project":"56abd2434e4b730d009eb10a","createdAt":"2016-02-05T14:35:25.879Z","version":"56abd2434e4b730d009eb10d"},"createdAt":"2017-04-25T20:01:14.441Z"}
postAdjuntar archivos a facturas de venta
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
id:
integer
Identificador de la factura de venta a la cual se desea adjuntar el archivo
Body Params
file:
file
Archivo que se desea asociar a la factura
Headers
Content-Type:
required
stringmultipart/form-data