{"_id":"56b1110d02f4bc0d006ce29d","category":{"_id":"56b4b2faeed075230097d688","__v":0,"project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","pages":[],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-05T14:34:34.496Z","from_sync":false,"order":2,"slug":"contactos","title":"Contactos"},"editedParams2":true,"parentDoc":null,"version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":20,"createdAt":"2016-01-29T20:57:39.712Z","releaseDate":"2016-01-29T20:57:39.712Z","categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"project":"56abd2434e4b730d009eb10a","user":"56abd213d4432d1900eed227","editedParams":true,"__v":23,"updates":["59e4b6b79b239f00307710b0"],"next":{"pages":[],"description":""},"createdAt":"2016-02-02T20:26:53.081Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"Contacto simple","language":"json","code":"{\n  \"name\": \"Acrecer\"\n}"},{"name":"Contacto simple - México","language":"json","code":"{\n  \"name\": \"Acrecer\",\n  \"identification\" : \"XAXX010101000\"\n}"},{"name":"Contacto completo","language":"json","code":"        {\n                \"name\": \"Acrecer\",\n                \"identification\": \"963.654.988\",\n                \"email\": \"prueba2:::at:::alegra.com\",\n                \"phonePrimary\": \"111 11 11\",\n                \"seller\": {\n                        \"id\" : \"52\"\n                        },\n                \"term\" : \n                        {\n                            \"id\" : 2\n                        },\n                \"type\" : [\"client\"],\n                \"address\" : {\n                    \"address\" : \"Avenida Madison\",\n                    \"city\" : \"New York, USA\"\n                    },\n                \"internalContacts\" : [\n                            {\n                                \"name\" : \"Lina\",\n                                \"lastName\" : \"Montoya\",\n                                \"email\" : \"prueba4@alegra.com\",\n                                \"phone\" : \"123 45 67 ext 25\",\n                                \"mobile\" : \"(333) 333 33 33\",\n                                \"sendNotifications\" : \"no\"\n                            }\n                    ]\n        }"},{"name":"Contacto simple Perú","language":"json","code":"{\n  \"name\": \"Acrecer\",\n  \"identification\": {\n  \t\"type\": \"RUC\",\n    \"number\": \"12345678911\"\n  }\n}"}]},"method":"post","results":{"codes":[{"name":"Creación exitosa","code":"{\n                \"id\": 1,\n                \"name\": \"Acrecer\",\n                \"identification\": \"963.654.988\",\n                \"email\": \"prueba2@alegra.com\",\n\t\t\t\t\t\t\t\t\"phonePrimary\": \"111 11 11\",\n                \"phoneSecondary\": \"\",\n                \"fax\": \"\",\n                \"mobile\": \"(333) 555-55-55\",\n                \"observations\": \"\",\n                \"type\" : [\"client\"],\n                \"address\" : {\n                        \"address\" : \"Avenida Madison\",\n                        \"city\" : \"New York, USA\"\n                },\n                \"seller\": {\n                        \"id\" : \"52\",\n                        \"name\" : \"Diana Giraldo\",\n                        \"identification\" : 560,\n                        \"observations\" : 320\n                        },\n                \"term\" : \n                        {\n                            \"id\" : 2,\n                            \"name\" : \"8 días\",\n                            \"days\" : 8\n                        },\n                \"priceList\" : null,\n                \"internalContacts\" : [\n                    {\n                    \"id\" : 1,\n                   \"name\" : \"Lina\",\n                   \"lastName\" : \"Montoya\",\n                   \"email\" : \"prueba4@alegra.com\",\n                   \"phone\" : \"123 45 67 ext 25\",\n                   \"mobile\" : \"(333) 333 33 33\",\n                   \"sendNotifications\" : \"no\"\n                }\n                ]\n            }","language":"json","status":201},{"name":"","code":"{ \n\t\"error\": \"La información para crear el modelo no existe o es inválida\",\n  \"code\" : 400\n}","language":"json","status":400},{"name":"Creación exitosa - México","status":201,"language":"json","code":"{\n                \"id\": 1,\n                \"name\": \"Acrecer\",\n                \"identification\": \"XAXX010101000\",\n                \"email\": \"prueba2@alegra.com\",\n\t\t\t\t\t\t\t\t\"phonePrimary\": \"111 11 11\",\n                \"phoneSecondary\": \"\",\n                \"fax\": \"\",\n                \"mobile\": \"(333) 555-55-55\",\n                \"observations\": \"\",\n                \"type\" : [\"client\"],\n                \"address\" : {\n                        \"street\" : \"Avenida Primero de Mayo\",\n                        \"exteriorNumber\" : 95,\n                        \"interiorNumber\" : \"1B\",\n                        \"colony\" : \"Benito Juaréz\",\n                        \"country\" : \"México\",\n                        \"locality\" : \"\",\n                        \"municipality\" : \"\",\n                        \"state\" : \"D.F\",\n                        \"zipCode\" : \"12345\"\n                        }\n                ,\n                \"seller\": {\n                        \"id\" : \"52\",\n                        \"name\" : \"Diana Giraldo\",\n                        \"identification\" : 560,\n                        \"observations\" : 320\n                        },\n                \"term\" : \n                        {\n                            \"id\" : 2,\n                            \"name\" : \"8 días\",\n                            \"days\" : 8\n                        },\n                \"priceList\" : null,\n                \"internalContacts\" : [\n                    {\n                    \"id\" : 1,\n                   \"name\" : \"Lina\",\n                   \"lastName\" : \"Montoya\",\n                   \"email\" : \"prueba4@alegra.com\",\n                   \"phone\" : \"123 45 67 ext 25\",\n                   \"mobile\" : \"(333) 333 33 33\",\n                   \"sendNotifications\" : \"no\"\n                }\n                ]\n            }"},{"code":"{\n                \"id\": 1,\n                \"name\": \"Acrecer\",\n                \"identification\": {\n                \t\"type\": \"RUC\",\n                  \"number\": \"12345678911\"\n                },\n                \"email\": \"prueba2@alegra.com\",\n\t\t\t\t\t\t\t\t\"phonePrimary\": \"111 11 11\",\n                \"phoneSecondary\": \"\",\n                \"fax\": \"\",\n                \"mobile\": \"(333) 555-55-55\",\n                \"observations\": \"\",\n                \"type\" : [\"client\"],\n                \"address\" : {\n                        \"address\": \"AV SAN MARTIN 101\",\n                  \t\t\t\"state\": \"LORETO\",\n                  \t\t\t\"city\": \"MARISCAL RAMON CASTILLA\",\n                  \t\t\t\"district\": \"YAVARI\",\n                  \t\t\t\"urbanization\": \"SAN RAFAEL\",\n                  \t\t\t\"ubigeoCode\": 150603\n                }\n                ,\n                \"seller\": {\n                        \"id\" : \"52\",\n                        \"name\" : \"Diana Giraldo\",\n                        \"identification\" : 560,\n                        \"observations\" : 320\n                        },\n                \"term\" : \n                        {\n                            \"id\" : 2,\n                            \"name\" : \"8 días\",\n                            \"days\" : 8\n                        },\n                \"priceList\" : null,\n                \"internalContacts\" : [\n                    {\n                    \"id\" : 1,\n                   \"name\" : \"Lina\",\n                   \"lastName\" : \"Montoya\",\n                   \"email\" : \"prueba4@alegra.com\",\n                   \"phone\" : \"123 45 67 ext 25\",\n                   \"mobile\" : \"(333) 333 33 33\",\n                   \"sendNotifications\" : \"no\"\n                }\n                ]\n            }","language":"json","status":201,"name":"Creación exitosa Perú"}]},"settings":"","auth":"required","params":[{"_id":"56b0cbcbce5f410d0056c9c7","ref":"","in":"body","required":true,"desc":"Nombre del contacto. Longitud máxima permitida: 90.","default":"","type":"string","name":"name"},{"_id":"56b0cd936d004b17008065cf","ref":"","in":"body","required":false,"desc":"Número de identificación del contacto. Por ejemplo cédula, RNC, número de pasaporte, RFC. En versión Alegra México es obligatorio.   Longitud máxima permitida: 45.","default":"","type":"string","name":"identification"},{"_id":"59bc0cf9c7d95f0026eb0767","ref":"","in":"body","required":true,"desc":"Para perú, el atributo identification es obligatorio, un objeto compuesto por los siguientes atributos: `type(string`) tipo de identificación (SIN RUC, RUC, DNI, PP, CE, CDI), `number (string)` número de identificación.","default":"","type":"object","name":"identification (Perú)"},{"_id":"56b0cd936d004b17008065ce","ref":"","in":"body","required":false,"desc":"Número telefónico principal del contacto.  Longitud máxima permitida: 45.","default":"","type":"string","name":"phonePrimary"},{"_id":"56b0cd936d004b17008065cd","ref":"","in":"body","required":false,"desc":"Número telefónico secundario del contacto.  Longitud máxima permitida: 45.","default":"","type":"string","name":"phoneSecondary"},{"_id":"56b0cd936d004b17008065cc","ref":"","in":"body","required":false,"desc":"Fax del contacto.  Longitud máxima permitida: 45.","default":"","type":"string","name":"fax"},{"_id":"56b11166135ec20d00bafa04","ref":"","in":"body","required":false,"desc":"Número de célular/móvil.  Longitud máxima permitida: 45.","default":"","type":"string","name":"mobile"},{"_id":"56b0cd936d004b17008065cb","ref":"","in":"body","required":false,"desc":"Observaciones del cliente.  Longitud máxima permitida: 500.","default":"","type":"string","name":"observations"},{"_id":"56b0cd936d004b17008065ca","ref":"","in":"body","required":false,"desc":"Correo electrónico del contacto.  Longitud máxima permitida: 100.","default":"","type":"string","name":"email"},{"_id":"56b11233f48f270d00e0dd5d","ref":"","in":"body","required":false,"desc":"Enviar en false si desea que Alegra verifique si existe otro contacto con la misma identificación y si es así no crear el contacto.  Por defecto permite crear contactos con la misma identificación.","default":"","type":"boolean","name":"ignoreRepeated"},{"_id":"56b11233f48f270d00e0dd5c","ref":"","in":"body","required":false,"desc":"Objecto PriceList que indica la lista de precios asociada al contacto. Se puede enviar el id de la lista de precios directamente.","default":"","type":"object","name":"priceList"},{"_id":"56b11233f48f270d00e0dd5b","ref":"","in":"body","required":false,"desc":"Objecto Seller que indica el vendedor asociado al contacto. Se puede enviar el id del vendedor directamente.","default":"","type":"object","name":"seller"},{"_id":"56b11233f48f270d00e0dd5a","ref":"","in":"body","required":false,"desc":"Objecto Term que indica el término de pago del contacto. Se puede enviar el id del término de pago directamente.","default":"","type":"object","name":"term"},{"_id":"56b11233f48f270d00e0dd59","ref":"","in":"body","required":false,"desc":"Objeto Address que contiene la información de la dirección del contacto, compuesto por los atributos `address (string)` dirección del contacto y `city (string)` Ciudad del contacto.","default":"","type":"object","name":"address"},{"_id":"59bc09d115d1e10024261e0b","ref":"","in":"body","required":false,"desc":"Para méxico, el Objeto address con la información de la dirección del contacto está compuesto por los siguientes atributos:  `address (string)`: dirección del contacto; `city (string)`: Ciudad del contacto.  Para Alegra México, este objeto debe contener los atributos : `street (string)`: Calle del contacto; `exteriorNumber (string)` : Número de exterior; `interiorNumber (string)`: Número de interior; `colony (string)`: Colonia del contacto; `country (string, obligatorio)`: país del contacto; `locality (string)`: localidad; `municipality (string)`: Municipio; `state (string, obligatorio)`: estado, `zipCode (number)`: código postal del usuario.","default":"","type":"object","name":"address (México)"},{"_id":"59bc09d115d1e10024261e0a","ref":"","in":"body","required":false,"desc":"Para perú, el Objeto address que contiene la información de la dirección del contacto está compuesto por los siguientes atributos: `address (string)` dirección, `state (string)` departamento, `city (string)` provincia, `urbanization (string)` urbanización, `district (string)` distrito, `ubigeoCode (number)` código ubigeo.","default":"","type":"object","name":"address (Perú)"},{"_id":"56b11233f48f270d00e0dd58","ref":"","in":"body","required":false,"desc":"Array que incluye el tipo de contacto, las opciones posibles son 'client', 'provider', se puede incluir en el array una de la anteriores opciones, las dos opciones o ninguna. Si solo se desea asociar a un tipo se puede enviar el tipo directamente como String y no en Array.","default":"","type":"array_string","name":"type"},{"_id":"56b11233f48f270d00e0dd57","ref":"","in":"body","required":false,"desc":"Array de objetos internalContact que indica las personas asociadas al contacto.  Cada objeto deben tener los siguientes atributos `name (string, obligatorio)`: nombre del contacto interno;  `lastname (string)`: apellido del contacto interno; `email (string)` : correo electrónico; `phone (string)`: teléfono del contacto; `sendNotifications (boolean)`: enviar true si se desea que a la persona se le envíe notificaciones de vencimiento de factura.","default":"","type":"array_object","name":"internalContacts"}],"url":"/contacts"},"isReference":true,"order":3,"body":"","excerpt":"","slug":"crear-contacto","type":"endpoint","title":"Crear contacto"}

postCrear contacto


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
Nombre del contacto. Longitud máxima permitida: 90.
identification:
string
Número de identificación del contacto. Por ejemplo cédula, RNC, número de pasaporte, RFC. En versión Alegra México es obligatorio. Longitud máxima permitida: 45.
identification:
required
object
Para perú, el atributo identification es obligatorio, un objeto compuesto por los siguientes atributos: `type(string`) tipo de identificación (SIN RUC, RUC, DNI, PP, CE, CDI), `number (string)` número de identificación.
phonePrimary:
string
Número telefónico principal del contacto. Longitud máxima permitida: 45.
phoneSecondary:
string
Número telefónico secundario del contacto. Longitud máxima permitida: 45.
fax:
string
Fax del contacto. Longitud máxima permitida: 45.
mobile:
string
Número de célular/móvil. Longitud máxima permitida: 45.
observations:
string
Observaciones del cliente. Longitud máxima permitida: 500.
email:
string
Correo electrónico del contacto. Longitud máxima permitida: 100.
ignoreRepeated:
boolean
Enviar en false si desea que Alegra verifique si existe otro contacto con la misma identificación y si es así no crear el contacto. Por defecto permite crear contactos con la misma identificación.
priceList:
object
Objecto PriceList que indica la lista de precios asociada al contacto. Se puede enviar el id de la lista de precios directamente.
seller:
object
Objecto Seller que indica el vendedor asociado al contacto. Se puede enviar el id del vendedor directamente.
term:
object
Objecto Term que indica el término de pago del contacto. Se puede enviar el id del término de pago directamente.
address:
object
Objeto Address que contiene la información de la dirección del contacto, compuesto por los atributos `address (string)` dirección del contacto y `city (string)` Ciudad del contacto.
address:
object
Para méxico, el Objeto address con la información de la dirección del contacto está compuesto por los siguientes atributos: `address (string)`: dirección del contacto; `city (string)`: Ciudad del contacto. Para Alegra México, este objeto debe contener los atributos : `street (string)`: Calle del contacto; `exteriorNumber (string)` : Número de exterior; `interiorNumber (string)`: Número de interior; `colony (string)`: Colonia del contacto; `country (string, obligatorio)`: país del contacto; `locality (string)`: localidad; `municipality (string)`: Municipio; `state (string, obligatorio)`: estado, `zipCode (number)`: código postal del usuario.
address:
object
Para perú, el Objeto address que contiene la información de la dirección del contacto está compuesto por los siguientes atributos: `address (string)` dirección, `state (string)` departamento, `city (string)` provincia, `urbanization (string)` urbanización, `district (string)` distrito, `ubigeoCode (number)` código ubigeo.
type:
array of strings
Array que incluye el tipo de contacto, las opciones posibles son 'client', 'provider', se puede incluir en el array una de la anteriores opciones, las dos opciones o ninguna. Si solo se desea asociar a un tipo se puede enviar el tipo directamente como String y no en Array.
internalContacts:
array of objects
Array de objetos internalContact que indica las personas asociadas al contacto. Cada objeto deben tener los siguientes atributos `name (string, obligatorio)`: nombre del contacto interno; `lastname (string)`: apellido del contacto interno; `email (string)` : correo electrónico; `phone (string)`: teléfono del contacto; `sendNotifications (boolean)`: enviar true si se desea que a la persona se le envíe notificaciones de vencimiento de factura.

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 }}