Consultar metadatos (CUNE) de una Nómina Electrónica

Consultar metadatos (CUNE) de una Nómina Electrónica#

Con este servicio, es posible consultar el estado actual de las nóminas electrónicas transmitidas de forma asincrónica.

Para consumir la API, es importante tener en cuenta el entorno en el que se va a trabajar. SOVOS Saphety dispone de dos ambientes, los cuales se describen en el apartado de Entornos.

Consumo del método de consulta de estado.#

estadoNE

El Verbo Http (acción) que se utiliza para la consulta de estado de este documento es:

GET

El método que se utiliza para la consulta de este documento es:

    /v2/{virtualOperator}/payroll/{documentId}/status

Para esta petición se requiere como parámetro el alias de su operador virtual y el código identificador único del documento emitido.

Parámetro 1 - virtualOperator

Recuerde reemplazar en el método el parámetro {virtualOperator} con el alias de su operador virtual en minúsculas, por defecto el alias es “saphety”.

Parámetro 2 - DocumentId

Recuerde reemplazar en el método el parámetro {DocumentId} con el código identificador único del documento emitido.

Respuesta#

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": {
        "Status": "Certified",
        "ValidationErrors": null
    },
    "ResultCode": 200
}

{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": "cufe",
            "Code": "DocumentNotFound",
            "Description": null,
            "ExplanationValues": [
                "88f71533-0a2a-"
            ]
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}

Important

Si al realizar la consulta la respuesta es “Code”: “DocumentNotFound” y deseas conocer el estado o las causas de rechazo, puedes consultarlas a través del siguiente enlace: Obtener Estado o Causales de Rechazo.

Referencia: Swagger#

Para obtener más información, puedes consultar la documentación del API de SOVOS Saphety en Swagger. A continuación, se indican los enlaces según el ambiente: