API Ventas/Documentos

De WikiSerpi
Revisión del 15:58 8 jun 2023 de Dvaldes (discusión | contribs.) (Página creada con «'''Descripción:''' Esta API permite sincronizar agrupador denominado Grupos contables 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 funciona?…»)
(difs.) ← Revisión anterior | Revisión actual (difs.) | Revisión siguiente → (difs.)
Ir a la navegación Ir a la búsqueda

Descripción: Esta API permite sincronizar agrupador denominado Grupos contables 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 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/GrupoCont

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/GrupoCont?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": "1",
            "descripcion": "GRUPO CONTABLE DEMO",
            "tipoproducto": 1,
            "aplica_recaudo_tercero": true,
            "aplica_impuesto_venta": true,
            "impuesto_venta": 5.00000,
            "descripcion_impuesto_venta": "IVA COMPRA 5%",
            "aplica_impuesto_compra": true,
            "impuesto_compra": 19.00000,
            "descripcion_impuesto_compra": "IVA COMPRA 19%",
            "aplica_impoconsumo": true,
            "valor_impoconsumo": 0,
            "aux_cuenta_impoconsumo": 1234567,
            "descripcion_cuenta_impoconsumo": "DESCRIPCIÓN DE LA CUENTA IMPOCONSUMO",
            "aux_cuenta_gastoxcompra": 1234567,
            "descripcion_cuenta_gastoxcompra": "DESCRIPCIÓN DE LA CUENTA GASTO X COMPRAR",
            "aux_cuenta_ingresoventa": 1234567,
            "descripcion_cuenta_ingresoventa": "DESCRIPCIÓN DE LA CUENTA INGRESO VENTA",
            "aux_cuenta_devolucionventa": 1234567,
            "descripcion_cuenta_devolucionventa": "DESCRIPCIÓN DE LA CUENTA DEVOLUCIÓN VENTA",
            "aux_cuenta_costo": 1234567,
            "descripcion_cuenta_costo": "DESCRIPCIÓN DE LA CUENTA COSTO",
            "aux_cuenta_cartera": 1234567,
            "descripcion_cuenta_cartera": "DESCRIPCIÓN DE LA CUENTA CARTERA",
            "aux_cuenta_ajuste": 1234567,
            "descripcion_cuenta_ajuste": "DESCRIPCIÓN DE LA CUENTA AJUSTE",
            "aux_cuenta_desperdicio": 1234567,
            "descripcion_cuenta_desperdicio": "DESCRIPCIÓN DE LA CUENTA DESPERDICIO",
            "centro_costo": "01",
            "descripcion_centro_costo": "ADMINISTRACION",
            "aplica_retencion": true
        }
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}
Campos de resultados
Campo Tipo de dato Descripción
id int Identificador del grupo contable
codigo string Código único del grupo contable
descripcion string Descripción del grupo contable
tipoproducto int Tipo producto del grupo contable, debe ser 0 (Producto) o 1 (Servicio)
aplica_recaudo_tercero bool Si aplica recaudo para tercero para cuando el tipo producto es un 1 (Servicio)
aplica_impuesto_venta bool Si aplica impuesto venta
impuesto_venta double Porcentaje del impuesto venta
descripcion_impuesto_venta string Descripción del impuesto venta, debe ser "IVA COMPRA 5%", "IVA COMPRA 19%", "EXENTO", "IVA GENERADO EN VENTAS" o null
aplica_impuesto_compra bool Si aplica impuesto compra
impuesto_compra double Porcentaje del impuesto compra
descripcion_impuesto_compra string Descripción del impuesto compra, debe ser "IVA COMPRA 5%", "IVA COMPRA 19%", "EXENTO", "IVA GENERADO EN VENTAS" o null
aplica_impoconsumo bool Si aplica impuesto consumo
valor_impoconsumo double Valor del impoconsumo
aux_cuenta_impoconsumo int Cuenta Impoconsumo
descripcion_cuenta_impoconsumo string Descripción de la cuenta Impoconsumo
aux_cuenta_gastoxcompra int Cuenta Gasto x Compra
descripcion_cuenta_gastoxcompra string Descripción de la cuenta Gasto x Compra
aux_cuenta_ingresoventa int Cuenta Ingreso Venta
descripcion_cuenta_ingresoventa string Descripción de la cuenta Ingreso Venta
aux_cuenta_devolucionventa int Cuenta Devolucion Venta
descripcion_cuenta_devolucionventa string Descripción de la cuenta Devolucion Venta
aux_cuenta_costo int Cuenta Costo
descripcion_cuenta_costo string Descripción de la cuenta Costo
aux_cuenta_cartera int Cuenta Cartera (Propiedad Horizontal)
descripcion_cuenta_cartera string Descripción de la cuenta Cartera (Propiedad Horizontal)
aux_cuenta_ajuste int Cuenta Ajuste (Ajuste de Inventario)
descripcion_cuenta_ajuste string Descripción de la cuenta Ajuste (Ajuste de Inventario)
aux_cuenta_desperdicio int Cuenta Desperdicio (Desperdicio Producción)
descripcion_cuenta_desperdicio string Descripción de la cuenta Desperdicio (Desperdicio Producción)
centro_costo string Centro de costo, debe ser 01 (ADMINISTRACION) o 02 (VENTAS)
descripcion_centro_costo string Descripción del centro de costo (ADMINISTRACION o VENTAS)
aplica_retencion bool Si aplica retención

</Tab>

<Tab name = "API Creación (POST) "> EndPoint: https://www.apis.serpi.com.co/api/v1/GrupoCont

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


Request 

{
    "codigo": "1",
    "descripcion": " GRUPO CONTABLE DEMO",
    "tipoproducto": 1,
    "aplica_recaudo_tercero": true,
    "aplica_impuesto_venta": true,
    "impuesto_venta": 3,
    "aplica_impuesto_compra": true,
    "impuesto_compra": 5,
    "aplica_impoconsumo": false,
    "valor_impoconsumo": 0,
    "aux_cuenta_impoconsumo": 1234567,
    "aux_cuenta_gastoxcompra": 1234567,
    "aux_cuenta_ingresoventa": 1234567,
    "aux_cuenta_devolucionventa": 1234567,
    "aux_cuenta_costo": 1234567,
    "aux_cuenta_cartera": 1234567,
    "aux_cuenta_ajuste": 1234567,
    "aux_cuenta_desperdicio": 1234567,
    "centro_costo": "01",
    "aplica_retencion": true
}


Campos del request
Campo Tipo de dato Longitud Requerido Descripción
codigo string 20 Si Código único del grupo contable
descripcion string 100 Si Descripción del grupo contable
tipoproducto int 11 11 Tipo producto del grupo contable, debe ser 0 (Producto) o 1 (Servicio)
aplica_recaudo_tercero bool 1 No Si aplica recaudo para tercero para cuando el tipo producto es un 1 (Servicio)
aplica_impuesto_venta bool 1 No Si aplica impuesto venta
impuesto_venta double 1 No Porcentaje del impuesto venta, debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)
aplica_impuesto_compra bool 1 No Si aplica impuesto compra
impuesto_compra double 1 No Porcentaje del impuesto compra, debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)
aplica_impoconsumo bool 1 No Si aplica impuesto consumo
valor_impoconsumo double (18,5) No Valor del impoconsumo
aux_cuenta_impoconsumo int 11 No Cuenta Impoconsumo
aux_cuenta_gastoxcompra int 11 Si Cuenta Gasto x Compra
aux_cuenta_ingresoventa int 11 Si Cuenta Ingreso Venta
aux_cuenta_devolucionventa int 11 Si Cuenta Devolucion Venta
aux_cuenta_costo int 11 Si Cuenta Costo
aux_cuenta_cartera int 11 No Cuenta Cartera (Propiedad Horizontal)
aux_cuenta_ajuste int 11 No Cuenta Ajuste (Ajuste de Inventario)
aux_cuenta_desperdicio int 11 No Cuenta Desperdicio (Desperdicio Producción)
centro_costo string 5 Si Centro de costo, debe ser 01 (ADMINISTRACION) o 02 (VENTAS)
aplica_retencion bool 1 No Si aplica retención

AVISO IMPORTANTE:

Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

Response 

{
    "success": true,
    "code": 201,
    "errors": [],
    "message": "Validaciones exitosas. Registro creado exitosamente"
}

Validaciones 

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo descripcion es obligatorio",
        "El campo tipoproducto debe ser 0 (Producto) o 1 (Servicio)",
        "El campo impuesto_venta debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)",
        "El campo impuesto_compra debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)",
        "El campo centro_costo debe ser 01 (ADMINISTRACION) o 02 (VENTAS)",
        "El auxiliar 123456 del campo aux_cuenta_impoconsumo no existe",
        "El campo aux_cuenta_gastoxcompra es obligatorio",
        "El campo aux_cuenta_ingresoventa es obligatorio",
        "El campo aux_cuenta_devolucionventa es obligatorio",
        "El campo aux_cuenta_costo es obligatorio",
        "El auxiliar 123456 del campo aux_cuenta_cartera no existe",
        "El auxiliar 123456 del campo aux_cuenta_ajuste no existe",
        "El auxiliar 123456 del campo aux_cuenta_desperdicio no existe"
    ],
    "message": "Problemas de validaciones. Se presentaron errores al crear el registro"
}

</Tab>

<Tab name = "API Modificar(PUT) "> EndPoint: https://www.apis.serpi.com.co/api/v1/GrupoCont

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


Request 

{
    "id": 1,
    "codigo": "1",
    "descripcion": " GRUPO CONTABLE DEMO",
    "tipoproducto": 1,
    "aplica_recaudo_tercero": true,
    "aplica_impuesto_venta": true,
    "impuesto_venta": 3,
    "aplica_impuesto_compra": true,
    "impuesto_compra": 5,
    "aplica_impoconsumo": false,
    "valor_impoconsumo": 0,
    "aux_cuenta_impoconsumo": 1234567,
    "aux_cuenta_gastoxcompra": 1234567,
    "aux_cuenta_ingresoventa": 1234567,
    "aux_cuenta_devolucionventa": 1234567,
    "aux_cuenta_costo": 1234567,
    "aux_cuenta_cartera": 1234567,
    "aux_cuenta_ajuste": 1234567,
    "aux_cuenta_desperdicio": 1234567,
    "centro_costo": "01",
    "aplica_retencion": true
}


Campos del request
Campo Tipo de dato Longitud Requerido Descripción
id int 11 Si Identificador del grupo contable
codigo string 20 Si Código único del grupo contable
descripcion string 100 Si Descripción del grupo contable
tipoproducto int 11 11 Tipo producto del grupo contable, debe ser 0 (Producto) o 1 (Servicio)
aplica_recaudo_tercero bool 1 No Si aplica recaudo para tercero para cuando el tipo producto es un 1 (Servicio)
aplica_impuesto_venta bool 1 No Si aplica impuesto venta
impuesto_venta double 1 No Porcentaje del impuesto venta, debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)
aplica_impuesto_compra bool 1 No Si aplica impuesto compra
impuesto_compra double 1 No Porcentaje del impuesto compra, debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)
aplica_impoconsumo bool 1 No Si aplica impuesto consumo
valor_impoconsumo double (18,5) No Valor del impoconsumo
aux_cuenta_impoconsumo int 11 No Cuenta Impoconsumo
aux_cuenta_gastoxcompra int 11 Si Cuenta Gasto x Compra
aux_cuenta_ingresoventa int 11 Si Cuenta Ingreso Venta
aux_cuenta_devolucionventa int 11 Si Cuenta Devolucion Venta
aux_cuenta_costo int 11 Si Cuenta Costo
aux_cuenta_cartera int 11 No Cuenta Cartera (Propiedad Horizontal)
aux_cuenta_ajuste int 11 No Cuenta Ajuste (Ajuste de Inventario)
aux_cuenta_desperdicio int 11 No Cuenta Desperdicio (Desperdicio Producción)
centro_costo string 5 Si Centro de costo, debe ser 01 (ADMINISTRACION) o 02 (VENTAS)
aplica_retencion bool 1 No Si aplica retención

AVISO IMPORTANTE:

Digite null o 0 (si es un campo del tipo double o int), para aquellos valores donde los campos no sean obligatorios y donde no se va a asignar algún valor.

Response 

{
    "success": true,
    "code": 200,
    "errors": [],
    "message": "Validaciones exitosas. Registro modificado exitosamente"
}

{
    "success": false,
    "code": 204,
    "errors": null,
    "message": "No se encontraron registros con el id 1"
}

Validaciones 

{
    "success": false,
    "code": 400,
    "errors": [
        "El campo id es obligatorio",
        "El campo descripcion es obligatorio",
        "El campo tipoproducto debe ser 0 (Producto) o 1 (Servicio)",
        "El campo impuesto_venta debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)",
        "El campo impuesto_compra debe ser 1 (IVA COMPRA 5%), 3 (IVA COMPRA 19%), 4 (EXENTO), 5 (IVA GENERADO EN VENTAS) o 0 (si no aplica)",
        "El campo centro_costo debe ser 01 (ADMINISTRACION) o 02 (VENTAS)",
        "El auxiliar 123456 del campo aux_cuenta_impoconsumo no existe",
        "El campo aux_cuenta_gastoxcompra es obligatorio",
        "El campo aux_cuenta_ingresoventa es obligatorio",
        "El campo aux_cuenta_devolucionventa es obligatorio",
        "El campo aux_cuenta_costo es obligatorio",
        "El auxiliar 123456 del campo aux_cuenta_cartera no existe",
        "El auxiliar 123456 del campo aux_cuenta_ajuste no existe",
        "El auxiliar 123456 del campo aux_cuenta_desperdicio no existe"
    ],
    "message": "Problemas de validaciones. Se presentaron errores al modificar el registro"
}

</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/GrupoCont")
  .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/GrupoCont");
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/GrupoCont');
$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_Ventas/Documentos&oldid=510»