Operación 1015: Consulta de Condiciones de Pago

Método: GET.
Parámetro del header "operation": 1015.
Header:

Parámetro Header	Valor	Observaciones
content-type	application/json
x-session-token	{{token}}	Completar con el token asignado a su usuario. Tener en cuenta que en este esquema de autenticación no debe agregar el termino "bearer" antes del token.
operation	1015	Completar con el número de operación.

En esta imagen se muestra como configurar la consulta:

Esta operación admite los siguientes parámetros de forma opcional:

Parámetro	Ejemplo	observaciones
offset	0	Parámetro utilizado para la paginación. Indica a partir de qué registro se desea consultar. El valor por defecto es 0 (cero), si no se especifica se tomará ese valor.
limit	100	Parámetro utilizado para la paginación. Indica la cantidad máxima de registro que devolverá la consulta. Rango válido: 1 a 100, si no se especifica o se pone un valor inválido se tomará el valor por defecto 100

Tener en cuenta que los parámetros admiten valores únicos. A continuación se muestra imagen de parámetros de consulta opcionales:

 
A continuación, detallamos algun ejemplo de consulta posible:

Consulta de listado de condiciones de pago.

Solicitud:

En este caso no se envía ningún parámetro adicional en la URL, ni body.
Se recomienda utilizar los parámetros de paginación en caso de que el total de registros supere los 100.
De no enviarlos tomarán el valor por defecto y siempre devolverá los primeros 100 registros.
La consulta solo devolverá las condiciones de pago habilitadas.

Ejemplo de URL con paginación:    https://api.pcarts.com/operations?limit=4

Respuesta:

Si la consulta se efectuó exitosamente deberá devolver un JSON con la lista de condiciones de pago:

BODY

Observaciones

{     "pay_terms": [         {             "pay_term_code": "Yx59",             "pay_term_desc": "Pago Contado Pesos/Dólares(Ef)",             "pay_term_rate": 0.00         },         {             "pay_term_code": "Yx71",             "pay_term_desc": "Pago Ctado Pesos/Dól (Dep-Che)",             "pay_term_rate": 0.00         },         {             "pay_term_code": "Yx04",             "pay_term_desc": "Cheque al Día 1 dia vto.",             "pay_term_rate": -10.00         },         {             "pay_term_code": "Yx05",             "pay_term_desc": "Cheque 7 Días",             "pay_term_rate": 0.93         }     ],     "Paging": {         "offset": 0,         "limit": 4,         "total": 29     } }

Ejemplo de listado de condiciones de pago con límite de 4.  En el nodo Paging se indicará la cantidad total de registros que devuelve la consulta, así como los valores de offset y limit aplicados. En este ejemplo se consultaron 4 condiciones de pago pero el total disponible son 29. Si no se utiliza el parámetro de límite para la consulta, esta traería el listado completo de condiciones de pago. Recordar que al no enviar ningún parámetro se tomarán los valores por defecto. El campo "pay_term_rate" indica el porcentaje de recargo/ descuento que se aplica con esa condición (los valores negativos corresponden a descuentos).

   

El caso arriba descripto es a modo ejemplificador, los parámetros se pueden combinar según la necesidad.
Esta operación admite una única forma de consulta.