{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/custom-fields/","auth":"required","settings":"","results":{"codes":[{"name":"Ejemplo consulta exitosa","code":"[\n    {\n        \"id\": \"1\",\n        \"name\": \"Código de barras\",\n        \"description\": null,\n        \"defaultValue\": null,\n        \"resourceType\": \"item\",\n        \"status\": \"active\",\n        \"key\": \"barcode\",\n        \"type\": \"text\",\n        \"settings\": {\n            \"isRequired\": false,\n            \"showInItemVariants\": true,\n            \"printOnInvoices\": null\n        }\n    },\n    {\n        \"id\": \"2\",\n        \"name\": \"Fecha de vencimiento\",\n        \"description\": \"Indica la fecha en la que se vence el producto\",\n        \"defaultValue\": null,\n        \"resourceType\": \"item\",\n        \"status\": \"active\",\n        \"key\": null,\n        \"type\": \"date\",\n        \"settings\": {\n            \"isRequired\": true,\n            \"showInItemVariants\": null,\n            \"printOnInvoices\": true\n        }\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.com:mitoken'"}]},"method":"get","params":[{"name":"start","type":"int","default":"0","desc":"Desde cual campo se quiere consultar. Por ejemplo para consultar desde el campo 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"5c6acb01f0fee502226fb683"},{"name":"limit","type":"int","default":"30","desc":"Cantidad de campos 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"},{"name":"name_query","type":"string","default":"","desc":"Cadena de texto que se utiliza para consultar campos adicionales que contengan dicho texto en su nombre.","required":false,"in":"query","ref":"","_id":"5f0cec8128d18b00247a7a37"},{"name":"description_query","type":"string","default":"","desc":"Cadena de texto que se utiliza para consultar campos adicionales que contengan dicho texto en su descripción.","required":false,"in":"query","ref":"","_id":"5f0cec8128d18b00247a7a36"},{"name":"metadata","type":"boolean","default":"","desc":"Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo \"metadata\" y otro \"data\" en donde se envían los campos adicionales. Actualmente la información que se envía en metadata incluye el total de campos adicionales que tiene registrada la empresa.","required":false,"in":"query","ref":"","_id":"5f0cec8128d18b00247a7a35"},{"name":"status","type":"string","default":"","desc":"Filtrar campos adicionales por el estado. Se retornarán todos los campos adicionales cuyo estado actual sea el enviado como parámetro.","required":false,"in":"query","ref":"","_id":"5f0cec8128d18b00247a7a34"},{"name":"resourceType","type":"string","default":"","desc":"Filtrar campos adicionales por el tipo de recurso asociado. Se retornarán todos los campos adicionales que sean del tipo de recurso enviado como parámetro.","required":false,"in":"query","ref":"","_id":"5f0cec8128d18b00247a7a33"},{"name":"type","type":"string","default":"","desc":"Filtrar campos adicionales por el tipo de campo. Se retornarán todos los campos adicionales que sean del tipo enviado como parámetro.","required":false,"in":"query","ref":"","_id":"5f0cec8128d18b00247a7a32"}]},"next":{"description":"","pages":[]},"title":"Lista de campos adicionales","type":"endpoint","slug":"lista-de-atributos-adicionales","excerpt":"Endpoint que permite consultar los campos adicionales asociadas a la cuenta en la aplicación","body":"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 campos adicionales.\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","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272","5f172282d7522c03be08713f","5f3c4814ac3e6209c38b7615","5f4fbe7281626c006887f104","5f5242887d2f8701ff580d22"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":43,"createdAt":"2016-01-29T20:57:39.712Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Campos adicionales","slug":"atributos-adicionales","order":29,"from_sync":false,"reference":false,"_id":"5d055915910ab30020e5bc06","project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","createdAt":"2019-06-15T20:46:13.944Z","__v":1},"user":"56abd213d4432d1900eed227","createdAt":"2019-06-15T20:57:08.221Z","__v":6,"parentDoc":null}

getLista de campos adicionales

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

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

start:
integer0
Desde cual campo se quiere consultar. Por ejemplo para consultar desde el campo 20, se envía start=20.
limit:
integer30
Cantidad de campos 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.
name_query:
string
Cadena de texto que se utiliza para consultar campos adicionales que contengan dicho texto en su nombre.
description_query:
string
Cadena de texto que se utiliza para consultar campos adicionales que contengan dicho texto en su descripción.
metadata:
boolean
Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo "metadata" y otro "data" en donde se envían los campos adicionales. Actualmente la información que se envía en metadata incluye el total de campos adicionales que tiene registrada la empresa.
status:
string
Filtrar campos adicionales por el estado. Se retornarán todos los campos adicionales cuyo estado actual sea el enviado como parámetro.
resourceType:
string
Filtrar campos adicionales por el tipo de recurso asociado. Se retornarán todos los campos adicionales que sean del tipo de recurso enviado como parámetro.
type:
string
Filtrar campos adicionales por el tipo de campo. Se retornarán todos los campos adicionales que sean del tipo enviado como parámetro.

Examples


Result Format


Documentation

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 campos adicionales. [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 }}