API Ventas/Factura Venta - Historial de revisiones

Nalzate en 14:12 30 oct 2023

2023-10-30T14:12:48Z

@@ Línea 530: / Línea 530: @@
 </Tab>
 </Tabs>
 == ¿Cómo consumir la API? ==

Nalzate en 14:07 8 ago 2023

2023-08-08T14:07:00Z

@@ Línea 192: / Línea 192: @@
                      "nitRecaudoTercero": null,
                      "nombreRecaudoTercero": null
+                 }
+             ]
@@ Línea 272: / Línea 281: @@
 |-
 | nombreRecaudoTercero || string || Nombre del recaudador
 |}
@@ Línea 332: / Línea 359: @@
                  "nitRecaudoTercero": null,
                  "nombreRecaudoTercero": null
+             }
+         ]
@@ Línea 402: / Línea 438: @@
 |-
 | nitRecaudoTercero || string || NO || Número de identificación del recaudador
 |}

Dvaldes: Dvaldes trasladó la página API Facturas/Factura Venta a API Ventas/Factura Venta

2023-07-21T14:33:51Z

Dvaldes trasladó la página API Facturas/Factura Venta a API Ventas/Factura Venta

← Revisión anterior	Revisión del 10:33 21 jul 2023
(Sin diferencias)

Nalzate en 20:06 10 jul 2023

2023-07-10T20:06:10Z

← Revisión anterior		Revisión del 16:06 10 jul 2023
Línea 416:		Línea 416:
	</Tab>		</Tab>

	<!-- ************************************************************ ~~PUT~~ ******************************************************************** -->		<!-- ************************************************************ DELETE ******************************************************************** -->
	<Tab name = "API ~~Modificar~~(~~PUT~~) ">		<Tab name = "API Eliminar(DELETE) ">
	'''EndPoint:'''		'''EndPoint:'''
	https://www.apis.serpi.com.co/api/v1/~~Impuesto~~		https://www.apis.serpi.com.co/api/v1/FacturaVenta

	{\| class="wikitable"		{\| class="wikitable"
Línea 439:		Línea 439:
	<syntaxhighlight lang="JSON">		<syntaxhighlight lang="JSON">
	{		{
	~~"id": 123,~~		"idTipoDocumento": 6,
	"~~descripcion~~": ~~"pruebanueva"~~,		"numeroDesde": 1,
	"~~valor~~": ~~5.00000~~,		"numeroHasta": 10000,
	"~~aplica~~": 1,		"fechaDesde": "2023-03-01",
	"~~_base~~": ~~0.00000,~~		"fechaHasta": "2023-03-31"
	"~~cuenta_impuesto~~"~~: 2659~~,
	"~~cuenta_impuesto_devolucion~~": ~~2659,~~
	"~~cuenta_impuesto_bonificado~~"~~: 2659~~
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 456:		Línea 453:
	! Campo !! Tipo de dato !! Requerido !! Descripción		! Campo !! Tipo de dato !! Requerido !! Descripción
	\|-		\|-
	\| id \|\| int \|\| Si \|\| ~~Corresponde al identificador~~ de ~~la Impuesto~~		\| idTipoDocumento \|\| int \|\| Si \|\| Id del tipo de documento
	\|-		\|-
	\| ~~descripcion~~ \|\| ~~string~~ \|\| SI \|\| ~~Descripción~~ de ~~la Impuesto~~		\| numeroDesde \|\| int \|\| SI \|\| Numero inicial para filtrar por rango de números de documentos
	\|-		\|-
	\| ~~valor~~ \|\| ~~decimal~~ \|\| SI \|\| ~~Descripción~~ de ~~la Impuesto~~		\| numeroHasta \|\| int \|\| SI \|\| Numero final para filtrar por rango de números de documentos
	\|-		\|-
	\| ~~aplica~~ \|\| ~~int~~ \|\| SI \|\| ~~Descripción~~ de ~~la Impuesto~~		\| fechaDesde \|\| string \|\| SI \|\| Fecha inicial para filtrar por rango de fecha del documento
	\|-		\|-
	\| ~~_base~~ \|\| ~~decimal~~ \|\| SI \|\| ~~Descripción~~ de ~~la Impuesto~~		\| fechaHasta \|\| bool \|\| SI \|\| Fecha final para filtrar por rango de fecha del documento
	\|-
	~~\| cuenta_impuesto \|\| int \|\| SI \|\| Corresponde al identificador de la cuenta del impuesto~~
	\|-
	~~\| cuenta_impuesto_devolucion \|\| int \|\| NO \|\| Corresponde al identificador de la cuenta del impuesto descuento~~
	\|-
	~~\| cuenta_impuesto_bonificado \|\| int \|\| NO \|\| Corresponde al identificador de la cuenta~~ del ~~impuesto bonificado~~
	\|}		\|}

	~~==== '''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'''		'''Response'''
Línea 482:		Línea 469:
	"success": true,		"success": true,
	"code": 200,		"code": 200,
	~~"errors": null,~~		"errors": [],
	~~"message": "registro modificado exitosamente"~~		"message": "Se eliminaron 1 de 1 Facturas de Venta"
	}

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

	~~'''Validaciones'''~~
	~~<syntaxhighlight lang="JSON">~~
	{
	~~"success": false,~~
	~~"code": 400,~~
	"errors": [
	~~"El campo id es obligatorio",~~
	~~"El campo descripcion es obligatorio",~~
	~~"El campo codigo es obligatorio"~~
	],
	"message": "Se ~~presentaron errores al modificar el registro~~"
	}		}
	</syntaxhighlight>		</syntaxhighlight>
Línea 522:		Línea 488:
	RequestBody body = RequestBody.create(mediaType, "");		RequestBody body = RequestBody.create(mediaType, "");
	Request request = new Request.Builder()		Request request = new Request.Builder()
	.url("https://localhost:44305/api/v1/~~Impuesto~~")		.url("https://localhost:44305/api/v1/FacturaVenta")
	.method("GET", body)		.method("GET", body)
	.addHeader("secretkey", "{{secret key}}")		.addHeader("secretkey", "{{secret key}}")
Línea 535:		Línea 501:
	<syntaxhighlight lang="c#">		<syntaxhighlight lang="c#">
	var client = new HttpClient();		var client = new HttpClient();
	var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/~~Impuesto~~");		var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/FacturaVenta");
	request.Headers.Add("secretkey", "{{secret key}}");		request.Headers.Add("secretkey", "{{secret key}}");
	request.Headers.Add("Authorization", "Bearer{{token}}");		request.Headers.Add("Authorization", "Bearer{{token}}");
Línea 552:		Línea 518:
	require_once 'HTTP/Request2.php';		require_once 'HTTP/Request2.php';
	$request = new HTTP_Request2();		$request = new HTTP_Request2();
	$request->setUrl('https://localhost:44305/api/v1/~~Impuesto~~');		$request->setUrl('https://localhost:44305/api/v1/FacturaVenta');
	$request->setMethod(HTTP_Request2::METHOD_GET);		$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(		$request->setConfig(array(

Nalzate en 20:01 10 jul 2023

2023-07-10T20:01:40Z

Mostrar los cambios

Nalzate en 19:51 10 jul 2023

2023-07-10T19:51:07Z

@@ Línea 247: / Línea 247: @@
 |-
 | detalles || Array[ObjetoDetalle]* || Array de objetos de los detalles de la factura de venta
 |}

Nalzate en 19:43 10 jul 2023

2023-07-10T19:43:33Z

Mostrar los cambios

Nalzate: Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Impuesto entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas. '''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…»

2023-07-10T19:01:46Z

Página creada con «'''Descripción:''' Esta API permite la sincronización del agrupador definido como Impuesto entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas. '''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…»

Página nueva

'''Descripción:'''
Esta API permite la sincronización del agrupador definido como Impuesto entre SERPI y la plataforma que lo requiera permitiendo tener un manejo estándar entre las dos Plataformas.

'''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?'''
*El consumo de esta API se realiza por método GET.
*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/Impuesto

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

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight >
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

{| class="wikitable"
|+ 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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "1 registro(s) encontrados",
"result": [
{
"id": 1,
"descripcion": "IVA COMPRA 5%",
"valor": 5.00000,
"aplica": 1,
"_base": 0.00000,
"cuenta_impuesto": 2659,
"cuenta_impuesto_devolucion": 2659,
"cuenta_impuesto_bonificado": null
}
]
}

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

{| class="wikitable"
|+ Campos de resultados
|-
! Campo !! Tipo de dato !! Descripción
|-
| id || int || Corresponde al identificador del Impuesto
|-
| descripcion || string || Descripción de la Impuesto
|-
| valor || decimal || Descripción de la Impuesto
|-
| aplica || int || Descripción de la Impuesto
|-
| _base || decimal || Descripción de la Impuesto
|-
| cuenta_impuesto || int || Corresponde al identificador de la cuenta del impuesto
|-
| cuenta_impuesto_devolucion || int || Corresponde al identificador de la cuenta del impuesto descuento
|-
| cuenta_impuesto_bonificado || int || Corresponde al identificador de la cuenta del impuesto bonificado
|}
</Tab>


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

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"descripcion": "pruebaDescuento",
"valor": 5.00000,
"aplica": 1,
"_base": 0.00000,
"cuenta_impuesto": 2659,
"cuenta_impuesto_devolucion": 2659,
"cuenta_impuesto_bonificado": 2659
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Requerido !! Descripción
|-
| descripcion || string || SI || Descripción de la Impuesto
|-
| valor || decimal || SI || Descripción de la Impuesto
|-
| aplica || int || SI || Descripción de la Impuesto
|-
| _base || decimal || SI || Descripción de la Impuesto
|-
| cuenta_impuesto || int || SI || Corresponde al identificador de la cuenta del impuesto
|-
| cuenta_impuesto_devolucion || int || NO || Corresponde al identificador de la cuenta del impuesto descuento
|-
| cuenta_impuesto_bonificado || int || NO || Corresponde al identificador de la cuenta del impuesto bonificado
|}

==== '''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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 201,
"errors": null,
"message": "registro creado exitosamente"
}
</syntaxhighlight>

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo descripcion es obligatorio",
"El campo codigo es obligatorio"
],
"message": "Se presentaron errores al crear el registro"
}
</syntaxhighlight>
</Tab>


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

{| class="wikitable"
|+ Headers
|-
! Header !! Descripción
|-
| secretkey || Secretkey proporcionada al cliente para consumos de las APIs
|}

'''Authorization:'''
<syntaxhighlight>
Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP
</syntaxhighlight>

'''Request'''
<syntaxhighlight lang="JSON">
{
"id": 123,
"descripcion": "pruebanueva",
"valor": 5.00000,
"aplica": 1,
"_base": 0.00000,
"cuenta_impuesto": 2659,
"cuenta_impuesto_devolucion": 2659,
"cuenta_impuesto_bonificado": 2659
}
</syntaxhighlight>

{| class="wikitable"
|+ Campos del request
|-
! Campo !! Tipo de dato !! Requerido !! Descripción
|-
| id || int || Si || Corresponde al identificador de la Impuesto
|-
| descripcion || string || SI || Descripción de la Impuesto
|-
| valor || decimal || SI || Descripción de la Impuesto
|-
| aplica || int || SI || Descripción de la Impuesto
|-
| _base || decimal || SI || Descripción de la Impuesto
|-
| cuenta_impuesto || int || SI || Corresponde al identificador de la cuenta del impuesto
|-
| cuenta_impuesto_devolucion || int || NO || Corresponde al identificador de la cuenta del impuesto descuento
|-
| cuenta_impuesto_bonificado || int || NO || Corresponde al identificador de la cuenta del impuesto bonificado
|}

==== '''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'''
<syntaxhighlight lang="JSON">
{
"success": true,
"code": 200,
"errors": null,
"message": "registro modificado exitosamente"
}

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

'''Validaciones'''
<syntaxhighlight lang="JSON">
{
"success": false,
"code": 400,
"errors": [
"El campo id es obligatorio",
"El campo descripcion es obligatorio",
"El campo codigo es obligatorio"
],
"message": "Se presentaron errores al modificar el registro"
}
</syntaxhighlight>
</Tab>
</Tabs>

== ¿Cómo consumir la API? ==

<Tabs>

<Tab name = "Java">
'''Request'''
<syntaxhighlight lang="java">
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/Impuesto")
.method("GET", body)
.addHeader("secretkey", "{{secret key}}")
.addHeader("Authorization", "Bearer{{token}}")
.build();
Response response = client.newCall(request).execute();
</syntaxhighlight>
</Tab>

<Tab name = "C#">
'''Request'''
<syntaxhighlight lang="c#">
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:44305/api/v1/Impuesto");
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());
</syntaxhighlight>
</Tab>

<Tab name = "PHP">
'''Request'''
<syntaxhighlight lang="php">
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://localhost:44305/api/v1/Impuesto');
$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();
}
</syntaxhighlight>
</Tab>

</Tabs>

[[Category:Documentación APIs]]