Descripción general

Endpoint /purchase-orders

Una órden de compra contiene los siguientes atributos:

Nombre

Tipo

Descripción

Ejemplo

id

Integer

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

1

date

String. Formato yyyy-MM-dd

Fecha de la órden de compra.

2019-02-12

deliveryDate

String. Formato yyyy-MM-dd

Fecha de entrega de la órden de compra.

2019-02-22

observations

String

Observaciones de la órden de compra.

Estas son las observaciones de mi órden de compra.

termsConditions

String

Términos y condiciones aplicables a la órden de compra.

Limite garantía de 1 año

anotation

String

Notas de la órden de compra.

Se debe entregar en empaque especial.

status

String

Estado de la órden de compra, las opciones posibles son:

  • open : La órden no se ha pagado completamente.
  • closed: La órden se ha pagado completamente.
  • Void: La órden se ha anulado.

open

provider

Object

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

{
"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 órden.

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 órden.

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 órden. Contiene los siguientes atributos:

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

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 órden. 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
}

total

Double

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

12500.45

subTotal

Double

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

10500.00

decimalPrecision

Integer

Precisión decimal de la órden de compra.

2

warehouse

Object

Objeto que contiene la información de la bodega de la órden.
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 órden.
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
}
]
}

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
}