Monedas

Listar monedas creadas en Bsale. Bsale soporta el uso 1 o más monedas. (Ej, USD en factura de exportación). Para su uso, se debe crear una lista de precio en base a la moneda creada.

Estructura JSON

Al realizar una petición HTTP, el servicio retornara un JSON con la siguiente estructura:

{
  "href": "https://api.bsale.cl/v1/coins/1.json",
  "id": 1,
  "name": "Peso Chileno",
  "symbol": "$",
  "decimals": 0,
  "totalRound": 0
}
  • href, url de la moneda (String).
  • id, identificador único de la moneda (Integer).
  • name, nombre de la moneda (String).
  • symbol, símbolo de la moneda (String).
  • decimals, decimales que permite la moneda.
  • totalRound, indica si la moneda redondea totales, No(0) o Si (1)(Boolean).

GET lista de monedas

  • GET /v1/coins.json retornara todas las monedas.

####Parametros

  • limit, limita la cantidad de items de una respuesta JSON, por defecto el limit es 25, el máximo permitido es 50.
  • offset, permite paginar los items de una respuesta JSON, por defecto el offset es 0.
  • fields, solo devolver atributos especificos de un recurso
  • expand, permite expandir instancias y colecciones.
  • name, Permite filtrar por nombre de la moneda.
  • symbol, filtra por símbolo de la moneda.
  • state, (0 o 1) indica si las monedas están activas(0) inactivas(1).
  • default, permite filtrar la moneda por defecto del sistema.

####Ejemplos

  • GET /v1/coins.json?limit=10&offset=0
  • GET /v1/coins.json?fields=[name,symbol,state]
  • GET /v1/coins.json?default=true

####Respuesta

{
  "href": "https://api.bsale.cl/v1/coins.json",
  "count": 3,
  "limit": 25,
  "offset": 0,
  "items": [
    {
      "href": "https://api.bsale.cl/v1/coins/3.json",
      "id": 3,
      "name": "Dolar",
      "symbol": "USD",
      "decimals": 2,
      "totalRound": 0
    },
    {
      "href": "https://api.bsale.cl/v1/coins/1.json",
      "id": 1,
      "name": "Peso Chileno",
      "symbol": "$",
      "decimals": 0,
      "totalRound": 0
    },
    {
      "href": "https://api.bsale.cl/v1/coins/2.json",
      "id": 2,
      "name": "UF",
      "symbol": "(UF)",
      "decimals": 2,
      "totalRound": 0
    }
  ]
}

GET una moneda

  • GET /v1/coins/1.json retornara una moneda específica.

####Respuesta

{
  "href": "https://api.bsale.cl/v1/coins/1.json",
  "id": 1,
  "name": "Peso Chileno",
  "symbol": "$",
  "decimals": 0,
  "totalRound": 0
}

GET tipo cambio moneda

  • GET /v1/coins/2/exchange_rate/1533223010.json

Retornara el tipo de cambio de una moneda para una específica, donde 2 es el id de la moneda y 1533223010 es la fecha en unix time (02/08/2018).

####Respuesta

{
  "exchangeRate": 27204.23
}

GET cantidad de monedas

  • GET /v1/coins/count.json

####Parametros

  • state, permite filtrar por estado, activos (0) inactivos (1).

####Respuesta

{
  "count": 3
}