{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/custom-fields/","auth":"required","settings":"","results":{"codes":[{"name":"Ejemplo consulta exitosa","code":"[\n    {\n        \"name\": \"Código de barras\",\n        \"description\": \"Indica el código de barras\",\n        \"defaultValue\": null,\n        \"resourceType\": \"item\",\n        \"status\": \"active\",\n        \"key\": \"barcode\",\n        \"type\": \"text\"\n    }\n]","language":"json","status":200},{"name":"Bad Request - Límite sobrepasa máximo permitido","code":"{ \n\t\"error\": \"El límite de atributos para retornar debe estar entre 0 y 30\",\n\t\"code\" : 903\n}","language":"json","status":400}]},"examples":{"codes":[{"language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET https://api.alegra.com/api/v1/custom-fields/ -u 'usuario:::at:::alegra.co:mitoken'"}]},"method":"get","params":[{"name":"start","type":"int","default":"0","desc":"Desde cual atributo se quiere consultar. Por ejemplo para consultar desde el atributo 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"5c6acb01f0fee502226fb683"},{"name":"limit","type":"int","default":"30","desc":"Cantidad de atributos a partir del inicio que se desea retornar.  Por defecto retorna 30 atributos. Si este valor es mayor que 30, la aplicación retorna error.","required":false,"in":"query","ref":"","_id":"5c6acb01f0fee502226fb682"}]},"next":{"description":"","pages":[]},"title":"Lista de atributos adicionales","type":"endpoint","slug":"lista-de-atributos-adicionales","excerpt":"Endpoint que permite consultar los atributos adicionales asociadas a la cuenta en la aplicación","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Observación\",\n  \"body\": \"Para activar un atributo adicional debe realizarse en Configuración > Inventario.\"\n}\n[/block]\nEndpoint que retorna los atributos adicionales asociados a la cuenta de Alegra.  Si no se envía límite, por defecto se envían 30 atributos.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atención\",\n  \"body\": \"Se debe tener en cuenta que el valor máximo para el atributo limit es 30, si se supera ese valor la aplicación retorna el código de error:\\n```\\n{\\n  \\\"code\\\": 903,\\n  \\\"message\\\" : \\\"El límite debe ser menor o igual a 30\\\"\\n}\\n```\"\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d055ba4b1dfd80014707d4a","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":"Atributos adicionales","slug":"atributos-adicionales","order":25,"from_sync":false,"reference":false,"_id":"5d055915910ab30020e5bc06","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","createdAt":"2019-06-15T20:46:13.944Z","__v":0},"user":"56abd213d4432d1900eed227","createdAt":"2019-06-15T20:57:08.221Z","__v":2,"parentDoc":null}

getLista de atributos adicionales

Endpoint que permite consultar los atributos adicionales asociadas a la cuenta en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual atributo se quiere consultar. Por ejemplo para consultar desde el atributo 20, se envía start=20.
limit:
integer30
Cantidad de atributos a partir del inicio que se desea retornar. Por defecto retorna 30 atributos. Si este valor es mayor que 30, la aplicación retorna error.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Observación", "body": "Para activar un atributo adicional debe realizarse en Configuración > Inventario." } [/block] Endpoint que retorna los atributos adicionales asociados a la cuenta de Alegra. Si no se envía límite, por defecto se envían 30 atributos. [block:callout] { "type": "warning", "title": "Atención", "body": "Se debe tener en cuenta que el valor máximo para el atributo limit es 30, si se supera ese valor la aplicación retorna el código de error:\n```\n{\n \"code\": 903,\n \"message\" : \"El límite debe ser menor o igual a 30\"\n}\n```" } [/block]

User Information

Try It Out

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