Saltar al contenido
Facturador

Ver método de pago

GET /api/payment-method-types/{payment_method_type_id}

Autenticación: Bearer del usuario del tenant (Authorization: Bearer <api_token>).

Devuelve un método de pago con su regla de destino.

Quién puede usarlo: solo usuarios de tipo administrador (type = admin). Con el token de un vendedor responde 403.

Formato de respuesta: estándar {success, data, message?} (registro único).

Parámetros de la ruta:

Campo Tipo Obligatorio Descripción / valores permitidos
payment_method_type_id string Sí Código del método (01, 13...). Respeta el cero a la izquierda.

Campos de cada método:

Campo Tipo Descripción
id string Código interno de 2 caracteres. Es el payment_method_type_id que se envía al registrar cobros y pagos.
description string Nombre.
sort_order integer Posición en las listas (menor = primero).
is_active boolean Se ofrece en los formularios.
is_credit / number_days boolean / integer Condición de crédito y su plazo.
is_payment_medium boolean false en las condiciones de crédito.
goes_to_cash_drawer boolean Entra al cajón (efectivo).
use_for_income / use_for_expense boolean Para cobrar / para pagar.
destination_rule string Regla de destino (any, type:<tipo>, account:<id>).
default_destination_id integer o null Cuenta fija (regla account:<id>).
allowed_destination_type string o null Tipo de cuenta permitido (regla type:<tipo>).
destination_label string Texto del destino para mostrar (Caja, Cualquier banco, nombre de la cuenta, Se elige al registrar).
uses_label string Cobros y pagos, Solo cobros, Solo pagos, Sin uso o Condición de pago.
has_no_use boolean Medio de pago sin ningún uso (queda inactivo).
can_delete boolean false en los códigos del sistema 01 a 10.
logo_url / initials / monogram_color string Logotipo subido (o null) y monograma para mostrar cuando no hay logo.

Errores:

  • 403 si el usuario no es administrador.
  • 404 si el código no existe (o es una condición reservada del sistema, que no se administra por la API).
  • 401 sin token o con un token inválido.

Parámetros

Parámetro Dónde Obligatorio Ejemplo Descripción
payment_method_type_id ruta sí 13

Respuestas

200 — Método

{
  "success": true,
  "data": {
    "id": "13",
    "description": "Yape",
    "sort_order": 30,
    "is_active": true,
    "is_credit": false,
    "number_days": 0,
    "has_card": false,
    "charge": 0.0,
    "is_payment_medium": true,
    "goes_to_cash_drawer": false,
    "use_for_income": true,
    "use_for_expense": true,
    "destination_rule": "account:4",
    "default_destination_id": 4,
    "allowed_destination_type": null,
    "destination_label": "YAPE TIENDA CENTRO",
    "uses_label": "Cobros y pagos",
    "has_no_use": false,
    "can_delete": true,
    "logo_url": "https://empresa.dominio/logo/payment-methods/yape-13.png",
    "initials": "YA",
    "monogram_color": "#6b3fa0"
  }
}

404 — No existe

{
  "success": false,
  "message": "Registro no encontrado."
}

403 — Usuario no administrador

{
  "success": false,
  "message": "Solo un administrador puede gestionar este recurso."
}

Pruébalo

Prueba este endpoint con tu empresa y tu token: elige la URL en Servers, pega el token en Authorize y haz clic en Try it out.