Descripción general

Endpoint /bills

Una factura de proveedor contiene los siguientes atributos:

Nombre

Tipo

Descripción

Ejemplo

id

Integer

Identificador único que representa una factura específica. La aplicación lo asigna automáticamente.

1

date

String. Formato yyyy-MM-dd

Fecha de la factura.

2019-02-12

dueDate

String. Formato yyyy-MM-dd

Fecha de vencimiento de la factura.

2019-02-12

observations

String

Observaciones de la factura.

Estas son las observaciones de mi factura.

termsConditions

String

Términos y condiciones aplicables a la factura.

Limite garantía de 1 año

subjectToProportionality (República Dominicana)

Boolean

Solo para versión Alegra República Dominicana

Si está presente y es true indica si es una operación sujeta a proporcionalidad. Si está activa se considera el ITBIS en la proporcionalidad de los reportes.

true

status

String

Estado de la factura, las opciones posibles son:

  • open : La factura no se ha pagado completamente.
  • closed: La factura se ha pagado completamente

open

provider

Object

Objeto que contiene la información del proveedor asociado a la factura.

{
"id": 1,
"name": "Coorporación Alegrate",                        "identification": "159.549.847",
"email": "[email protected]",                      "phonePrimary": "999-99-99",
"phoneSecondary": "",
"fax": "",
"mobile": "(333) 555-55-55"
}

provider (Perú)

Object

Solo para versión Alegra Perú

Objeto que contiene la información del proveedor asociado a la factura.

En Perú el atributo identification pasa a ser un objeto que contiene el atributo number con la identificación del proveedor.

{
"id": 1,
"name": "Coorporación Alegrate",                        "identification": {
"number": "159.549.847"
},
"email": "[email protected]",                      "phonePrimary": "999-99-99",
"phoneSecondary": "",
"fax": "",
"mobile": "(333) 555-55-55"
}

provider (Colombia)

Object

Solo para versión Alegra Colombia

Objeto que contiene la información del proveedor asociado a la factura.

En Colombia contiene el atributo adicional identificationObject el cual es un objeto que consta del atributo number con la identificación del proveedor.

{
"id": 1,
"name": "Coorporación Alegrate",                        
"identification": "159.549.847",
"identificationObject": {
"number": "159.549.847"
},
"email": "[email protected]",                      "phonePrimary": "999-99-99",
"phoneSecondary": "",
"fax": "",
"mobile": "(333) 555-55-55"
}

numberTemplate

Object

Objeto que contiene la información de la numeración de la factura. Contiene los siguientes atributos:

  • number: Número de la factura.
{
"number" : 520
}

numberTemplate (República Dominicana)

Object

Solo para versión Alegra República Dominicana

Objeto que contiene la información de la numeración de la factura. Contiene los siguientes atributos:

  • prefix: Prefijo de la factura.
  • number: Número de la factura.
  • informalProvider: Indica si es un proveedor informal.
{
"prefix": "B1",
"number" : 100000001,
"informalProvider": true
}

numberTemplate (Colombia)

Object

Solo para versión Alegra Colombia

Objeto que contiene la información de la numeración del documento soporte. Contiene los siguientes atributos:

  • prefix: Prefijo del documento soporte.
  • number: Número del documento soporte.
  • id: Identificador de la resolución del documento soporte.
{
"prefix": "DS",
"number" : 121,
"id": 11
}

total

Double

Total de la factura. Se debe tener en cuenta que el total de la factura es calculado según la precisión decimal que tenga configurada la empresa al momento de crear la factura.

12500.45

totalPaid

Double

Total pagado a la factura.

500.00

balance

Double

Saldo pendiente por pagar a la factura.

12000.45

decimalPrecision

Integer

Precisión decimal de la factura

2

warehouse

Object

Objeto que contiene la información de la bodega de la factura.
Contiene los siguientes atributos:

  • id: Identificador único que representa una bodega específica.
  • name: Nombre de la bodega.
{
"id" : 1,
"name" : "Nombre de la bodega"
}

purchases

Object

Objeto que contiene los productos y categorías de la factura.
Contiene los siguientes atributos:

items: Array de objetos Item, que contiene los productos.
Cada objeto contiene los siguientes atributos:

  • id: Identificador del producto.
  • name: Nombre del producto.
  • discount: Porcentaje de descuento aplicado al producto.
  • observations: Observaciones del producto.
  • tax: Array de objetos tax que indican los impuestos aplicados al producto al momento de la compra.
  • price: Precio de compra del producto.
  • quantity: Cantidad comprada del producto.
  • total: Total del producto (no incluye impuestos).
  • subtotal: Subtotal del producto.

categories: Array de objetos category, que contiene las categorías.
Cada objeto contiene los siguientes atributos:

  • id: Identificador de la categoría.
  • name: Nombre de la categoría.
  • discount: Porcentaje de descuento aplicado a la categoría.
  • observations: Observaciones de la categoría.
  • tax: Array de objetos tax que indican los impuestos aplicados a la categoría al momento de la compra.
  • price: Precio de compra de la categoría.
  • quantity: Cantidad comprada de la categoría.
  • total: Total de la categoría (no incluye impuestos).
  • subtotal: Subtotal de la categoría.
{
"items": [
{
"id": 1,
"name": "Billetera",
"observations": "Billetera de cuero negro",
"discount" : 10,
"tax" : [
{
"id" : 6,
"name" : "IVA",
"percentage" : 16,
"description" : "Impuesto de valor agregado",
"type": "IVA",
"status": "active"
}
],
"price" : 80,
"quantity" : 5,
"total" : 360,
"subtotal": 360
}
],
"categories": [
{
"id": 5091,
"name": "Otros gastos",
"observations": "Observaciones de la categoría.",
"discount" : 10,
"tax" : [
{
"id" : 6,
"name" : "IVA",
"percentage" : 16,
"description" : "Impuesto de valor agregado",
"type": "IVA",
"status": "active"
}
],
"price" : 80,
"quantity" : 5,
"total" : 360,
"subtotal": 360
}
]
}

retentions

Array

Array de objetos retention que indican las retenciones aplicadas a la factura. Cada objeto contiene los siguientes atributos:

  • id: Identificador de la retención.
  • name : Nombre de la retención.
  • percentage: Porcentaje retenido.
  • amount: Valor retenido.
[
{
"id": 1,
"name" : "Compras",
"percentage" : 3,5,
"amount" : 21.315
}
]

currency

Object

Objeto que incluye la información de la moneda asociada a la factura.
Solo se incluye si la compañía tiene activo multimoneda y la factura está en una moneda diferente de la principal de la compañía.

Este objeto contiene:

  • code : Código ISO de la moneda asociada a la empresa.
  • exchangeRate: Tasa de cambio.
{
"code" : "USD",
"symbol" : "$",
"exchangeRae" : 2950
}

payments

Array

Incluye la información de pagos realizados a la factura.
Cada objeto contiene los siguientes atributos:

  • id: Identificador único del pago
  • number: Número del recibo de pago.
  • date: Fecha del pago.
  • amount: Valor pagado.
  • paymentMethod: Método de pago.
  • observations: Observaciones del pago
  • anotation: Notas del pago
  • status: Estado del pago. Las opciones posibles son "open" para un pago activo, y "void" para un pago que se encuentra anulado.
{
id: "123",
number: "5000",
date: "2019-02-12",
amount: "1000",
paymentMethod: "transfer",
observations: "",
anotation: "",
status: "open"
}

stamp (Costa Rica)

Object

Solo para versión Alegra Costa Rica.
Incluye la información de la emisión de la factura.

Este objeto contiene:

  • legalStatus: Indica el estado legal ante la
    entidad reguladora.
  • uuid: Indica la clave del comprobante emitido.
  • date: Fecha en la que se emitió la factura.
  • entityResponse: Respuesta de Hacienda
  • electronicInvoicingVersion: Versión de facturación electrónica con la que se emitió la factura.
  • barCodeContent: Contenido del código QR
  • generateStamp: Indica si se desea emitir la factura.

...
{
"legalStatus":"ACCEPTED",
"uuid":"50623071900011319081300100001010000030106198617620",
"date": "2019-07-23 15:08:39",
"entityResponse": "Este comprobante fue aceptado en el ambiente de pruebas, por lo cual no tiene validez para fines tributarios\n\ncodigo, mensaje, fila, columna\n-37, "Estimado obligado tributario los datos suministrados en provincia, cantón y distrito del 'emisor' no concuerdan con la información registrada en la Dirección General de Tributación, favor proceder actualizar sus datos.", 0, 0\n",
"electronicInvoicingVersion": "4.3",
"barCodeContent": ""
}
...

costCenter

Object

Objeto costCenter que indica el centro de costo asociado a la factura. Éste contiene los siguientes atributos:

  • id: Identificador del centro de costo
  • code: Código del centro de costo
  • name: Nombre del centro de costo
  • description: Descripción del centro de costo
  • status: Estatus del centro de costo (activo o inactivo)

...
{
"id": "2",
"code": "CC01",
"name": "Centro de costo ventas general",
"description": "Ingresos y gastos de ventas generales",
"status": "active"
}
...

saleCondition (Costa Rica)

String

Solo para versión Alegra Costa Rica

Indica la condición de la venta. Si se desea emitir la factura, este atributo se vuelve obligatorio.

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

CASH

paymentMethod (Costa Rica)

String

Solo para versión Alegra Costa Rica.

Indica el método de pago de la factura. Si se desea emitir la factura, este atributo se vuelve obligatorio.

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

CASH

economicActivity (Costa Rica)

Object

Solo para versión Alegra Costa Rica

Objeto donde se envía la actividad económica. Si se desea emitir la factura, este atributo se vuelve obligatorio.

Este objeto puede contener:

  • id: string que indica el id de la forma de pago.

  • value: string que indica el nombre de la forma de pago.

En caso de enviar los dos atributos se la dará prioridad al id

...
{
"id": "11302",
"value": "Cultivo de frutas"
}
...

physicalDocument (Costa Rica)

Object

Solo para versión Alegra Costa Rica

Objeto donde se envía la información del documento físico en caso de existir.

Contiene los siguientes atributos:

  • number: Número físico del documento.
  • date: Fecha del documento físico

...
{
"number": "12345654",
"date": "2020-04-1"
}
...

physicalDocument (Colombia)

Object

Solo para versión Alegra Colombia

Objeto donde se envía la información del documento físico en caso de existir.

Contiene los siguientes atributos:

  • number: Número físico del documento.

...
{
"number": "12345654"
}
...

comments

Array

Arreglo comments con la información de cada uno de los comentarios de la factura de proveedor.

{
"id": 1,
"idCompany": "2",
"idUser": "2",
"userName": "Usuario",
"comment": "mi primer comment",
"createdAt": "02/09/2020 10:01:13",
 "updatedAt": "02/09/2020 10:01:13",
"publishedAt": "02/09/2020 10:01"
}