BranchPendingFee

La comisión que el comercio (Branch) debe pagar a la plataforma por una Order. Se recalcula con calculate() a partir de las tasas (order_tax_*, client_tax_*), el monto de la orden y los impuestos de facturación de la company. Alimenta las GeneralInvoice y el reporte de comisiones (earnings-report).

Montos (todos × 100)

order_e2 (monto de la orden), order_fee_e2 (comisión bruta sobre el monto), client_fee_e2 (parte asumida/exenta del cliente), fee_e2 (comisión neta del comercio, con impuestos), discount_e2 (descuento aplicado), total_e2 (monto a pagar al comercio), fiscal_base_amount_e2 (base imponible). Las tasas son order_tax_flat_e2 + order_tax_prc y client_tax_flat_e2 + client_tax_prc (flat en céntimos, prc como fracción); branch_tax_* es la diferencia neta entre ambas.

Estado (status)

Bitmask de flags protegidos: is_in_progress (la orden sigue en curso), is_canceled (orden cancelada), is_completed (orden completada correctamente), is_conciliated (la comisión ya fue conciliada en una factura; ver conciliation).

Notas y gotchas

  • company_id está en $hidden.
  • details guarda el desglose del cálculo.

Estructura de Datos

Atributo Tipo Descripción
id int
order_e2 int Monto de la orden considerado para la comisión, en céntimos (× 100)
order_tax_flat_e2 int Tasa fija de comisión sobre el monto de la orden, en céntimos (× 100)
order_tax_prc float Tasa porcentual de comisión sobre el monto de la orden (fracción)
order_fee_e2 int Comisión bruta sobre el monto de la orden (× 100)
client_tax_flat_e2 int Tasa fija asumida por el cliente, en céntimos (× 100)
client_tax_prc float Tasa porcentual asumida por el cliente (fracción)
client_fee_e2 int Parte de la comisión asumida o exenta del cliente (× 100)
fee_e2 int Comisión neta del comercio, con impuestos (× 100)
total_e2 int Monto a pagar al comercio por la orden (× 100)
status int Bitmask de estado (ver "Estado")
created_at datetime\|null
updated_at datetime\|null
branch_id int {@link Branch} que paga la comisión
order_id int {@link Order} que origina la comisión
company_id int {@link Company} de la comisión (oculto)
discount_e2 int Descuento aplicado a la orden (× 100)
details array Desglose del cálculo de la comisión
fiscal_base_amount_e2 int\|null Base imponible de la comisión (× 100)
is_in_progress bool BitMask (({@link self::status} & 0x1) !== 0)
is_canceled bool BitMask (({@link self::status} & 0x40) !== 0)
is_completed bool BitMask (({@link self::status} & 0x80) !== 0)
is_conciliated bool BitMask (({@link self::status} & 0x100) !== 0)
allLogs ApiLog>
branch Branch {@link Branch} que paga la comisión
branch_tax_flat_e2 int Tasa fija neta del comercio (order − client), en céntimos
branch_tax_prc int Tasa porcentual neta del comercio (order − client)
company Company {@link Company} de la comisión
conciliation PendingFeeConciliation\|null Registro de conciliación de la comisión
logs ApiLog>
order Order {@link Order} que origina la comisión 
{
    "id": 3127,
    "order_e2": 3580,
    "order_tax_flat_e2": 0,
    "order_tax_prc": 0.157,
    "order_fee_e2": 563,
    "client_tax_flat_e2": 0,
    "client_tax_prc": 0.07,
    "client_fee_e2": 251,
    "fee_e2": 312,
    "total_e2": 3268,
    "status": 384,
    "created_at": "2022-02-10 15:47:08",
    "updated_at": "2025-04-02 12:23:14",
    "branch_id": 37,
    "order_id": 5764,
    "discount_e2": 0,
    "details": [],
    "fiscal_base_amount_e2": 3086,
    "is_in_progress": false,
    "is_canceled": false,
    "is_completed": true,
    "is_conciliated": true
}

Endpoints

Listar BranchPendingFee

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

Listar comisiones de comercio

Listado paginado de BranchPendingFee de la company (con los filtros estándar).

Método URI Cabeceras
GET /companies/{companyId}/branch-pending-fees Authorization

Listar BranchPendingFee de Branch

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

Listar comisiones de una sucursal

Listado paginado de BranchPendingFee de la Branch indicada.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/branch-pending-fees Authorization

Mostrar BranchPendingFee

{info} Soporta: Carga dinámica

Mostrar comisión de comercio

Devuelve la BranchPendingFee por su id, con su desglose y estado.

Método URI Cabeceras
GET /companies/{companyId}/branch-pending-fees/{branchPendingFeeId} Authorization

Actualizar BranchPendingFee

Actualizar comisión de comercio

Ajusta las tasas (order_tax_flat_e2, order_tax_prc) de la BranchPendingFee y recalcula los montos derivados (order_fee_e2, fee_e2, total_e2…).

Método URI Cabeceras
PATCH /companies/{companyId}/branch-pending-fees/{branchPendingFeeId} Authorization 
{
    "order_tax_flat_e2": "integer|min:0",
    "order_tax_prc": "numeric|between:0.0000,1.0000"
}

Acciones de BranchPendingFee

Reporte de comisiones de comercio

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

Resumen de BranchPendingFee de la company (o de una Branch, si se indica branchId), cruzado con las órdenes, sus conciliaciones y las líneas de factura.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/branch-pending-fees/report Authorization

Reporte de comisiones de comercio

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

Resumen de BranchPendingFee de la company (o de una Branch, si se indica branchId), cruzado con las órdenes, sus conciliaciones y las líneas de factura.

Método URI Cabeceras
GET /companies/{companyId}/branches/{branchId}/branch-pending-fees/report Authorization

Relaciones