Listar Formas de Pago

Permite obtener el listado de formas de pago registradas en el sistema de forma paginada. Este endpoint soporta filtros por código de forma de pago, fecha de creación y fecha de modificación, así como ordenamiento configurable.

Método: GET

Endpoint

https://api.ventasremotas.com/v1/payment-methods

Nota

Es necesario el envío del token de acceso Subscription-Key para hacer uso de este endpoint. Para ver cómo generar el token, vea Activación Suscripción a RSales API.

Encabezados de la solicitud

Header	Valor	Descripción	Requerido
Accept	application/json	Indica que la respuesta debe estar en formato JSON	No
Subscription-Key	{subscription_key}	Clave de suscripción para acceder a la API	Sí
Authorization	Bearer {access_token}	Token de acceso obtenido del endpoint /token	Sí

---

Parámetros de Consulta (Query Parameters)

Todos los parámetros son opcionales. Si no se especifican, se retornan todas las formas de pago con la paginación por defecto.

Filtros

Parámetro	Tipo	Descripción
code	String	Filtra por código exacto de forma de pago. Longitud máxima: 10 caracteres.
created_from	Date	Retorna formas de pago cuya fecha de creación es mayor o igual a este valor. Formato: YYYY-MM-DD.
modified_from	Date	Retorna formas de pago cuya fecha de modificación es mayor o igual a este valor. Formato: YYYY-MM-DD.

Filtros de fecha

Los filtros created_from y modified_from se agrupan con un operador OR cuando se usan juntos. Esto significa que al enviar ambos, se retornarán formas de pago que cumplan cualquiera de las dos condiciones (creadas desde esa fecha o modificadas desde esa fecha).

Ordenamiento

Parámetro	Tipo	Descripción
sort	String	Campo y dirección de ordenamiento. Por defecto: fecha de creación descendente.

Campos de ordenamiento disponibles

Valor	Descripción
created_at	Ordena por fecha de creación ascendente (ASC)
-created_at	Ordena por fecha de creación descendente (DESC)

Ordenamiento por defecto

Si no se especifica el parámetro sort, los resultados se ordenan por fecha de creación descendente (más recientes primero).

Paginación

Parámetro	Tipo	Por defecto	Restricciones	Descripción
page	Number	1	Mínimo: 1	Número de página (1-indexed)
limit	Number	100	Mínimo: 1, Máximo: 1000	Cantidad de resultados por página

---

Ejemplo de Solicitud

Petición básica (sin filtros)

curl -X GET "https://api.ventasremotas.com/v1/payment-methods" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro por código

curl -X GET "https://api.ventasremotas.com/v1/payment-methods?code=EFE" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con filtro de fecha y paginación

curl -X GET "https://api.ventasremotas.com/v1/payment-methods?created_from=2024-01-01&page=1&limit=50" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con ordenamiento ascendente

curl -X GET "https://api.ventasremotas.com/v1/payment-methods?sort=created_at&page=1&limit=100" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

Petición con múltiples filtros de fecha

curl -X GET "https://api.ventasremotas.com/v1/payment-methods?created_from=2024-01-01&modified_from=2024-06-01&sort=-created_at&limit=200" \
  -H "Accept: application/json" \
  -H "Subscription-Key: tu-subscription-key" \
  -H "Authorization: Bearer tu-access-token"

---

Ejemplo de Respuesta

200 - OK

{
    "data": [
        {
            "code": "EFE",
            "description": "Efectivo",
            "orders_state": "APROBADO",
            "payments_state": "APROBADO",
            "invoices_state": "APROBADO",
            "quotes_state": "APROBADO",
            "returns_state": "APROBADO",
            "online_invoices_state": null,
            "online_orders_state": null,
            "online_quotes_state": null,
            "module": "A",
            "method_type": "1",
            "require_bank": "N",
            "require_account_number": "N",
            "accumulate_payment": "N",
            "state": "Y",
            "exclusive_for_sales": null,
            "maximum_value_per_transaction": null,
            "payment_type": "1",
            "require_attachment": "N",
            "require_receipt_number": "N",
            "allow_online_payment": "N",
            "require_bank_account_origin": "N",
            "require_bank_origin_cheque": "N",
            "created_at": "2024-06-15T10:30:00",
            "updated_at": null
        }
    ],
    "meta": {
        "totalItems": 15,
        "itemCount": 15,
        "itemsPerPage": 100,
        "totalPages": 1,
        "currentPage": 1
    },
    "links": {
        "self": "https://api.ventasremotas.com/v1/payment-methods?page=1&limit=100",
        "first": "https://api.ventasremotas.com/v1/payment-methods?page=1&limit=100",
        "prev": null,
        "next": null,
        "last": "https://api.ventasremotas.com/v1/payment-methods?page=1&limit=100"
    }
}

Descripción de campos de respuesta

Objeto data[] (Forma de Pago)

Cada elemento del array data contiene los siguientes campos:

Campo	Tipo	Descripción
code	String	Código único de la forma de pago
description	String	Descripción de la forma de pago
orders_state	String	Estado por defecto que se asignará a los pedidos al utilizar esta forma de pago (puede ser null)
payments_state	String	Estado por defecto que se asignará a los recaudos al utilizar esta forma de pago (puede ser null)
invoices_state	String	Estado por defecto que se asignará a las facturas al utilizar esta forma de pago (puede ser null)
quotes_state	String	Estado por defecto que se asignará a las cotizaciones al utilizar esta forma de pago (puede ser null)
returns_state	String	Estado por defecto que se asignará a las devoluciones al utilizar esta forma de pago (puede ser null)
online_invoices_state	String	Estado por defecto para facturas con pago en línea (puede ser null)
online_orders_state	String	Estado por defecto para pedidos con pago en línea (puede ser null)
online_quotes_state	String	Estado por defecto para cotizaciones con pago en línea (puede ser null)
module	String	Módulo en el que se utiliza la forma de pago. P = Transacciones de Venta (Pedidos, Cotizaciones, Facturas y Devoluciones), R = Recaudos, A = Ambos (puede ser null)
method_type	String	Tipo de pago. 0 = Ninguna, 1 = Efectivo, 2 = Cheque, 3 = Consignación (puede ser null)
require_bank	String	Indica si se requiere seleccionar un banco: Y o N (puede ser null)
require_account_number	String	Indica si se requiere ingresar el número de cuenta bancaria: Y o N (puede ser null)
accumulate_payment	String	Indica si se debe acumular el recaudo: Y o N (puede ser null)
state	String	Estado de la forma de pago (Activo/Inactivo): Y o N
exclusive_for_sales	String	Exclusiva para Facturas (F) o Pedidos (P). Aplica si a nivel de usuario la opción “Permitir Cambiar formas de pago” está en “Uso exclusivo para venta” (puede ser null)
maximum_value_per_transaction	Number	Valor máximo permitido por transacción en los módulos de venta (Pedido, Factura, Devolución o Cotización) (puede ser null)
payment_type	String	Mostrar en tipo de recaudo. 0 = Ninguna, 1 = Ambos, 2 = Abono, 3 = Anticipo (puede ser null)
require_attachment	String	Indica si se requiere adjuntar un archivo o comprobante: Y o N (puede ser null)
require_receipt_number	String	Indica si se requiere ingresar el número de comprobante: Y o N (puede ser null)
allow_online_payment	String	Indica si la forma de pago permite pago en línea: Y o N (puede ser null)
require_bank_account_origin	String	Indica si se requiere la cuenta bancaria de origen: Y o N (puede ser null)
require_bank_origin_cheque	String	Indica si se requiere el banco de origen del cheque: Y o N (puede ser null)
created_at	DateTime	Fecha y hora de creación de la forma de pago. Formato: yyyy-MM-ddTHH:mm:ss
updated_at	DateTime	Fecha y hora de última modificación. Formato: yyyy-MM-ddTHH:mm:ss (puede ser null)

Objeto meta (Metadatos de paginación)

Campo	Tipo	Descripción
totalItems	Number	Cantidad total de formas de pago que coinciden con los filtros
itemCount	Number	Cantidad de formas de pago en la página actual
itemsPerPage	Number	Cantidad de items por página solicitados
totalPages	Number	Total de páginas disponibles
currentPage	Number	Número de la página actual

Objeto links (Enlaces de navegación)

Campo	Tipo	Descripción
self	String	URL de la página actual
first	String	URL de la primera página
prev	String	URL de la página anterior (null si es la primera página)
next	String	URL de la página siguiente (null si es la última página)
last	String	URL de la última página

Status 400

Los errores de validación de parámetros de consulta retornan un array de errores, donde cada error indica el parámetro problemático:

Filtro no válido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "invalid_param",
            "message": "The field is not a valid filter parameter"
        }
    ]
}

Valor de filtro vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "code",
            "message": "Value must not be empty"
        }
    ]
}

Fecha con formato inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "created_from",
            "message": "Value '15-01-2024' is not a valid date (expected format: YYYY-MM-DD)"
        }
    ]
}

Valor excede longitud máxima

{
    "statusCode": 400,
    "errors": [
        {
            "param": "code",
            "message": "Value exceeds maximum length of 10"
        }
    ]
}

Campo de ordenamiento inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "sort",
            "message": "The field 'invalid_field' is not a valid sort field."
        }
    ]
}

Parámetro sort vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "sort",
            "message": "The parameter must not be empty"
        }
    ]
}

Parámetro de paginación inválido

{
    "statusCode": 400,
    "errors": [
        {
            "param": "page",
            "message": "The parameter must be a valid integer"
        }
    ]
}

Página menor al mínimo

{
    "statusCode": 400,
    "errors": [
        {
            "param": "page",
            "message": "The parameter must be greater than or equal to 1"
        }
    ]
}

Límite excede el máximo

{
    "statusCode": 400,
    "errors": [
        {
            "param": "limit",
            "message": "The parameter must be less than or equal to 1000"
        }
    ]
}

Límite vacío

{
    "statusCode": 400,
    "errors": [
        {
            "param": "limit",
            "message": "The parameter must not be empty"
        }
    ]
}

Errores múltiples

El endpoint puede retornar múltiples errores de validación en una sola respuesta. Por ejemplo, si se envía un filtro inválido y un parámetro de paginación incorrecto al mismo tiempo, ambos errores aparecerán en el array de errors.

Tabla resumen de errores de validación

Errores de filtros:

Error	Aplica a
The field is not a valid filter parameter	Cualquier parámetro no reconocido
Value must not be empty	code
Value 'X' is not a valid date (expected format: YYYY-MM-DD)	created_from, modified_from
Value exceeds maximum length of 10	code

Errores de ordenamiento:

Error	Aplica a
The parameter must not be empty	sort
The field 'X' is not a valid sort field.	sort

Errores de paginación:

Error	Aplica a
The parameter must not be empty	page, limit
The parameter must be a valid integer	page, limit
The parameter must be greater than or equal to 1	page, limit
The parameter must be less than or equal to 1000	limit

Status 500

Error de conexión a base de datos

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Error connecting to database"
        }
    ]
}

Error de operación en base de datos

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Database operation failed"
        }
    ]
}

Error en validaciones

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Unexpected error in the validations"
        }
    ]
}

Error inesperado

{
    "statusCode": 500,
    "errors": [
        {
            "message": "Unexpected error"
        }
    ]
}

Error del Servidor

Estos errores indican problemas internos en el servidor o la base de datos. Si persisten, contacta al equipo de soporte.