Query CCCs assigned to an authorisation

⚠️

Add test=1 to run tests without real effects. In production, omit this parameter.

Returns the list of contribution account codes (CCC) assigned to the authorisation of the certificate in use. The list in TGSS can be very large (hundreds or thousands of CCCs), so the response is delivered paginated by cursor: each call returns a segment of the list and, while segments remain, a pagination.page_after field that must be sent in the next request to continue. When page_after is no longer returned, the end of the list has been reached.

Parameters

test (number (1)) : For testing, add the test=1 parameter. It must be omitted in production.
authorized_num (integer) : Optional. Authorisation number, required when the user has more than one authorised user. When the request is made it returns the authorised users if there is more than one, with status 428
situacionCCC (string (1)) : Optional. Filter by CCC status. Defaults to T. Possible values:
- T: All (default)
- A: Registered (active)
- B: Deregistered (inactive)
page_after (UUID) : Optional. Continuation cursor returned in data.pagination.page_after of the previous response. It must be sent to obtain the next segment of the list. If omitted, the query starts from the beginning. The cursor is consumed when used (it is not reusable).

GET /ccc-asignados

{
  "test": 1,
  "authorized_num": "999252",
  "situacionCCC": "T",
  "page_after": "d2fc9d33-ac2d-4555-9d48-51f9196d45a7"
}

Successful response

Respuesta

{
    "success": true,
    "message": "OK",
    "status": 200,
    "data": {
        "authorized_num": "257020",
        "pagination": {
            "current_page": 1,
            "total_pages": 3,
            "total_records": 1232,
            "_total": 124,
            "page_after": "d2fc9d33-ac2d-4555-9d48-51f9196d45a7"
        },
        "list": [
            {
                "regimen": "0138",
                "ccc": "96372899466",
                "razSoc": "Partida de Naranjo",
                "ccc_type": "S Secundario",
                "startDate": "2024-01-21",
                "code_situacion": "02",
                "ccc_situacion": "ALTA",
                "ccc_es_practica": "SI"
            },
            {
                "regimen": "0111",
                "ccc": "20120294786",
                "razSoc": "Empresa Bautista e Hija",
                "ccc_type": "S Secundario",
                "startDate": "2024-10-25",
                "code_situacion": "06",
                "ccc_situacion": "ALTA POR REINICIO",
                "ccc_es_practica": "SI"
            }
        ]
    }
}

Response status 428

Respuesta

{
    "success": false,
    "message": "Existen más de una autorización, por favor especifique la autorización a consultar {authorized_num}.",
    "status": 428,
    "data": {
        "list": [
            {
                "numero": "194114",
                "razSoc": "Vanegas-Burgos"
            },
            {
                "numero": "631504",
                "razSoc": "Viajes Tovar S. de H."
            },
            {
                "numero": "843705",
                "razSoc": "Corporación Juárez"
            },
            {
                "numero": "928612",
                "razSoc": "Serrato de Quintanilla"
            },
            {
                "numero": "875039",
                "razSoc": "Armenta y Candelaria"
            }
        ]
    }
}