Data Consolidation

In this section, 4 requests for the results API will be presented, containing consolidated information where we can assemble graphs and so on.

1 - Results grouped by diagnoses

NOTE: All requests for the results panel must be made through the address https://resultadowebapi.asisprojetos.com.br

GET /api/v1/resultado/{path}

Parameters:

• path*: Path identifier of the tax obligation
• cnpj*: CNPJ of the company for which the results were generated
• inicio*: Start date of results
• fim*: Final date of results
• impl: Implementation identifier (string containing implementation name)

Headers:

• app-key: app key
• account-key: account key

Response:

• JSON containing the total amount of results grouped by diagnosis. Example:

        [
            {
                "id": "string",
                "label": "string",
                "total": "integer"
            }
        ]
    

2 - Synthetic results

POST /api/v1/resultado/{path}/sintetico

Parameters:

• path*: Path identifier of the tax obligation
• cnpj*: CNPJ of the company for which the results were generated
• inicio*: Start date of results
• fim*: Final date of results
• diagnostico: Diagnosis of results
• impl: Implementation identifier (string containing implementation name)
• size: Maximum amount of items returned per page
• page: Query Page Number

Headers:

• app-key: app key
• account-key: account key

Response:

• JSON containing the results of audits for the specified period. Example:

    {
        "content": [
            {
                "auditoriaId": "integer",
                "codigo": "integer",
                "nome": "string",
                "ementa": "string",
                "nivelId": "integer",
                "diagnostico": "string",
                "qtde": "integer",
                "soma": "integer"
            }
        ],
        "pageable": {
            "sort": {
                "sorted": "boolean",
                "unsorted": "boolean",
                "empty": "boolean"
            },
            "pageNumber": "integer",
            "pageSize": "integer",
            "offset": "integer",
            "unpaged": "boolean",
            "paged": "boolean"
        },
        "totalPages": "integer",
        "totalElements": "integer",
        "last": "boolean",
        "first": "boolean",
        "sort": {
            "sorted": "boolean",
            "unsorted": "boolean",
            "empty": "boolean"
        },
        "number": "integer",
        "numberOfElements": "integer",
        "size": "integer",
        "empty": "boolean"
    }      
    

3 - Analytical results

POST /api/v1/resultado/{path}/analitico

Parameters:

• path*: Path identifier of the tax obligation
• cnpj*: CNPJ of the company for which the results were generated
• inicio*: Start date of results
• fim*: Final date of results
• auditoriaId*: ID of the audit for which the results were generated
• impl: Operation identifier
• size: Maximum amount of items returned per page
• page: Query Page Number

Headers:

• app-key: app key
• account-key: account key

Response:

• JSON containing the results of audit items for the specified period. Example:

    {
        "content": [
            {
                "numProt": "integer",
                "mesRef": "integer",
                "qtde": "integer",
                "razaoSocial": "string",
                "cnpj": "string"
            }
        ],
        "pageable": {
            "sort": {
                "sorted": "boolean",
                "unsorted": "boolean",
                "empty": "boolean"
            },
            "pageSize": "integer",
            "pageNumber": "integer",
            "offset": "integer",
            "paged": "boolean",
            "unpaged": "boolean"
        },
        "totalPages": "integer",
        "totalElements": "integer",
        "last": "boolean",
        "first": "boolean",
        "sort": {
            "sorted": "boolean",
            "unsorted": "boolean",
            "empty": "boolean"
        },
        "number": "integer",
        "numberOfElements": "integer",
        "size": "integer",
        "empty": "boolean"
    }      
    

4 - Results grouped by fiscal obligation

POST /api/v1/resultado/obrigacao

Parameters:

• cnpj*: CNPJ of the company for which the results were generated
• inicio*: Start date of results
• fim*: Final date of results

Headers:

• app-key: app key
• account-key: account key

Response:

• JSON containing the number of audits per tax obligation for the specified period. Example:

    [
        {
            "nome": "string",
            "path": "string",
            "qtde": "integer"
        }
    ]