Currency

Representa a una moneda de una Company.

  • enabled: Indica si la moneda puede ser utilizada para procesar pagos.
  • iso: Identificador de la moneda.
  • symbol: Símbolo de la moneda.
  • conversion_factor: Factor de conversión para la moneda. Se utiliza para convertir el precio desde la moneda especificada en related_iso hacia la moneda especificada en iso. En el ejemplo de arriba, corresponde a 1 VES = 75000 * USD.
  • related_iso: Moneda desde la cual se hace la conversión. Si is_local == true o is_international == true, entonces related_iso debe coincidir con la moneda local; en los demás casos, related_iso debe coincidir con el iso de la moneda internacional.
  • decimals_count: Cantidad de decimales a mostrar.
  • format: Formato de visualización de la moneda, donde $ representa al símbolo y 0.00 al monto.
  • decimal_point: Punto decimal. Se suele utilizar . o , según la moneda.
  • use_thousands_separator: Especifica si se deben separar los miles.
  • thousands_separator: Separador de miles.
  • is_local: Indica que la moneda es local (usada por defecto para los productos).
  • is_international: Indica que la moneda es utilizada como base para la conversión de las monedas no locales.

Modelo Currency

{
    "id": 1,
    "enabled": true,
    "iso": "USD",
    "symbol": "$",
    "conversion_factor": 1,
    "related_iso": "USD",
    "decimals_count": 2,
    "format": "$ 0.00",
    "decimal_point": ".",
    "use_thousands_separator": true,
    "thousands_separator": ",",
    "is_local": true,
    "is_international": true,
    "created_at": "2020-04-17 01:07:30",
    "updated_at": "2025-03-27 13:27:03",
    "company_id": 1,
    "is_custom": true,
    "branch_id": null,
    "auto_sync": false,
    "auto_sync_provider": "legacy",
    "use_conversion": false,
    "available": true,
    "related_iso_expected": "USD",
    "related_iso_error": false
}
Atributo Tipo Descripción
id int -
enabled bool -
iso string -
symbol string -
conversion_factor float -
related_iso string -
decimals_count int -
format string -
decimal_point string -
use_thousands_separator bool -
thousands_separator string -
is_local bool -
is_international bool -
created_at datetime\|null -
updated_at datetime\|null -
company_id int -
is_custom bool -
auto_sync bool -
auto_sync_provider string -
available bool -
related_iso_error bool -
related_iso_expected string -
use_conversion bool -

Insertar Currency

Insertar Currency de Branch

Método URI Cabeceras
POST /companies/{companyId}/branches/{branchId}/currencies Authorization 
{
    "iso": "required|max:8|string",
    "symbol": "required|max:4|string",
    "conversion_factor": "numeric|min:0.00001",
    "decimals_count": "integer|min:0|max:2",
    "format": {
        "string": true,
        "regex": "/^(\$.*0.00)|(0.00.*\$)$/"
    },
    "decimal_point": "string|min:1|max:1",
    "use_thousands_separator": "boolean",
    "thousands_separator": "string|min:1|max:1",
    "is_custom": "boolean",
    "auto_sync": "boolean",
    "auto_sync_provider": "string|in:legacy,ext,bcv,today"
}

Insertar Currency de Branch

Método URI Cabeceras
POST /companies/{companyId}/branches/{branchId}/currencies Authorization 
{
    "iso": "required|max:8|string",
    "symbol": "required|max:4|string",
    "conversion_factor": "numeric|min:0.00001",
    "decimals_count": "integer|min:0|max:2",
    "format": {
        "string": true,
        "regex": "/^(\$.*0.00)|(0.00.*\$)$/"
    },
    "decimal_point": "string|min:1|max:1",
    "use_thousands_separator": "boolean",
    "thousands_separator": "string|min:1|max:1",
    "is_custom": "boolean",
    "auto_sync": "boolean",
    "auto_sync_provider": "string|in:legacy,ext,bcv,today"
}

Listar Currency

Listar Currency de Branch

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/currencies N/A

Listar Currency de Branch

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/currencies N/A

Mostrar Currency

{info} Soporta: Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/currencies/{currencyId} N/A

Actualizar Currency

Método URI Cabeceras
PATCH /companies/{companyId}/currencies/{currencyId} Authorization 
{
    "related_iso": "required|max:8|string",
    "symbol": "max:4|string",
    "conversion_factor": "numeric|min:0.00001",
    "decimals_count": "integer|min:0|max:2",
    "format": {
        "string": true,
        "regex": "/^(\$.*0.00)|(0.00.*\$)$/"
    },
    "decimal_point": "string|min:1|max:1",
    "use_thousands_separator": "boolean",
    "thousands_separator": "string|min:1|max:1",
    "is_custom": "boolean",
    "auto_sync": "boolean",
    "auto_sync_provider": "string|in:legacy,ext,bcv,today"
}

Eliminar Currency

Método URI Cabeceras
DELETE /companies/{companyId}/currencies/{currencyId} Authorization

Acciones de Currency

Convert

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/currency-convert N/A 
{
    "currency_iso_from": "required|string|min:3|max:8",
    "currency_iso_to": "required|string|min:3|max:8",
    "amount_e2": "required|integer|min:0"
}

Set Enabled

Método URI Cabeceras
POST /companies/{companyId}/currencies/{currencyId}/set-enabled Authorization

Set Disabled

Método URI Cabeceras
POST /companies/{companyId}/currencies/{currencyId}/set-disabled Authorization

Set Local

Método URI Cabeceras
POST /companies/{companyId}/currencies/{currencyId}/set-local Authorization

Set International

Método URI Cabeceras
POST /companies/{companyId}/currencies/{currencyId}/set-international Authorization

Enlaces de Currency