{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/remissions","auth":"required","method":"post","examples":{"codes":[{"name":"Remisión Sencilla","language":"json","code":"{\n    \"date\": \"2015-11-15\",\n    \"dueDate\": \"2015-12-15\",\n    \"client\": 1,\n    \"items\" : [\n        {\n            \"id\": 1,\n            \"price\" : 12000,\n            \"quantity\" : 5\n        },\n        {\n            \"id\": 2,\n            \"price\": 8500,\n            \"quantity\" : 1\n        }\n    ]\n}"},{"name":"Remisión Completa","language":"json","code":"{\n  \t\"documentName\": \"serviceOrder\",\n    \"date\": \"2015-12-15\",\n    \"dueDate\": \"2015-12-25\",\n    \"observations\": \"Observaciones de la remisión.\",\n    \"anotation\" : \"Notas de mi remisión\",\n    \"client\": {\n        \"id\": 2\n    },\n    \"seller\" : {\n        \"id\" : \"2\"\n    },\n    \"currency\" : {\n        \"code\" : \"USD\" ,\n        \"exchangeRate\" : 3100\n        },\n    \"items\" : [\n        {\n            \"id\": 1,\n            \"description\": \"Billetera de cuero negro\",\n            \"reference\": \"REF-005\",\n            \"discount\" : 0,\n            \"tax\" : [\n                {\n                    \"id\" : 2\n                }\n            ],\n            \"price\" : 120,\n            \"quantity\" : 5\n        },\n        {\n            \"id\": 2,\n            \"description\": \"Cartera de cuero color café\",\n            \"reference\": \"CAR-195\",\n            \"price\": 85,\n            \"discount\" : 10,\n            \"tax\" : [\n                {\n                    \"id\" : 1\n                }\n            ],\n            \"quantity\" : 1\n        }\n    ]\n}"},{"name":"cURL","language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X POST  https://api.alegra.com/api/v1/remissions/ -u 'micorreo:::at:::alegra.com:mitoken12345' -d '{\"date\": 2015-11-15\", \"dueDate\": \"2015-12-15\", \"client\": 2, \"items\" : [{\"id\": 1, \"price\" : 12000, \"quantity\" : 5}, {\"id\": 2, \"price\": 8500, \"quantity\" : 1 }]}'"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": \"21\",\n  \"number\" : \"22\",\n  \"documentName\": \"serviceOrder\",\n  \"date\": \"2015-12-15\",\n  \"dueDate\": \"2015-12-25\",\n  \"observations\": \"Observaciones de la remisión.\",\n  \"anotation\": \"Notas de mi remisión.\",\n  \"status\": \"open\",\n  \"client\": {\n        \"id\": 2,\n        \"name\": \"Acrecer\",\n        \"identification\": \"963.654.988\",\n        \"email\": \"[email protected]\",\n        \"phonePrimary\": \"111 11 11\",\n        \"phoneSecondary\": \"\",\n        \"fax\": \"\",\n        \"mobile\": \"(333) 555-55-55\",\n        \"observations\": \"\",\n        \"address\": {\n            \"address\": \"Avenida Madison\",\n            \"city\": \"New York, USA\"\n        }\n  },\n  \"total\": 707,\n  \"seller\": {\n    \"id\": \"6\",\n    \"name\": \"Alejandro Mesa\",\n    \"identification\": \"123456\",\n    \"observations\": \"Ventas sur\"\n  },\n  \"priceList\" : null,\n  \"warehouse\": {\n        \"id\": \"1\",\n        \"name\": \"Principal\"\n  },\n  \"currency\": {\n    \"code\": \"USD\",\n    \"exchangeRate\": 3100\n  },\n  \"items\": [\n    {\n      \"id\": 1,\n      \"name\": \"Billetera\",\n      \"description\": \"Billetera de cuero negro\",\n      \"price\": 120,\n      \"discount\": \"0.00\",\n      \"reference\": \"REF-005\",\n      \"quantity\": \"5.00\",\n      \"tax\": [\n        {\n        \"id\": \"2\",\n        \"name\": \"IVA\",\n        \"percentage\": \"5.00\",\n        \"description\": \"Impuesto de valor agregado\",\n        \"type\": \"IVA\",\n        \"status\" : \"active\"\n          }\n        ],\n      \"total\": 630\n    },\n    {\n      \"id\": 2,\n      \"name\": \"Cartera\",\n      \"description\": \"Cartera de cuero color café\",\n      \"price\": 85,\n      \"discount\": \"10.00\",\n      \"reference\": \"CAR-195\",\n      \"quantity\": \"1.00\",\n      \"tax\": [\n        {\n        \"id\": \"1\",\n        \"name\": \"IVA\",\n        \"percentage\": \"0.00\",\n        \"description\": \"Impuesto de valor agregado\",\n        \"type\": \"IVA\",\n        \"status\" : \"active\"\n          }\n        ],\n      \"total\": 77\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{ \n\t\"error\": \"La información para crear el modelo no existe o es inválida\",\n  \"code\" : 400\n}","name":""}]},"settings":"","params":[{"name":"documentName","type":"string","default":"remission","desc":"Nombre del tipo de documento de la nueva remisión. Los valores que se aceptan son 'remission' y 'serviceOrder' (Orden de servicio). Por defecto se asocia el valor 'remission'.","required":false,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f2751f"},{"name":"date","type":"yyyy-mm-dd","default":"","desc":"Fecha de la remisión. Formato yyyy-MM-dd.","required":true,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f2751e"},{"name":"dueDate","type":"yyyy-mm-dd","default":"","desc":"Fecha de vencimiento de la remisión. Formato yyyy-MM-dd.","required":true,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f2751d"},{"name":"observations","type":"string","default":"","desc":"Observaciones de la remisión (no visibles en el pdf o documento impreso). Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f2751c"},{"name":"anotation","type":"string","default":"","desc":"Notas de la remisión, visibles en el PDF o documento impreso. Longitud máxima permitida: 500.","required":false,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f2751b"},{"name":"client","type":"mixed","default":"","desc":"Objecto que contiene el id del cliente asociado a la remisión. Se puede enviar directamente el id del cliente en este atributo.","required":true,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f2751a"},{"name":"items","type":"array_object","default":"","desc":"Array de objetos item (productos/servicios) asociados a la remisión. Cada objeto debe incluir: `id (number, obligatorio)`: identificador del producto o servicio que se cotiza; `price (double, obligatorio)`: precio en la remisión; `reference (string)` : referencia del producto/servicio; `description (string)`: descripción del producto/servicio; `tax (objeto)` : array de objetos tax que indican la información del impuesto; `quantity (obligatorio)`: cantidad del producto o servicio; `discount (decimal)`: porcentaje de descuento aplicado al producto, éste no debe incluir el símbolo %, únicamente su tasa. El precio del producto/servicio no debe incluir impuestos ni descuentos.","required":true,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f27519"},{"name":"seller","type":"mixed","default":"","desc":"Objeto que indica el id del vendedor asociado a la remisión. Se puede enviar directamente el id del vendedor en este atributo.","required":false,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f27518"},{"name":"priceList","type":"mixed","default":"","desc":"Objeto que indica el id de la lista de precios asociada a la remisión. Se puede enviar directamente el id de la lista de precios en este atributo.","required":false,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f27517"},{"name":"currency","type":"object","default":"","desc":"Objecto que incluye la información de la moneda y tasa de cambio asociada a la remisión. Solo se debe incluir si la compañía tiene activa la funcionalidad de multimoneda y tiene configurada la moneda seleccionada. Debe incluir el código de la moneda (de tres letras según ISO) y la tasa de cambio.","required":false,"in":"body","ref":"","_id":"5d77cc8f2fe4f00101f27516"}]},"next":{"description":"","pages":[]},"title":"Crear una remisión","type":"endpoint","slug":"crear-remisión","excerpt":"Endpoint que permite crear una remisión desde cero.","body":"","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d77c87a73aeb30049574f37","project":"56abd2434e4b730d009eb10a","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"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":32,"createdAt":"2016-01-29T20:57:39.712Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Remisiones","slug":"remisiones","order":22,"from_sync":false,"reference":false,"_id":"5d76e2018e0ce7006c82dbe1","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","createdAt":"2019-09-09T23:36:33.957Z","__v":0},"user":"56abd213d4432d1900eed227","createdAt":"2019-09-10T15:59:54.727Z","__v":5,"parentDoc":null}

postCrear una remisión

Endpoint que permite crear una remisión desde cero.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

documentName:
stringremission
Nombre del tipo de documento de la nueva remisión. Los valores que se aceptan son 'remission' y 'serviceOrder' (Orden de servicio). Por defecto se asocia el valor 'remission'.
date:
required
yyyy-mm-dd
Fecha de la remisión. Formato yyyy-MM-dd.
dueDate:
required
yyyy-mm-dd
Fecha de vencimiento de la remisión. Formato yyyy-MM-dd.
observations:
string
Observaciones de la remisión (no visibles en el pdf o documento impreso). Longitud máxima permitida: 500.
anotation:
string
Notas de la remisión, visibles en el PDF o documento impreso. Longitud máxima permitida: 500.
client:
required
mixed
Objecto que contiene el id del cliente asociado a la remisión. Se puede enviar directamente el id del cliente en este atributo.
items:
required
array of objects
Array de objetos item (productos/servicios) asociados a la remisión. Cada objeto debe incluir: `id (number, obligatorio)`: identificador del producto o servicio que se cotiza; `price (double, obligatorio)`: precio en la remisión; `reference (string)` : referencia del producto/servicio; `description (string)`: descripción del producto/servicio; `tax (objeto)` : array de objetos tax que indican la información del impuesto; `quantity (obligatorio)`: cantidad del producto o servicio; `discount (decimal)`: porcentaje de descuento aplicado al producto, éste no debe incluir el símbolo %, únicamente su tasa. El precio del producto/servicio no debe incluir impuestos ni descuentos.
seller:
mixed
Objeto que indica el id del vendedor asociado a la remisión. Se puede enviar directamente el id del vendedor en este atributo.
priceList:
mixed
Objeto que indica el id de la lista de precios asociada a la remisión. Se puede enviar directamente el id de la lista de precios en este atributo.
currency:
object
Objecto que incluye la información de la moneda y tasa de cambio asociada a la remisión. Solo se debe incluir si la compañía tiene activa la funcionalidad de multimoneda y tiene configurada la moneda seleccionada. Debe incluir el código de la moneda (de tres letras según ISO) y la tasa de cambio.

Examples


Result Format


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}