{"_id":"57487d77db76422200d9586c","category":{"_id":"56b4b3eb7bccae0d00e9a12e","version":"56abd2434e4b730d009eb10d","pages":[],"project":"56abd2434e4b730d009eb10a","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-05T14:38:35.098Z","from_sync":false,"order":8,"slug":"empresa","title":"Empresa"},"editedParams2":true,"user":"56abd213d4432d1900eed227","githubsync":"","version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":22,"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","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"__v":12,"editedParams":true,"parentDoc":null,"project":"56abd2434e4b730d009eb10a","updates":["574c44b4cf99610e00ef7d76"],"next":{"pages":[],"description":""},"createdAt":"2016-05-27T17:01:43.923Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"57488481db76422200d95887","ref":"","in":"body","required":false,"desc":"Nombre de la empresa. Longitud máxima permitida: 90. Para Colombia, si la compañía es de una persona natural, se debe enviar este atributo como un objeto, que contiene los atirbutos: `firstName` (obligatorio), `secondName` (opcional), `lastName` (obligatorio).","default":"","type":"string","name":"name"},{"_id":"57488481db76422200d95886","ref":"","in":"body","required":false,"desc":"Objeto Address que contiene la dirección de la empresa, compuesto por los atributos `address (string)` dirección y `city (string)` Ciudad.","default":"","type":"object","name":"address"},{"_id":"59bc2e4e26ac9b0010a8b76d","ref":"","in":"body","required":false,"desc":"Para Alegra México, este objeto debe contener los atributos : `street (string)`: Calle de la empresa; `exteriorNumber (string)` : Número de exterior; `interiorNumber (string)`: Número de interior; `colony (string)`: Colonia de la empresa; `country (string, obligatorio)`: país de la empresa; `locality (string)`: localidad; `municipality (string)`: Municipio; `state (string, obligatorio)`: estado, `zipCode (number)`: código postal de la empresa.","default":"","type":"object","name":"address (méxico)"},{"_id":"59bc2e4e26ac9b0010a8b76c","ref":"","in":"body","required":false,"desc":"Para perú, el Objeto address que contiene la información de la dirección de la empresa 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":"5bcf89a54c0907005cc026e0","ref":"","in":"body","required":false,"desc":"Para Costa Rica, el objeto address con la información de la dirección de la compañía está compuesto por los siguientes atributos:  `address (string)` Otras señas, `department (string)` Provincia, `city (string)` Cantón, `district (string)` Distrito, `neighborhood (string)` Barrio. Este atributo se vuelve obligatorio si el tipo de identificación es diferente a \"00\".","default":"","type":"object","name":"address (Costa Rica)"},{"_id":"5bedd6849b49e8004462dcb2","ref":"","in":"body","required":false,"desc":"Para Colombia, el objeto address con la información de la dirección de la compañía está compuesto por los siguientes atributos:  `address (string)` Dirección, `department (string)` Departamento, `city (string)` Ciudad.","default":"","type":"string","name":"address (Colombia)"},{"_id":"57488481db76422200d95885","ref":"","in":"body","required":false,"desc":"Identificación de la empresa. Ej RFC, cédula, NIT, RUC, entre otros. Para la versión Alegra Perú es obligatorio.","default":"","type":"string","name":"identification"},{"_id":"5bcf89a54c0907005cc026df","ref":"","in":"body","required":false,"desc":"Para Costa Rica y Colombia, el atributo identificationObject es un objeto compuesto por los siguientes atributos: `type(string)` tipo de identificación (Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia)), `number (string)` número de identificación. Parámetro obligatorio si se tiene facturación electrónica activa.","default":"","type":"object","name":"identificationObject"},{"_id":"57488481db76422200d95884","ref":"","in":"body","required":false,"desc":"Correo electrónico de la empresa.","default":"","type":"string","name":"email"},{"_id":"57488481db76422200d95883","ref":"","in":"body","required":false,"desc":"Teléfono de la empresa.","default":"","type":"string","name":"phone"},{"_id":"57488481db76422200d95882","ref":"","in":"body","required":false,"desc":"Página web de la empresa.","default":"","type":"string","name":"website"},{"_id":"57488481db76422200d95881","ref":"","in":"body","required":false,"desc":"Indica la precisión decimal que tiene configurada la empresa para la creación de documentos. Las facturas de venta y demás documentos que se creen se aproximan teniendo en cuenta este atributo.","default":"","type":"int","name":"decimalPrecision"},{"_id":"57488481db76422200d95880","ref":"","in":"body","required":false,"desc":"Objeto que contiene las preferencias de facturación de la empresa. Contiene los siguientes atributos: `defaultAnotation` : Notas por defecto que la empresa tiene configuradas en la aplicación. `defaultTermsAndConditions`: Términos y condiciones por defecto que tiene configuradas la empresa.","default":"","type":"string","name":"invoicePreferences"},{"_id":"5bedd6849b49e8004462dcb1","ref":"","in":"body","required":false,"desc":"Para Colombia, indica el tipo de persona, Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia). Parámetro obligatorio si se tiene facturación electrónica activa.","default":"","type":"string","name":"kindOfPerson"},{"_id":"5beddc7bde0ab00430c2fbd3","ref":"","in":"body","required":false,"desc":"Objeto compuesto por las configuraciones de la compañía. Contiene el atributo `electronicInvoicing`, el cuál se envía en true para activar facturación electrónica.","default":"","type":"string","name":"settings"}],"url":"/company"},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos.\"\n}\n[/block]\nPor ejemplo para editar el nombre de la empresa se debe enviar el siguiente JSON:\n\n```JSON\n{\n\"name\" : \"Nuevo nombre  de mi empresa\"\n}\n```\n\n\nPara eliminar algún dato de la empresa enviar el atributo en null, así:\n```JSON\n{\n\"phone\" : null\n}\n```\n\nSe retorna la empresa que se ha modificado.","excerpt":"Endpoint para editar la información de una empresa","slug":"editar-empresa","type":"endpoint","title":"Editar empresa"}

putEditar empresa

Endpoint para editar la información de una empresa

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
string
Nombre de la empresa. Longitud máxima permitida: 90. Para Colombia, si la compañía es de una persona natural, se debe enviar este atributo como un objeto, que contiene los atirbutos: `firstName` (obligatorio), `secondName` (opcional), `lastName` (obligatorio).
address:
object
Objeto Address que contiene la dirección de la empresa, compuesto por los atributos `address (string)` dirección y `city (string)` Ciudad.
address:
object
Para Alegra México, este objeto debe contener los atributos : `street (string)`: Calle de la empresa; `exteriorNumber (string)` : Número de exterior; `interiorNumber (string)`: Número de interior; `colony (string)`: Colonia de la empresa; `country (string, obligatorio)`: país de la empresa; `locality (string)`: localidad; `municipality (string)`: Municipio; `state (string, obligatorio)`: estado, `zipCode (number)`: código postal de la empresa.
address:
object
Para perú, el Objeto address que contiene la información de la dirección de la empresa 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.
address:
object
Para Costa Rica, el objeto address con la información de la dirección de la compañía está compuesto por los siguientes atributos: `address (string)` Otras señas, `department (string)` Provincia, `city (string)` Cantón, `district (string)` Distrito, `neighborhood (string)` Barrio. Este atributo se vuelve obligatorio si el tipo de identificación es diferente a "00".
address:
string
Para Colombia, el objeto address con la información de la dirección de la compañía está compuesto por los siguientes atributos: `address (string)` Dirección, `department (string)` Departamento, `city (string)` Ciudad.
identification:
string
Identificación de la empresa. Ej RFC, cédula, NIT, RUC, entre otros. Para la versión Alegra Perú es obligatorio.
identificationObject:
object
Para Costa Rica y Colombia, el atributo identificationObject es un objeto compuesto por los siguientes atributos: `type(string)` tipo de identificación (Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia)), `number (string)` número de identificación. Parámetro obligatorio si se tiene facturación electrónica activa.
email:
string
Correo electrónico de la empresa.
phone:
string
Teléfono de la empresa.
website:
string
Página web de la empresa.
decimalPrecision:
integer
Indica la precisión decimal que tiene configurada la empresa para la creación de documentos. Las facturas de venta y demás documentos que se creen se aproximan teniendo en cuenta este atributo.
invoicePreferences:
string
Objeto que contiene las preferencias de facturación de la empresa. Contiene los siguientes atributos: `defaultAnotation` : Notas por defecto que la empresa tiene configuradas en la aplicación. `defaultTermsAndConditions`: Términos y condiciones por defecto que tiene configuradas la empresa.
kindOfPerson:
string
Para Colombia, indica el tipo de persona, Consulta el catálogo de parámetros correspondiente a cada país haciendo clic [aquí](https://developer.alegra.com/docs/colombia). Parámetro obligatorio si se tiene facturación electrónica activa.
settings:
string
Objeto compuesto por las configuraciones de la compañía. Contiene el atributo `electronicInvoicing`, el cuál se envía en true para activar facturación electrónica.

Documentation

[block:callout] { "type": "warning", "title": "Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos." } [/block] Por ejemplo para editar el nombre de la empresa se debe enviar el siguiente JSON: ```JSON { "name" : "Nuevo nombre de mi empresa" } ``` Para eliminar algún dato de la empresa enviar el atributo en null, así: ```JSON { "phone" : null } ``` Se retorna la empresa que se ha modificado.

User Information

Try It Out

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