Nota Ajuste de Eliminación (Nómina)#

Las notas de ajuste de eliminación de nómina electrónica permiten eliminar una nómina individual que contenga uno o varios errores en su creación.

A continuación se describe los métodos y estructuras para la creación de una Nota de Ajuste Tipo Eliminación de una Nómina Electrónica.

Creación de una Nota de Ajuste de Eliminación (NAE).#

Para hacer el consumo de la API se deben tener en cuenta en que entorno se va a trabajar, SOVOS Saphety cuenta con dos ambientes especificados en el apartado de Entornos.

Consumo del método de creación.#

metodoNAE

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

POST

El método que se utiliza para la creación de este documento es:

    /v2/{virtualOperator}/payroll/replacementPayrollAsync

Parameters

Para esta petición se requiere como parámetro el alias de su operador virtual.

Parametro 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”.

Body#

Estructura del mensaje JSON de una Nota de Ajuste de Eliminación (Nómina)#

A continuación encontrara la estructura Base definida por Saphety para la creación de una Nota de Ajuste de Eliminación para Nómina Electrónica.

JSON (DTO)
{
	"TipoNota": "2",
	"Eliminar": {
		"EliminandoPredecesor": {
			"NumeroPred": "ABC1222",
			"CUNEPred": "cd62475de5abcd4d79adea9a9d823c30f82afbad59f4611d597b35518a62c2c63f63b7e1ac565b6e12427d6e15dbd7f3",
			"FechaGenPred": "2021-06-30"
		},
		"NumeroSecuenciaXML": {	
			"Prefijo": "NAE", // Prefijo generado por la plataforma de nomina
			"Consecutivo": "1422" // Consecutivo generado por la plataforma de nomina
		},
		"LugarGeneracionXML": {
			"Pais": "CO",
			"DepartamentoEstado": "11",
			"MunicipioCiudad": "11001",
			"Idioma": "es"
		},
		"InformacionGeneral": {
			"FechaHoraGen": "2021-06-30T13:55:55",
            "PeriodoNomina": "1",
            "TipoMoneda": "COP",
			"TRM": "10"			
		},
		"Notas": [
			"Eliminar"
		],
		"Empleador": {				
			"NIT": "{{nit}}" // nit de la empresa emisora o empleador
		}
	},
	"CorrelationDocumentId": "POSTMAN-{{$timestamp}}" // Codigo unico generado por la plataforma de nomina.
}

Respuesta#

{
    "IsValid": true,
    "Warnings": [],
    "Errors": [],
    "ResultData": "7290c7be-815f-43eb-a6ea-387350653275",
    "ResultCode": 200
}
{
    "IsValid": false,
    "Warnings": [],
    "Errors": [
        {
            "Field": null,
            "Code": "DeserializationError",
            "Description": "Invalid character after parsing property name. Expected ':' but got: E. Path 'TipoNota', line 4, position 3.",
            "ExplanationValues": []
        }
    ],
    "ResultData": null,
    "ResultCode": 400
}

Referencia: Swagger#

Si quieres más información dirígete a Swagger que es el modelo del API de SOVOS Saphety, para el ambiente de QA https://api-factura-electronica-co-qa.saphety.com/swagger/index.html y para el ambiente de producción https://api-factura-electronica-co.saphety.com/swagger/index.html