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": 0,
"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-08-06 02:58:46",
"updated_at": "2020-08-06 02:58:46",
"company_id": 1,
"is_custom": false,
"branch_id": null,
"use_conversion": false,
"available": false,
"related_iso_expected": "USD",
"related_iso_error": false
}
Insertar Currency
Insertar Currency de Branch
Método |
URI |
Cabeceras |
POST |
/companies/{companyId}/branches/{branchId}/currencies |
Authorization |
{
"iso": "required|max:3|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"
}
Insertar Currency de Branch
Método |
URI |
Cabeceras |
POST |
/companies/{companyId}/branches/{branchId}/currencies |
Authorization |
{
"iso": "required|max:3|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"
}
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:3|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"
}
Eliminar Currency
Método |
URI |
Cabeceras |
DELETE |
/companies/{companyId}/currencies/{currencyId} |
Authorization |
Acciones de Currency
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