Diferencia entre revisiones de «API Documentos Contables»

De WikiSerpi
Ir a la navegación Ir a la búsqueda
VisualWikitexto
Página creada con «'''Descripción:''' Esta API pemrite la sincronizacion de las actividades vinculadas a proyectos 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, POST, PUT '''¿Cómo…»
 
Sin resumen de edición
 
(No se muestran 7 ediciones intermedias de 4 usuarios)
Línea 1: Línea 1:
'''Descripción:'''
'''Descripción:'''
Esta API pemrite la sincronizacion de las actividades vinculadas a proyectos entre SERPI y la plataforma que lo requiera.  
Esta API permite la sincronizacion de documentos contables entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.


'''Autorización:'''
'''Autorización:'''
Línea 16: Línea 16:
== Métodos ==
== Métodos ==
<Tabs>
<Tabs>
<!-- ***************** GET ****************** -->
<!-- ***************** CONSULTAR ****************** -->
<Tab name = "API Consulta (GET)  ">
<Tab name = "API Consulta Tipos de Documento">
'''GET/users'''
'''GET/users'''


'''EndPoint:'''
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/Actividades
https://www.apis.serpi.com.co/api/v1/DocumentoContable/GetTipoDocumento


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


''' Headers '''
''' Headers '''
Línea 51: Línea 49:
<syntaxhighlight lang="JSON" line="1">
<syntaxhighlight lang="JSON" line="1">
{
{
"success": true
    "success": true,
"code": 200,
    "code": 200,
"message": "x registro(s) encontrados",
    "errors": null,
"result": [
    "message": "2 registro(s) encontrados",
{
    "result": [
             "id": 6,
        {
             "codigo": "GP",
            "id": 1,
             "actividad": "GASTO PORTUARIO",
            "categoriaDocumento": "NC",
             "codigoProyecto": 1
            "prefijo": "RCA",
            "descripcion": "RECIBO DE CAJA"
        },
        {
             "id": 2,
             "categoriaDocumento": "NC",
             "prefijo": "NCC",
             "descripcion": "NOTA CONTABLE"
         }
         }
]
    ]
}
}


{
{
"success": true
    "success": true,
"code": 201,
    "code": 204,
"message": "No se encontraron registros",
    "message": "No se encontraron registros",
"result": []
}
}
</syntaxhighlight>
</syntaxhighlight>


Línea 76: Línea 81:
! Campo !! Tipo de dato !! Descripción
! Campo !! Tipo de dato !! Descripción
|-
|-
| id || int || Corresponde al identificador de la Actividad
| id || int || Corresponde al identificador del tipo de documento
|-
|-
| codigo || string || Codigo de Actividad
| categoriaDocumento  || string || Categoría del tipo de documento
|-
|-
| Actividad || string || Descripcion Actividad
| prefijo || string || Prefijo del tipo de documento
|-
|-
| codigoProyecto || int || identificador del proyecto correspondiente
| descripcion || string || Descripción del tipo de documento
|}
|}
</Tab>
</Tab>


<!-- ***************** POST ****************** -->
<!-- ***************** CONSULTAR ****************** -->
<Tab name = "API Creación (POST) ">
<Tab name = "API Consultar Documentos Contables">
'''POST /users'''
'''POST /users'''


'''EndPoint:'''
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/Actividades
https://www.apis.serpi.com.co/api/v1/DocumentoContable/ConsultarDocumentoContables?limite=10&pagina=1


''' Headers '''
''' Headers '''
Línea 100: Línea 105:
|}
|}


'''Authorization:'''
'''Body:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>
 
'''Request'''
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
{
     "codigo": "PRE",
     "tiposDocumentos": [15,16],
     "actividad": "PRUEBA",
    "numeroDesde": null,
     "codigoProyecto": 1
     "numeroHasta": null,
    "fechaDesde": "2023-01-01",
     "fechaHasta": "2023-01-31"
}
}
</syntaxhighlight>
</syntaxhighlight>


''' Campos del request'''
''' Campos del request'''
{| class="wikitable left"
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
! Campo !! Tipo !! Requerido !! Descripción
|-
| tiposDocumentos || Array [Int] || SI || Array de enteros. Son los Ids de los tipos de documentos (Api Consulta tipos documento)
|-
| numeroDesde || int || NO || Numero inicial para filtrar por rango de números de documentos
|-
|-
| codigo || string || 50 || SI || codigo de Actividad
| numeroHasta || int || NO || Numero final para filtrar por rango de números de documentos
|-
|-
| actividad || string || 50 || SI || Descripcion Actividad
| fechaDesde || string || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
|-
| codigoProyecto|| int || 50 || SI || identificador del proyecto correspondiente
| fechaHasta || bool || SI || Fecha final para filtrar por rango de fecha del documento
|}
|}


'''Authorization:'''
'''Authorization:'''
Línea 136: Línea 142:
{
{
     "success": true,
     "success": true,
     "code": 201,
     "code": 200,
     "errors": null,
     "errors": null,
     "message": "registro creado exitosamente"
     "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 111,
            "categoriaDocumento": "CCO",
            "prefijo": "COM",
            "numeroDoc": 1,
            "nitTerceroEnc": "1234567890",
            "nombreTerceroEnc": "ALEJANDRA LOPEZ LOPEZ",
            "fechaDocumento": "2023-03-01",
            "detalles": [
                {
                    "cuenta": 52954501,
                    "nitTerceroDet": "1234567890",
                    "nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
                    "naturaleza": "D",
                    "crucePrefijo": null,
                    "cruceNumero": null,
                    "fechaVencimiento": null,
                    "valor": 67900.00000,
                    "baseImpuesto": 0.00000,
                    "cuota": 0,
                    "detalle": "SERV DE TRANSP INFORMAL",
                    "idSubcentroCosto": 4,
                    "idCentroOperacion": 1,
                    "idProyecto": null,
                    "idActividad": null,
                    "idSucursal": null
                },
                {
                    "cuenta": 23359501,
                    "nitTerceroDet": "1234567890",
                    "nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
                    "naturaleza": "C",
                    "crucePrefijo": "COM",
                    "cruceNumero": 3272,
                    "fechaVencimiento": null,
                    "valor": 67900.00000,
                    "baseImpuesto": 0.00000,
                    "cuota": 0,
                    "detalle": "SERV DE TRANSP INFORMAL",
                    "idSubcentroCosto": null,
                    "idCentroOperacion": 1,
                    "idProyecto": null,
                    "idActividad": null,
                    "idSucursal": null
                }
            ]
        }
    ]
}
}


{
{
"success": true
    "success": true,
"code": 201,
    "code": 204,
"message": "No se encontraron registros",
    "message": "No se encontraron registros",
"result": []
}
}
</syntaxhighlight>
</syntaxhighlight>
''' Campos del resultado'''
{| class="wikitable"
! Campo !! Tipo de Dato !! Descripción
|-
| id || int || Corresponde al id del registro contable
|-
| categoriaDocumento  || string || Categoría del tipo de documento
|-
| prefijo || string || Prefijo del tipo de documento
|-
| numeroDoc || Int || Numero del documento contable
|-
| nitTerceroEnc || string || Numero de identificación del tercero del documento contable
|-
| nombreTerceroEnc || string || Nombre del tercero del documento contable
|-
| fechaDocumento || string || Fecha del documento contable
|-
| detalles || Array[ObjetoDetalle]*  || Array de objetos de los detalles del documento contable
|}
''' ObjetoDetalle:'''
{| class="wikitable"
! Campo !! Tipo de Dato !! Descripción
|-
| cuenta || Int || Auxiliar o numero de cuenta contable del movimiento
|-
| nitTerceroDet || string || Numero de identificación del tercero del detalle
|-
| nombreTerceroDet || string || Nombre del tercero del detalle
|-
| naturaleza || string || Naturaleza del movimiento (C=Credito, D=Debito)
|-
| crucePrefijo || string || Prefijo del documento cruce
|-
| cruceNumero || Int || Numero del documento cruce
|-
| fechaVencimiento || string || Fecha de vencimiento del movimiento
|-
| valor || decimal || Valor del movimiento
|-
| baseImpuesto || decimal || Valor base de impuesto
|-
| cuota || Int || Numero de cuota, para documentos que manejan contabilización de cuotas
|-
| detalle || string || Comentarios del movimiento
|-
| idSubcentroCosto || Int || Id del subcentro de costo del movimiento
|-
| idCentroOperacion  || Int || Id del centro de operacion del movimiento
|-
| idProyecto || Int || Id del proyecto del movimiento
|-
| idActividad || Int || Id de la actividad del movimiento
|-
| idSucursal || Int || Id de la sucursal del tercero del movimiento
|}
</Tab>
</Tab>


<!-- ***************** PUT ****************** -->
<!-- ***************** CREAR ****************** -->
<Tab name = "API Modificar(PUT) ">
<Tab name = "API Crear">
'''PUT/users'''


'''EndPoint:'''
'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/Actividades
https://www.apis.serpi.com.co/api/v1/DocumentoContable
 
''' Headers '''
''' Headers '''
{| class="wikitable left"
{| class="wikitable left"
Línea 170: Línea 282:
</syntaxhighlight>
</syntaxhighlight>


'''Request'''
'''Body:'''
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">
{
[
    "id": 314,
    {
    "codigo": "PRI",
        "categoriaDocumento": "CCO",
    "actividad": "PRUEBA",
        "prefijo": "COM",
    "codigoProyecto": 1
        "numeroDoc": 2,
}
        "nitTerceroEnc": "123456789",
        "fechaDocumento": "2023-03-01",
        "detalles": [
            {
                "cuenta": 52954501,
                "nitTerceroDet": "123456789",
                "naturaleza": "D",
                "crucePrefijo": null,
                "cruceNumero": null,
                "fechaVencimiento": null,
                "valor": 67900.00000,
                "baseImpuesto": 0.00000,
                "cuota": 0,
                "detalle": "SERV DE TRANSP INFORMAL",
                "idSubcentroCosto": 4,
                "idCentroOperacion": 1,
                "idProyecto": null,
                "idActividad": null,
                "idSucursal": null
            },
            {
                "cuenta": 23359501,
                "nitTerceroDet": "123456789",
                "naturaleza": "C",
                "crucePrefijo": "COM",
                "cruceNumero": 1,
                "fechaVencimiento": null,
                "valor": 67900.00000,
                "baseImpuesto": 0.00000,
                "cuota": 0,
                "detalle": "SERV DE TRANSP INFORMAL",
                "idSubcentroCosto": null,
                "idCentroOperacion": 1,
                "idProyecto": null,
                "idActividad": null,
                "idSucursal": null
            }
        ]
    }
]
 
</syntaxhighlight>
</syntaxhighlight>


''' Campos del request'''
''' Campos resultado'''
{| class="wikitable left"
{| class="wikitable"
! Campo !! Tipo de dato !! Longitud !! Requerido !! Descripción
! Campo !! Tipo !! Requerido !! Descripción
|-
| categoriaDocumento || string || SI || Categoría del tipo de documento
|-
| prefijo || string || SI || Prefijo del tipo de documento
|-
| numeroDoc || Int || SI || Numero del documento contable
|-
| nitTerceroEnc || string || SI || Numero de identificación del tercero del documento contable
|-
| fechaDocumento || string || SI || Fecha del documento contable
|-
| detalles || Array[ObjetoDetalle]* || SI  || Array de objetos de los detalles del documento contable
|}
 
 
''' ObjetoDetalle:'''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| cuenta || Int || SI || Auxiliar o numero de cuenta contable del movimiento
|-
| nitTerceroDet || string || SI || Numero de identificación del tercero del detalle
|-
| naturaleza || string || SI || Naturaleza del movimiento (C=Credito, D=Debito)
|-
| crucePrefijo || string || NO || Prefijo del documento cruce
|-
| cruceNumero || Int || NO || Numero del documento cruce
|-
| fechaVencimiento || string || NO || Fecha de vencimiento del movimiento
|-
| valor || decimal || SI || Valor del movimiento
|-
| baseImpuesto || decimal  || NO || Valor base de impuesto
|-
| cuota || Int || NO || Numero de cuota, para documentos que manejan contabilización de cuotas
|-
| detalle || string || NO || Comentarios del movimiento
|-
| idSubcentroCosto || Int || NO || Id del subcentro de costo del movimiento
|-
|-
| id || int || 50 || SI || identificador de Actividad
| idCentroOperacion|| Int || NO || Id del centro de operacion del movimiento
|-
|-
| codigo || string || 50 || SI || codigo de Actividad
| idProyecto || Int || NO || Id del proyecto del movimiento
|-
|-
| actividad || string || 50 || SI || Descripcion de Actividad
| idActividad || Int || NO || Id de la actividad del movimiento
|-
|-
| codigoProyecto || int || 50 || SI || identificador del Proyecto
| idSucursal || Int || NO || Id de la sucursal del tercero del movimiento
|}
|}


'''Authorization:'''
'''Authorization:'''
Línea 202: Línea 396:
<syntaxhighlight lang="JSON" line="1">
<syntaxhighlight lang="JSON" line="1">
{
{
"success": true
    "success": true,
    "code": 200,
    "code": 201,
    "message": "registro modificado exitosamente"
    "errors": [],
    "message": "Se crearon 10 de 10 documentos contables"
}
}
</syntaxhighlight>
</Tab>
<!-- ***************** ELIMINAR ****************** -->
<Tab name = "API Eliminar">
'''PUT/users'''


'''EndPoint:'''
https://www.apis.serpi.com.co/api/v1/DocumentoContable
''' Headers '''
{| class="wikitable left"
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}
'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>
'''Body:'''
<syntaxhighlight lang="JSON">
{
{
    "success": false,
    "idTipoDocumento": 6,
    "code": 400,
    "numeroDesde": 1,
    "errors": [
    "numeroHasta": 10000,
        "El campo abreviatura es obligatorio"
    "fechaDesde": "2023-03-01",
    ],
    "fechaHasta": "2023-03-31"
    "message": "Se presentaron errores al modificar el registro"
}
}
</syntaxhighlight>


''' Campos Solicitados '''
{| class="wikitable"
! Campo !! Tipo !! Requerido !! Descripción
|-
| idTipoDocumento || int || SI || Id del tipo de documento
|-
| numeroDesde || int || SI || Numero inicial para filtrar por rango de números de documentos
|-
| numeroHasta || int || SI || Numero final para filtrar por rango de números de documentos
|-
| fechaDesde || string || SI || Fecha inicial para filtrar por rango de fecha del documento
|-
| fechaHasta || bool || SI || Fecha final para filtrar por rango de fecha del documento
|}






'''Authorization:'''
<syntaxhighlight line="1">
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>
'''Response'''
<syntaxhighlight lang="JSON" line="1">
{
{
    "success": false,
    "success": true,
    "code": 204,
    "code": 200,
    "errors": null,
    "errors": [],
    "message": "No se encontraron registros con el id xx"
    "message": "Se eliminaron 10 de 10 documentos contables "
}
}
</syntaxhighlight>
</syntaxhighlight>
</Tab>
</Tab>
</Tabs>
</Tabs>
== Códigos de estado HTTP ==
{| class="wikitable left"
! 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? ==
== ¿Cómo consumir la API? ==
Línea 235: Línea 502:
<Tab name = "Java">
<Tab name = "Java">
'''Request'''
'''Request'''
<syntaxhighlight lang="java" line="1">
<syntaxhighlight lang="java">
OkHttpClient client = new OkHttpClient().newBuilder()
OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
   .build();
Línea 241: Línea 508:
RequestBody body = RequestBody.create(mediaType, "");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
Request request = new Request.Builder()
   .url("https:///www.apis.serpi.com.co/api/v1/Actividades")
   .url("https://localhost:44305/api/v1/DocumentoContable")
   .method("GET", body)
   .method("GET", body)
   .addHeader("secretkey", "{Secret Key}")
   .addHeader("secretkey", "{{secret key}}")
   .addHeader("Authorization", "{Bearer Token}")
   .addHeader("Authorization", "Bearer{{token}}")
   .build();
   .build();
Response response = client.newCall(request).execute();
Response response = client.newCall(request).execute();
</syntaxhighlight>
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
</syntaxhighlight>
</syntaxhighlight>
</Tab>
</Tab>


<Tab name = "Python">
<Tab name = "C#">
'''Request'''
'''Request'''
<syntaxhighlight lang="java" line="1">
<syntaxhighlight lang="c#">
import requests
var client = new HttpClient();
 
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/DocumentoContable");
url = "https://www.apis.serpi.com.co/api/v1/Actividades"
request.Headers.Add("secretkey", "{{secret key}}");
 
request.Headers.Add("Authorization", "Bearer{{token}}");
payload = {}
var content = new StringContent("", null, "text/plain");
headers = {
request.Content = content;
  'secretkey': '{Secret Key}',
var response = await client.SendAsync(request);
  'Authorization': '{Bearer Token}'
response.EnsureSuccessStatusCode();
}
Console.WriteLine(await response.Content.ReadAsStringAsync());
 
response = requests.request("GET", url, headers=headers, data=payload)
 
print(response.text)
 
</syntaxhighlight>
 
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
</syntaxhighlight>
</syntaxhighlight>
</Tab>
</Tab>


<Tab name = "Php">
<Tab name = "PHP">
'''Request'''
'''Request'''
<syntaxhighlight lang="java" line="1">
<syntaxhighlight lang="php">
<?php
<?php
require_once 'HTTP/Request2.php';
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request = new HTTP_Request2();
$request->setUrl('https://www.apis.serpi.com.co/api/v1/Actividades');
$request->setUrl('https://localhost:44305/api/v1/DocumentoContable');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
$request->setConfig(array(
Línea 316: Línea 544:
));
));
$request->setHeader(array(
$request->setHeader(array(
   'secretkey' => '{Secret Key}',
   'secretkey' => '{{secret key}}',
   'Authorization' => '{Bearer Token}'
   'Authorization' => 'Bearer {{token}}'
));
));
$request->setBody('');
try {
try {
   $response = $request->send();
   $response = $request->send();
Línea 331: Línea 560:
catch(HTTP_Request2_Exception $e) {
catch(HTTP_Request2_Exception $e) {
   echo 'Error: ' . $e->getMessage();
   echo 'Error: ' . $e->getMessage();
}
</syntaxhighlight>
'''Response'''
<syntaxhighlight lang="java" line="1">
{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}
}
</syntaxhighlight>
</syntaxhighlight>
Línea 353: Línea 565:


</Tabs>
</Tabs>
''' Códigos de estado HTTP'''
{| class="wikitable left"
! 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
|}


[[Category:Documentación APIs]]
[[Category:Documentación APIs]]
<!-- [[Category:Pages with syntax highlighting errors]] -->
<!-- [[Category:Pages with syntax highlighting errors]] -->

Revisión actual - 11:22 21 jul 2023

Descripción: Esta API permite la sincronizacion de documentos contables entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estandar entre las dos herramientas.

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, POST, PUT

¿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 Tipos de Documento"> GET/users

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


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": "2 registro(s) encontrados",
    "result": [
        {
            "id": 1,
            "categoriaDocumento": "NC",
            "prefijo": "RCA",
            "descripcion": "RECIBO DE CAJA"
        },
        {
            "id": 2,
            "categoriaDocumento": "NC",
            "prefijo": "NCC",
            "descripcion": "NOTA CONTABLE"
        }
    ]
}

{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}

Campo de resultados

Campo Tipo de dato Descripción
id int Corresponde al identificador del tipo de documento
categoriaDocumento string Categoría del tipo de documento
prefijo string Prefijo del tipo de documento
descripcion string Descripción del tipo de documento

</Tab>

<Tab name = "API Consultar Documentos Contables"> POST /users

EndPoint: https://www.apis.serpi.com.co/api/v1/DocumentoContable/ConsultarDocumentoContables?limite=10&pagina=1

Headers

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

Body: 

{
    "tiposDocumentos": [15,16],
    "numeroDesde": null,
    "numeroHasta": null,
    "fechaDesde": "2023-01-01",
    "fechaHasta": "2023-01-31"
}

Campos del request

Campo Tipo Requerido Descripción
tiposDocumentos Array [Int] SI Array de enteros. Son los Ids de los tipos de documentos (Api Consulta tipos documento)
numeroDesde int NO Numero inicial para filtrar por rango de números de documentos
numeroHasta int NO Numero final para filtrar por rango de números de documentos
fechaDesde string SI Fecha inicial para filtrar por rango de fecha del documento
fechaHasta bool SI Fecha final para filtrar por rango de fecha del documento


Authorization: 

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

Response 

{
    "success": true,
    "code": 200,
    "errors": null,
    "message": "1 registro(s) encontrados",
    "result": [
        {
            "id": 111,
            "categoriaDocumento": "CCO",
            "prefijo": "COM",
            "numeroDoc": 1,
            "nitTerceroEnc": "1234567890",
            "nombreTerceroEnc": "ALEJANDRA LOPEZ LOPEZ",
            "fechaDocumento": "2023-03-01",
            "detalles": [
                {
                    "cuenta": 52954501,
                    "nitTerceroDet": "1234567890",
                    "nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
                    "naturaleza": "D",
                    "crucePrefijo": null,
                    "cruceNumero": null,
                    "fechaVencimiento": null,
                    "valor": 67900.00000,
                    "baseImpuesto": 0.00000,
                    "cuota": 0,
                    "detalle": "SERV DE TRANSP INFORMAL",
                    "idSubcentroCosto": 4,
                    "idCentroOperacion": 1,
                    "idProyecto": null,
                    "idActividad": null,
                    "idSucursal": null
                },
                {
                    "cuenta": 23359501,
                    "nitTerceroDet": "1234567890",
                    "nombreTerceroDet": "ALEJANDRA LOPEZ LOPEZ",
                    "naturaleza": "C",
                    "crucePrefijo": "COM",
                    "cruceNumero": 3272,
                    "fechaVencimiento": null,
                    "valor": 67900.00000,
                    "baseImpuesto": 0.00000,
                    "cuota": 0,
                    "detalle": "SERV DE TRANSP INFORMAL",
                    "idSubcentroCosto": null,
                    "idCentroOperacion": 1,
                    "idProyecto": null,
                    "idActividad": null,
                    "idSucursal": null
                }
            ]
        }
    ]
}

{
    "success": true,
    "code": 204,
    "message": "No se encontraron registros",
}


Campos del resultado

Campo Tipo de Dato Descripción
id int Corresponde al id del registro contable
categoriaDocumento string Categoría del tipo de documento
prefijo string Prefijo del tipo de documento
numeroDoc Int Numero del documento contable
nitTerceroEnc string Numero de identificación del tercero del documento contable
nombreTerceroEnc string Nombre del tercero del documento contable
fechaDocumento string Fecha del documento contable
detalles Array[ObjetoDetalle]* Array de objetos de los detalles del documento contable


ObjetoDetalle:

Campo Tipo de Dato Descripción
cuenta Int Auxiliar o numero de cuenta contable del movimiento
nitTerceroDet string Numero de identificación del tercero del detalle
nombreTerceroDet string Nombre del tercero del detalle
naturaleza string Naturaleza del movimiento (C=Credito, D=Debito)
crucePrefijo string Prefijo del documento cruce
cruceNumero Int Numero del documento cruce
fechaVencimiento string Fecha de vencimiento del movimiento
valor decimal Valor del movimiento
baseImpuesto decimal Valor base de impuesto
cuota Int Numero de cuota, para documentos que manejan contabilización de cuotas
detalle string Comentarios del movimiento
idSubcentroCosto Int Id del subcentro de costo del movimiento
idCentroOperacion Int Id del centro de operacion del movimiento
idProyecto Int Id del proyecto del movimiento
idActividad Int Id de la actividad del movimiento
idSucursal Int Id de la sucursal del tercero del movimiento

</Tab>

<Tab name = "API Crear">

EndPoint: https://www.apis.serpi.com.co/api/v1/DocumentoContable 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

Body: 

[
    {
        "categoriaDocumento": "CCO",
        "prefijo": "COM",
        "numeroDoc": 2,
        "nitTerceroEnc": "123456789",
        "fechaDocumento": "2023-03-01",
        "detalles": [
            {
                "cuenta": 52954501,
                "nitTerceroDet": "123456789",
                "naturaleza": "D",
                "crucePrefijo": null,
                "cruceNumero": null,
                "fechaVencimiento": null,
                "valor": 67900.00000,
                "baseImpuesto": 0.00000,
                "cuota": 0,
                "detalle": "SERV DE TRANSP INFORMAL",
                "idSubcentroCosto": 4,
                "idCentroOperacion": 1,
                "idProyecto": null,
                "idActividad": null,
                "idSucursal": null
            },
            {
                "cuenta": 23359501,
                "nitTerceroDet": "123456789",
                "naturaleza": "C",
                "crucePrefijo": "COM",
                "cruceNumero": 1,
                "fechaVencimiento": null,
                "valor": 67900.00000,
                "baseImpuesto": 0.00000,
                "cuota": 0,
                "detalle": "SERV DE TRANSP INFORMAL",
                "idSubcentroCosto": null,
                "idCentroOperacion": 1,
                "idProyecto": null,
                "idActividad": null,
                "idSucursal": null
            }
        ]
    }
]

Campos resultado

Campo Tipo Requerido Descripción
categoriaDocumento string SI Categoría del tipo de documento
prefijo string SI Prefijo del tipo de documento
numeroDoc Int SI Numero del documento contable
nitTerceroEnc string SI Numero de identificación del tercero del documento contable
fechaDocumento string SI Fecha del documento contable
detalles Array[ObjetoDetalle]* SI Array de objetos de los detalles del documento contable


ObjetoDetalle:

Campo Tipo Requerido Descripción
cuenta Int SI Auxiliar o numero de cuenta contable del movimiento
nitTerceroDet string SI Numero de identificación del tercero del detalle
naturaleza string SI Naturaleza del movimiento (C=Credito, D=Debito)
crucePrefijo string NO Prefijo del documento cruce
cruceNumero Int NO Numero del documento cruce
fechaVencimiento string NO Fecha de vencimiento del movimiento
valor decimal SI Valor del movimiento
baseImpuesto decimal NO Valor base de impuesto
cuota Int NO Numero de cuota, para documentos que manejan contabilización de cuotas
detalle string NO Comentarios del movimiento
idSubcentroCosto Int NO Id del subcentro de costo del movimiento
idCentroOperacion Int NO Id del centro de operacion del movimiento
idProyecto Int NO Id del proyecto del movimiento
idActividad Int NO Id de la actividad del movimiento
idSucursal Int NO Id de la sucursal del tercero del movimiento


Authorization: 

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

Response 

{
    "success": true,
    "code": 201,
    "errors": [],
    "message": "Se crearon 10 de 10 documentos contables"
}

</Tab>


<Tab name = "API Eliminar"> PUT/users

EndPoint: https://www.apis.serpi.com.co/api/v1/DocumentoContable 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

Body: 

{
    "idTipoDocumento": 6,
    "numeroDesde": 1,
    "numeroHasta": 10000,
    "fechaDesde": "2023-03-01",
    "fechaHasta": "2023-03-31"
}

Campos Solicitados

Campo Tipo Requerido Descripción
idTipoDocumento int SI Id del tipo de documento
numeroDesde int SI Numero inicial para filtrar por rango de números de documentos
numeroHasta int SI Numero final para filtrar por rango de números de documentos
fechaDesde string SI Fecha inicial para filtrar por rango de fecha del documento
fechaHasta bool SI Fecha final para filtrar por rango de fecha del documento



Authorization: 

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

Response 

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Se eliminaron 10 de 10 documentos contables "
}

</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/DocumentoContable")
  .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/DocumentoContable");
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/DocumentoContable');
$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>

Obtenido de «https://www.wikiserpi.com/index.php?title=API_Documentos_Contables&oldid=916»