API Documentos Contables/Subcentro Costos

Descripción: Esta API permite la sincronización de los Subcentros de costos entre SERPI y la plataforma que lo requiera.

Autorización: Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

Beneficio:

Tipos de peticiones: GET

¿Cómo funciona?

• Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
• En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.

Métodos

<Tabs> <Tab name = "API Consulta (GET) ">

EndPoint: https://www.apis.serpi.com.co/api/v1/SubCentroCosto

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/SubCentroCosto?limite=50&pagina=1

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Parámetros

Parámetro	Tipo de dato	Requerido	Descripción
Límite	int	No	Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
Página	int	No	Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página

Response

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "codigo": "01",
            "abreviatura": "ADMI",
            "descripcion": "ADMINISTRACION",
            "id_centro_costo": 1,
            "descripcion_centro_costo": "ADMINISTRACION",
            "cuenta_salario_integral": 1234567,
            "cuenta_sueldo": 1234567,
            "cuenta_horas_extra": 1234567,
            "cuenta_recargos": 1234567,
            "cuenta_comision": 1234567,
            "cuenta_incapacidad": 1234567,
            "cuenta_auxiliar_transporte": 1234567,
            "cuenta_cesantias": 1234567,
            "cuenta_int_cesantias": 1234567,
            "cuenta_prima_servicio": 1234567,
            "cuenta_vacaciones": 1234567,
            "cuenta_auxilio": 1234567,
            "cuenta_aprendiz": 1234567,
            "cuenta_bonificacion": 1234567,
            "cuenta_indemnizaciones_laborales": 1234567,
            "cuenta_aporte_arl_sura": 1234567,
            "cuenta_monetizacion_sena": 1234567,
            "cuenta_interes_cesantias_credito": 1234567,
            "cuenta_cesantias_credito": 1234567,
            "cuenta_prima_servicio_credito": 1234567,
            "cuenta_vacaciones_credito": 1234567,
            "cuenta_retencion_credito": 1234567,
            "cuenta_prestamos_otras_obligaciones": 1234567,
            "cuenta_poliza": 1234567,
            "cuenta_cesantias_consolidaciones": 1234567,
            "cuenta_cesantias_intereses_consolidaciones": 1234567,
            "cuenta_prima_servicio_consolidaciones": 1234567,
            "cuenta_vacaciones_consolidaciones": 1234567,
            "cuenta_cesantias_ley_anterior_consolidaciones": 1234567
        }
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

Campos de resultados

Campo	Tipo de dato	Descripción
id	int	Identificador del subcentro de costo
codigo	string	Código único del subcentro de costo
abreviatura	string	Abreviatura del subcentro de costo
descripcion	string	Descripción del subcentro de costo
id_centro_costo	int	Identificador del centro de costo
descripcion_centro_costo	string	Descripción del centro de costo
cuenta_salario_integral	int	Cuenta de salario integral
cuenta_sueldo	int	Cuenta de sueldo
cuenta_horas_extra	int	Cuenta de horas extra
cuenta_recargos	int	Cuenta de recargos
cuenta_comision	int	Cuenta de comisión
cuenta_incapacidad	int	Cuenta de incapacidad
cuenta_auxiliar_transporte	int	Cuenta de auxilio de transporte
cuenta_cesantias	int	Cuenta de cesantías
cuenta_int_cesantias	int	Cuenta de intereses sobre cesantías
cuenta_prima_servicio	int	Cuenta de prima de servicio
cuenta_vacaciones	int	Cuenta de vacaciones
cuenta_auxilio	int	Cuenta de auxilio
cuenta_aprendiz	int	Cuenta de aprendiz
cuenta_bonificacion	int	Cuenta de bonificación
cuenta_indemnizaciones_laborales	int	Cuenta de indemnizaciones laborales
cuenta_aporte_arl_sura	int	Cuenta de aporte ARL SURA
cuenta_monetizacion_sena	int	Cuenta de monetización del SENA
cuenta_interes_cesantias_credito	int	Cuenta de intereses sobre cesantías (crédito)
cuenta_cesantias_credito	int	Cuenta de cesantías (crédito)
cuenta_prima_servicio_credito	int	Cuenta de prima de servicio (crédito)
cuenta_vacaciones_credito	int	Cuenta de vacaciones (crédito)
cuenta_retencion_credito	int	Cuenta de retención (crédito)
cuenta_prestamos_otras_obligaciones	int	Cuenta de préstamos y otras obligaciones
cuenta_poliza	int	Cuenta de póliza
cuenta_cesantias_consolidaciones	int	Cuenta de cesantías (consolidaciones)
cuenta_cesantias_intereses_consolidaciones	int	Cuenta de intereses sobre cesantías (consolidaciones)
cuenta_prima_servicio_consolidaciones	int	Cuenta de prima de servicio (consolidaciones)
cuenta_vacaciones_consolidaciones	int	Cuenta de vacaciones (consolidaciones)
cuenta_cesantias_ley_anterior_consolidaciones	int	Cuenta de cesantías ley anterior (consolidaciones)

</Tab>

</Tabs>

Códigos de estado HTTP

Código	Descripción
200	La solicitud ha sido exitosa
201	La solicitud ha tenido éxito y ha llevado a la creación de un recurso
204	La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
400	El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
401	La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
403	El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
404	El recurso solicitado no se ha encontrado en el servidor
500	Internal Server Error
503	El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal

¿Cómo consumir la API?

<Tabs>

<Tab name = "Java"> Request

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://localhost:44305/api/v1/SubCentroCosto")
  .method("GET", body)
  .addHeader("secretkey", "{{secret key}}")
  .addHeader("Authorization", "Bearer{{token}}")
  .build();
Response response = client.newCall(request).execute();

</Tab>

<Tab name = "C#"> Request

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/SubCentroCosto");
request.Headers.Add("secretkey", "{{secret key}}");
request.Headers.Add("Authorization", "Bearer{{token}}");
var content = new StringContent("", null, "text/plain");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

</Tab>

<Tab name = "PHP"> Request

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/SubCentroCosto');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'secretkey' => '{{secret key}}',
  'Authorization' => 'Bearer{{token}}'
));
$request->setBody('');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

</Tab>

</Tabs>