Descripción general

Endpoint /company

Una empresa contiene los siguientes atributos:

Nombre

Tipo

Descripción

Ejemplo

name

String

Nombre de la empresa.

Mi empresa en Alegra

identification

String

Identificación de la empresa. Ej RFC, cédula, NIT, RUC, entre otros.

900.123.123-8

identification (Chile)

String

Si se quiere factura electrónicamente, el formato de la identificación debe ser el mismo que el RUT, es decir, entre 6 y 8 dígitos, un guión ("-") y otro dígito o una K.

66666666-6

identificationObject

Object

Solo para versión Alegra Costa Rica y Alegra Colombia.

Objeto que indica la identificación de la compañía.

Contiene los siguientes atributos:

  • type: Indica el tipo de identificación, se debe enviar el id correspondiente al tipo de identificación. Consulta el catálogo de parámetros correspondiente a cada país haciendo clic aquí.

  • number: Indica el número de identificación.

Solo para Alegra Colombia

  • dv: Indica el dígito de verificación de identificación, se hace visible únicamente cuando el tipo de identificación es NIT. El dígito de verificación se calcula automaticamente a partir de la identificación.

{
"identificationObject": {
"type": "CC",
"number": "123456789"
}
}

identificationObject (Panamá)

Object

Solo para Alegra Panamá
Objeto que indica la identificación del contacto.

Contiene los siguientes atributos:

kindOfPerson: indica el tipo de persona, puede ser natural (PERSON_ENTITY) o jurídica (LEGAL_ENTITY).
number: RUC de la compañía.
dv: Dígito verificador.

{
"identificationObject": {
"kindOfPerson": "LEGAL_ENTITY",
"number": "11111-1-25646",
"dv": "08"
}
}

phone

String

Teléfono de la empresa.

111 111 11 11

website

String

Página web de la empresa.

www.alegra.com

email

String

Correo electrónico de la empresa.

[email protected]

regime

String

Régimen de la empresa.

COMMON_REGIME

currency

Object

Moneda principal de la compañía.

{
"code" : "COP",
"symbol" : "$",
"exchangeRate" : 2950
}

multicurrency

Boolean

Retorna true si la empresa tiene activa la funcionalidad de multimoneda. Si es así la empresa puede realizar movimientos en múltiples monedas.

true

address

Object

Objeto que contiene la información de la dirección de la empresa.

Contiene los siguientes atributos:

  • address : Indica la dirección de la empresa.
  • city: Ciudad de la empresa.

{
"address" : "Calle principal #45",
"city" : "Barcelona"
}

address (México)

Object

Solo para versión Alegra México.

Objeto que contiene la información de la dirección de la empresa.

Contiene los siguientes atributos:

  • street: Indica la calle de la empresa.
  • exteriorNumber: Indica el número de exterior.
  • interiorNumber: Indica el número de interior.
  • colony: Indica la colonia de la empresa.
  • country: Indica el país de la empresa.
  • locality: Indica la localidad.
  • municipality. Indica el municipio.
  • state : Indica el estado de la empresa.
  • zipCode: Indica el código postal de la empresa.

{
"street" : "Centenario",
"exteriorNumber" : 95,
"interiorNumber" : "",
"colony" : "Coyoacán",
"country" : "México",
"locality" : "",
"municipality" : "",
"state" : "D.F",
"zipCode" : "12345"
}

address (Costa rica)

Object

Solo para versión Alegra Costa Rica.

Objeto que contiene la información de la dirección de la empresa.

Contiene los siguientes atributos:

  • address: Indica otras señas de la ubicación.
  • department: Indica el nombre de la provincia.
  • city: Indica el nombre del cantón. (El cantón debe pertenecer a la provincia)
  • district: Indica el nombre del distrito. (El distrito debe pertenecer al cantón)
  • neighborhood: Indica el nombre del barrio. (El barrio debe pertenecer al distrito)

{
"address" : "Calle 3",
"department" : "Limón",
"city" : "Pococí",
"district" : "Colorado",
"neighborhood" : "Verdades"
}

address (Argentina)

Object

Solo para versión Alegra Argentina.

Objeto que contiene la información de la dirección de la empresa.

Contiene los siguientes atributos:

  • address: Indica otras señas de la ubicación.
  • province: Indica el nombre de la provincia.
  • city: Indica el nombre de la ciudad. (La ciudad debe pertenecer a la provincia).
  • postalCode: Indica el numero del código postal de la empresa.

{
"province": "Buenos Aires",
"city": "La plata",
"address": "Diagonal 38 # 13-87",
"postalCode": "2221"
}

address (Chile)

Object

Solo para versión Alegra Chile.

Objeto que contiene la información de la dirección de la empresa.

Contiene los siguientes atributos:

  • city: Indica el nombre de la ciudad.
  • region: Indica el nombre de la región.
  • commune: Indica el nombre de la comuna. (La comuna debe pertenecer a la región).
  • description: Indica otras señas de la ubicación.

{
"city": "Santiago",
"region": "Metropolitana",
"commune": "Santiago",
"description": "Av. Grecia 1853-1951"
},

address (Panamá)

Object

Solo para versión Alegra Panamá.
Objeto que contiene la información de la dirección del contacto.

Contiene los siguientes atributos:

  • province: Indica el nombre de la provincia.
  • district: Indica el nombre del distrito.
  • township: Indica el nombre del corregimiento.
  • address: Indica la dirección del contacto.

"address": {
"province": "Bocas del toro",
"district": "Bocas del toro",
"township": "Bastimentos",
"address": "Av. Siempre viva"
}

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.

0

invoicePreferences

Object

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.
"invoicePreferences": {
    "defaultAnotation": "Notas por defecto de mi empresa",
   "defaultTermsAndConditions": "Esta factura se asimila en todos sus efectos a una letra de cambio de conformidad con el Art. 774 del código de comercio. Autorizo que en caso de incumplimiento de esta obligación sea reportado a las centrales de riesgo, se cobraran intereses por mora."
  }

applicationVersion

String

Versión de la aplicación en la cual está registrada la empresa.

colombia

registryDate

String

Fecha y hora de registro de la empresa. Formato yyyy-MM-dd hh-mm-ss

2016-03-07 17:00:07

logo

String

URL de la imagen del logo de la empresa

https://cdn2.alegra.com/website/Logos_Alegra/Logotipo-Alegra.png

timezone

String

Zona horaria que se utiliza en la aplicación

America/Bogota

kindOfPerson (Colombia)

String

Solo para versión Alegra Colombia.

Indica el tipo de persona, se debe enviar el id correspondiente al tipo de persona.
Consulta el catálogo de parámetros correspondiente a cada país haciendo clic aquí.

LEGAL_ENTITY

settings

Object

Indica algunas de las configuraciones que tiene la compañía en Alegra.

Contiene los siguientes atributos:

  • electronicInvoicing (bool): Indica si la compañía tiene facturación electrónica activa.
  • electronicInvoicingVersion (string): Para Colombia, indica la versión de facturación electrónica de la compañía.

{
"electronicInvoicing": true,
"electronicInvoicingVersion": "2.1"
}

activityStartDate (Argentina)

Date

Fecha del inicio de las actividades de la empresa.

2019-11-20

numberIibb (Argentina)

String

Numero de ingresos brutos de la empresa.

123456789

ivaCondition (Argentina)

String

Condición de Iva de la empresa.

IVA_RESPONSABLE (IVA responsable inscripto)

conditionIibb (Argentina)

String

Condición del numero interno bruto.

SIMPLIFIED_REGIME (Régimen simplificado)

setTest (Colombia)

Object

Solo para versión Alegra Colombia.
Objeto que contiene la información del set de pruebas cuando la versión de facturación electrónica es la 2.1

Contiene los siguientes atributos:

  • id : Identificador del set de pruebas
  • status: Estado del envío del set de pruebas, valores: AUTHORIZING En proceso de autorización, AUTHORIZED Autorizado, UNAUTHORIZED No autorizado.

{
"id": "Rd4a4f0d-1Phy-5Z1a-98f7-P3ed2T87Ab80",
"status": "AUTHORIZED"
}

fiscalResponsabilities (Colombia)

Array

Solo para versión Alegra Colombia.
Objeto que contiene la información de las responsabilidades fiscales de la compañía cuando la versión de facturación electrónica es la 2.1.

Consulta el catálogo de parámetros correspondiente a cada país haciendo clic aquí.

[17, 2]

tradeName (Colombia)

String

Solo para versión Alegra Colombia.
Nombre comercial de la compañía.

Mi empresa

giro (Chile)

String

Solo para versión Alegra Chile

Giro de la empresa, este campo es obligatorio si se quiere facturar electrónicamente.

Giro de negocio

economicActivities (Chile)

Array

Solo para versión Alegra Chile.

Array donde se indica las actividades económicas asociadas a la compañía, cada actividad económica, se debe enviar a su vez como un objeto, en el cual se envia id o value, en el caso de envíar id y value, se dará prioridad al id. Adicionalmente, se debe asignar un main (boolean) a una actividad.

Consulta el listado de actividades económicas aquí.

"economicActivities": [
{
"id": "011102",
"main": true
},
{
"value": "Cultivo de papas",
},
{
"id": "011103",
"value": "Cultivo de avena"
}
]

economicActivity (Costa Rica)

Int

Actividad económica de la empresa.

11101

isActiveNoIvaDay (Colombia)

Boolean

Retorna true si la fecha corresponde a un día sin IVA y la empresa cumple con los requisitos para participar en este programa.

...
"isActiveNoIvaDay": true,
...

showNoIvaDaysOnItems (Colombia)

Boolean

Retorna true si la empresa tiene activada la configuración del día sin iva.

...
"showNoIvaDaysOnItems": true,
...