BalanceMovement

Modelo BalanceMovement

{
    "id": 1,
    "number": 1,
    "initial_balance_e2": 0,
    "amount_e2": 10000,
    "final_balance_e2": 10000,
    "type": "adjustment",
    "description": "test",
    "is_deferred": false,
    "created_at": "2021-03-05 14:49:48",
    "updated_at": "2021-03-05 14:49:48",
    "author_id": 1,
    "currency_iso": "USD",
    "related_model": null,
    "amount": {
        "amount_e2": 10000,
        "currency_iso": "USD",
        "formatted_iso": "USD 100.00",
        "formatted": "100.00$"
    },
    "related_amount": {
        "amount_e2": 10000,
        "currency_iso": "USD",
        "formatted_iso": "USD 100.00",
        "formatted": "100.00$"
    },
    "final_balance": {
        "amount_e2": 10000,
        "currency_iso": "USD",
        "formatted_iso": "USD 100.00",
        "formatted": "100.00$"
    },
    "related_final_balance": {
        "amount_e2": 10000,
        "currency_iso": "USD",
        "formatted_iso": "USD 100.00",
        "formatted": "100.00$"
    }
}
Atributo Tipo Descripción
id int -
number int -
initial_balance_e2 int -
amount_e2 int -
final_balance_e2 int -
type string -
description string -
is_deferred bool -
created_at datetime\|null -
updated_at datetime\|null -
author_id int\|null -
currency_iso string -
amount Money\|null -
final_balance Money\|null -
related_amount Money\|null -
related_final_balance Money\|null -

Listar BalanceMovement

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

Método URI Cabeceras
GET /companies/{companyId}/balance-movements Authorization 
{
    "type": "required|string|in:account,client,provider,branch,company,city",
    "key": "required|integer|min:1",
    "target_type": "string|regex:/^\w+(,\w+)*$/",
    "report": "integer"
}

Mostrar BalanceMovement

Mostrar Current

Método URI Cabeceras
GET /companies/{companyId}/balance-movements/current Authorization 
{
    "type": "required|string|in:account,client,provider,branch,company,city",
    "key": "required|integer|min:1",
    "target_type": "string|regex:/^\w+(,\w+)*$/",
    "report": "integer"
}

Acciones de BalanceMovement

Store Adjustment

Método URI Cabeceras
POST /companies/{companyId}/balance-movements/adjust Authorization 
{
    "type": "required|string|in:account,client,provider,branch,company,city",
    "key": "required|integer|min:1",
    "amount_e2": "required|int",
    "description": "string|max:128"
}

Index For Related

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

Método URI Cabeceras
GET /companies/{companyId}/orders/{orderId}/balance-movements Authorization

Store Change

Método URI Cabeceras
POST /companies/{companyId}/orders/{orderId}/balance-movements/give-change Authorization 
{
    "amount_e2": "required|int",
    "description": "nullable|string|max:128",
    "is_affecting_provider": "nullable|string|in:shopper,deliverer",
    "remove_provider_fee": "nullable|string|in:shopper,deliverer"
}

Store Transfer

Método URI Cabeceras
POST /companies/{companyId}/orders/{orderId}/balance-movements/transfer Authorization 
{
    "type": "required|string|in:account,client,provider,branch,company,city",
    "key": "required|integer|min:1",
    "amount_e2": "required|int",
    "target": "string",
    "target_type": "string|in:account,client,provider,branch,company,city,client_uuid,email",
    "description": "string|max:128"
}

Show Debts

Método URI Cabeceras
GET /companies/{companyId}/cities/{cityId}/balance-movements/debt Authorization

Enlaces de BalanceMovement