COLOMBIA Medellín +57 (4) 322 98 80 Bogotá +57 (1) 381 90 40 Cali +57 (2) 891 28 46 Barranquilla +57 (5) 316 10 34 ARGENTINA Buenos Aires +54 (11) 5217 5933 ESPAÑA Madrid +34 (910) 601 691 MÉXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 ESTADOS UNIDOS New York +1 (914) 373 71 36 REPÚBLICA DOMINICANA Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERÚ Lima +51 (1) 644 91 39

Consultar obligación

< / >

Consultar obligación

URL:

https://{{wolkvox_server}}/server/API/v2/collections/queryObligation.php

Descripción:

Esta API proporciona la funcionalidad de búsqueda de obligaciones en el módulo de colecciones. Permite buscar y recuperar información detallada sobre obligaciones asociadas a los registros en su operación.

¿Cómo funciona?:

Esta API funciona a través de un cuerpo de tipo “raw” y una petición en GET, la cual requiere para su correcto funcionamiento los siguientes campos:

– En las cabeceras de la petición se requiere:

Wolkvox-Token

– En el cuerpo de la petición se requiere:

operation
obligation
wolkvox-id

REQUEST

KEY	DESCRIPCIÓN	EJEMPLO
Wolkvox-Token	Es el token configurado por el cliente en la página de CRM.	A8K3J7F2
operation	Es el nombre de la operación del CRM.	“operation”:”modulodeprueba”
obligation	Es el identificador de la obligación.	“obligation”: “6669999 API”
wolkvox_id	Es el identificador del registros en collections.	“wolkvox_id”: “61fa3”

REQUEST

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/collections/queryObligation.php',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS =>'{
    "operation": "",
    "obligation": "",
    "wolkvox_id": ""
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request GET 'https://{{wolkvox_server}}/server/API/v2/collections/queryObligation.php' \
--header 'Wolkvox-Token: {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "operation": "",
    "obligation": "",
    "wolkvox_id": ""
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\": \"\",\r\n    \"obligation\": \"\",\r\n    \"wolkvox_id\": \"\"\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/collections/queryObligation.php")
  .method("GET", body)
  .addHeader("Wolkvox-Token", "{{token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

url = "https://{{wolkvox_server}}/server/API/v2/collections/queryObligation.php"

payload = json.dumps({
  "operation": "",
  "obligation": "",
  "wolkvox_id": ""
})
headers = {
  'Wolkvox-Token': '{{token}}',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

RESPONSE

KEY	DESCRIPCIÓN	EJEMPLO

id	Código de identificación de la obligación en el registro indicado.	“id”: “obl1”
name	Nombre de la obligación.	“name”: “Factura 12345 – Pago Pendiente”
total_balance	Es el saldo total.	“total_balance”: “10000”
portfolio_type	Es el tipo de cartera asociado.	“portfolio_type”: “VIP Client”
last_pay	Indica el monto del último pago asociado.	“last_pay”: “2000”
last_pay_date	Indica la fecha del último pago asociado.	“last_pay_date”: “06-06-2023”
expiring_date	Indica la fecha de vencimiento.	“expiring_date”: “07-07-2023”
days_delay	Indica el número de días de retraso.	“days_delay”: “90”
form	Es un conjunto de datos que representa los campos adicionales (en las obligaciones) que se crearon como complementarios a los predeterminados.	“form”: [ { “name”: “Titulacion”, “value”: “valor de titulacion” }, { “name”: “Frecuencia”, “value”: “Frecuentado” } ]

				
					{
    "code": "200",
    "error": "null",
    "msg": "x records were are found",
    "data": [
        {
            "id": "",
            "name": "",
            "total_balance": "",
            "portfolio_type": "",
            "last_pay": "",
            "last_pay_date": "",
            "expiring_date": "",
            "days_delay": "",
            "form": [
                {
                    "name": "",
                    "value": ""
                }
            ]
        }
    ]
}

Posibles códigos de error