La API de Acelérala está construida bajo los estándares de REST. Es decir, nuestra API posee URLs orientada a recursos, y hace uso de los códigos de respuesta HTTP para indicar los posibles errores en el API. Es importante indicar que se encuentra implementada una autenticación HTTP (Bearer Token), solicitada en cada petición. Además, soportamos las solicitudes HTTP de origen cruzado (CORS), permitiendo que tu sitio y Acelérala puedan interactuar de manera segura mediante nuestra API desde una aplicación cliente. Por otro lado, un objeto JSON es retornado en cada una las peticiones hacia el API, incluyendo los errores. Adicionalmente nuestras bibliotecas convierten las respuestas en objetos específicos para cada lenguaje soportado.
Para poder acceder y utilizar la API de Acelérala necesitas previamente registrar un cliente y asignarle los permisos que tendrá. Una vez que esté registrado, obtendrás tus Llaves de Autenticación. Con las llaves podrás solicitar un Token que luego tendrás que incluir en cada petición que hagas al API.
El Token se solicita enviando un POST request al endpoint https://api.acelerala.com/v1/token
. Este endpoint recibe autenticación tipo Basic Authenticate. Deberás enviar en el header dos parámetros: Content-Type
con el valor application/x-www-form-urlencoded
y Authorization
con el valor Basic < credenciales >
donde las credenciales son el identificador del cliente y la llave privada del cliente cifradas con Base64 de la forma client_id:client_secret. Adicionalmente, en el cuerpo de la petición se debe enviar el parámetro grant_type
con el valor client_credentials
.
Recuerda enviar los parámetros por HTTPS ya que Basic Authenticate puede ser descifrado para obtener tus credenciales.
Por medio de nuestra API, podrás ser notificado con toda la información en caso presentes un error al momento de hacer una petición a cualquier operación del API. La API de Acelérala utiliza el estándar de Códigos de Estado HTTP (HTTP Status Codes) en todas sus respuestas para indicar si las solicitudes se pudieron procesar con éxito o fallaron.
Todos los recursos principales de Acelérala soportan operaciones de listado, entre ellos ordenes, Productos y Clientes. Adicionalmente, todos los métodos de listado del API comparten una estructura similar tomando en cuenta estos tres parámetros: limit, after y before.
Acelérala utiliza una paginación en tiempo real basada en cursor a través de los parámetros after y before. Un cursor se refiere a un string de caracteres random que marca un ítem específico en una lista de datos. A menos que el ítem sea borrado, el cursor siempre estará punteando la misma parte de la lista, pero será invalidado si el ítem es removido.
En Acelérala, los parámetros after
y before
toman el valor ID
y el valor por el que esté siendo ordenado (por defecto created
) retornan los objetos en un orden cronológico reverso. El parámetro before
devuelve los objetos creados antes del objeto en cuestión. El parámetro after
devuelve los objetos creados después del objeto en cuestión. Si ambos parámetros son provistos sólo after
es utilizado.
Adicionalmente, algunos recursos permiten retornar los objetos en otro órden si es que se solicita en la petición. Para esto se debe enviar el parámetro sort
e indicar por qué campo se quiere ordenar y en qué dirección serparados por :
, por ejemplo sort=created:desc
. Los posibles valores para la dirección son asc
(ascendientemente) y desc
(descendientemente). Los posibles campos para ordenar dependerán de cada recurso y se detallarán en el recurso.
Al listar varios resultados de un recurso, se puede filtrar los resultados para obtener una lista de resultados específicos enviando los campos por los que desea filtrar como parámetros. Se puede filtrar utilizando equivalencias: gt
(mayor), lt
(menor), gte
(mayor o igual), lte
(menor o igual), o simplemente colocando el valor buscado (igual), o una serie de valores buscados separados por coma.
Por ejemplo, si quisieramos buscar todos las ordenes con un total entre 1 y 500, y que estén pagadas:
https://api.acelerala.com/v1/orders?total=gt:1,lt:500&payment_status=paid
Utiliza webhooks para recibir notificaciones de eventos que suceden en tu cuenta de Acelérala.
Los webhooks te permiten registrar una URL https:// a donde se enviará data en formato JSON. Algunos casos de uso comunes son
Integrar tu software contable.
Actualizar precios en algún otro sistema.
Recolectar data en un data warehouse.
La orden ha sido pagada en su totalidad.
Los pagos de la orden han sido devueltos parcialmente.
Los pagos de la orden han sido devueltos completamente.
En Acelérala, los eventos son nombrados en base a la familia del recurso, la acción, y en algunos casos, el nombre del cambio que se le dio al recurso. Los nombres están separados por un punto. Al crear un Webhook, puedes suscribirte a más de un evento a la vez con un endpoint. Esta es la lista actual de eventos a los que te puedes suscribir:
orders.created
: La orden fue creada con éxito, pero aún no ha sido puesta. Esto significa básicamente que es un "carrito".
orders.created.placed
:La orden fue creada y puesta.
orders.updated
: La orden ha sido actualizada.
orders.updated.placed
: La orden ha sido actualizada y puesta.
orders.updated.canceled
: El pago ha sido autorizado por el procesador.
receipts.created
: Los pagos de la orden han sido devueltos parcialmente.
receipts.created.accepted
: Los pagos de la orden han sido devueltos parcialmente.
receipts.created.rejected
: Los pagos de la orden han sido devueltos parcialmente.
Identificador único del objeto.
Nombre del objeto.
Código de la moneda en tres letras (Formato ISO 4217).
El estado de los pagos asociados a la orden. Solo puede colocarse cuando la orden es creada. Valores válidos:
pending
: Pago pendiente. El pago aún puede fallar en este estado. Las ordenes se crean en este estado si es que no se define ningún estado.
authorized
: El pago ha sido autorizado por el procesador.
partially_paid
: La orden ha sido pagada parcialmente.
paid
: La orden ha sido pagada en su totalidad.
partially_refunded
: Los pagos de la orden han sido devueltos parcialmente.
refunded
: Los pagos de la orden han sido devueltos completamente.
voided
: El pago ha sido anulado antes de completarse.
La información acerca del compromiso de pago del cliente al hacer la orden.
El medio de pago elegido al momento de hacer el pedido. Valores válidos:
cash
: Efectivo.
transfer
: Transferencia bancaria.
card
: Tarjeta de crédito o débito.
La cantidad de efectivo que el cliente se comprometió a utilizar cuando elige el método de pago "efectivo".n
La marca de la tarjeta con la que va a pagar el cliente. Este campo sirve para cuando al hacer deliveries hay que elegir qué marca de POS llevar.
La información de facturación de la Orden.
Nombre del cliente
Apellido del cliente.
Nombre de la empresa
Correo electrónico al que se le enviará los datos del pedido.
Tipo de documento solicitado por el cliente al momento de la compra. Posibles valores:
ticket
: Boleta.
invoice
: Factura.
Tipo de documento. Posibles valores:
dni
: Documento nacional de identidad.
ce
: Carné de extranjería.
passport
: Pasaporte.
-
: Ventas menores a S/ 700.00 y otros.
ruc
: RUC.
cdi
: Cédula diplomática de identidad.
nd
: No domiciliado, sin RUC (exportacións).
dnind
: DOC.IDENT.PAIS.RESIDENCIA-NO.D.
tin
: Tax Identification Number - TIN – Doc Trib PP.NN.
in
: Identification Number - IN – Doc Trib PP. JJ.
tam
: TAM- Tarjeta Andina de Migración .
Número de documento.
Teléfono de contacto del cliente.
Dirección de Facturación.
Información adicional de la direción del cliente.
Ciudad de la dirección de facturación.
Provincia de la dirección de facturación.
Distrito de la dirección de facturación
País de la dirección de facturación
Código de país (Formato ISO 3166).
Código postal de 6 dígitos.
La dirección de entrega de la Orden.
Nombre del que recibirá la ordeniente
Apellido del que recibirá la orden.
Teléfono de contacto del encargado de la recepción del pedido.
Dirección de entrega.
Información adicional o referencia de la direción de entrega.
Ciudad de la dirección de entrega.
Provincia de la dirección de entrega.
Distrito de la dirección de entrega
País de la dirección de entrega
Código de país (Formato ISO 3166).
Longitud de la dirección de entrega
Latitud de la dirección de entrega
Código postal de 6 dígitos.
Los ítems que componen la Orden. Contienen información del Producto como estaba definido al momento en que se creo la Orden. Mostrar atributos
Identificador único del objeto
Nombre del objeto.
Identificador único del producto de la orden.
Identificador único de la alternativa de la orden.
Ruta de la imagen que se guardó al hacer el pedido.
Cantidad de la alternativa que se agregó a la orden.
Peso unitario del ítem.
Precio unitario del ítem.
Subtotal de la línea. Se calcula multiplicando el precio unitario por la cantidad.
Identificador único de la asignación del descuento recibido a la línea.
Identificador único del descuento que se aplicó a la línea.
El monto descontado.
El descuento total de la línea.
Total de la línea. Se calcula restando line.discounts_total
a lines.subtotal
.
Si es que el ítem requiere de envío. Por ejemplo, un producto difital tendría valor false.
El stock disponible cuando se agregó la el ítem al pedido.
Fecha y hora preferida de entrega (Formato ISO 8601).
Nombre del producto y alternativa concatenados.
SKU del ítem.
Una lista de descuentos aplicados a la Orden.
Identificador único del objeto.
Identificador único del objeto de descuento que se aplicó a la orden.
Nombre del descuento aplicado a la orden.
Código promocional del descuento aplicado a la orden.
Descripción del descuento aplicado a la orden.
Valor del descuento.
Cómo se calcula el valor final del descuento.
percentage
: se descuenta un porcentaje.
fixed_amount
: se descuenta un monto fijo
specific price
: se modifica el valor a un precio específico
free
: gratis
Qué debía tener el cliente en el carrito para aplicar el descuento.
anything
: cualquier cosa.
products
: cualquier ítem de productos específicos
categories
: cualquier ítem de categorías específicas
Cuantos ítems debió tener en el carrito para que aplique el descuento. Opcional cuando discount_applications.buys
es igual a anything
A qué se le aplicó el descuento en la orden.
subtotal
: Al subtotal de la orden.
products
: A productos específicos en la orden
categories
: A ítems de categorías específicas en la orden
shipping
: Al costo de envío de la orden
Cuantos ítems debió tener en la orden para que aplique el descuento. No aplica cuando discount_applications.target
es igual a subtotal
o shipping
Qué hizo que se asigne el descuento. Valores válidos:
manual
: El descuento fue aplicado manualmente por el comercio o como código promocional.
automatic
: El descuento fue aplicado porque el pedido cumplía los requerimientos para participar en una promoción.
El monto total descontado:
Si es que los precios de los ítems y los totales de la Orden incluyen impuestos o no.
La sumatoria de todos los lines.total
de la orden.
La suma de los descuentos globales aplicados a la orden. No se consideran descuentos aplicados a las líneas.
La suma de los descuentos aplicados al costo de envío de la orden.
El total antes de considerar el costo de envío. Se calcula restando global_discounts_total a lines_total.
El costo de envío asociado al pedido. Se calcula en base a la configuración de la tienda.
El total de la orden que pagará el cliente. Se calcula sumando el subtotal y el costo de delivery.
Nota opcional que se utiliza para que el cliente o el dueño de la tienda agreguen información al pedido.
La fecha y hora en la que se creo la orden (Formato ISO 8601).
La última fecha y hora en la que se modificó la orden (Formato ISO 8601).
La fecha y hora en la que se realizó el pedido (Formato ISO 8601). Una vez que se realiza, se requieren permisos adicionales para modificar la orden.
La fecha y hora en la que se atendió el pedido (Formato ISO 8601). Una vez que se realiza, se requieren permisos adicionales para modificar la orden.
La fecha y hora en la que se anuló el pedido (Formato ISO 8601). Una vez que se realiza, se requieren permisos adicionales para modificar la orden.
Los datos generales de la atención de la Orden.
Fecha y hora (Formato ISO 8601) de inicio del rango en el que el cliente quisiera recibir el pedido completo.
Fecha y hora (Formato ISO 8601) de fin del rango en el que el cliente quisiera recibir el pedido completo. Debe ser mayor que el inicio del rango.
Fecha y hora (Formato ISO 8601) de inicio del rango en el que el comercio espera entregar el pedido completo.
Fecha y hora (Formato ISO 8601) de fin del rango en el que el comercio espera entregar el pedido completo. Debe ser mayor que el inicio del rango.
Estado actual de la atención de la orden. Posibles valores:
pending
:La atención de la orden aún no ha iniciado y el inventario sigue disponible para la venta. Este estado sucede cuando la tienda tiene configurado disminuir el stock sólo cuando entre un pedido pagado, y entra un pedido pendiente de pago.
reserved
: La atención de la orden aún no ha iniciado y pero el inventario ha sido reservado y ya no está disponible para la venta.
assigned
: Se ha programado la entrega de la orden.
scheduled
: Se ha programado la entrega de la orden.
ready_for_pickup
: El pedido está listo para ser recogido.
in_transit
: La orden está siendo transportada entre instalaciones logísticas, previo a su destino final.
out_for_delivery
: La orden está en la ruta de última milla.
partially_fulfilled
:La atención de la orden ha finalizó exitosamente para algunos de los ítems y otros fueron cancelados.
fulfilled
:La atención de la orden ha finalizado exitosamente.
attempted_delivery
: Se intentó entregar el producto pero no se logró la entrega.
failed
: Falló la atención de la orden sin intentos de entrega.
canceled
: Se canceló la atención de la orden.
Empresa o proveedor logístico que dará el servicio de envío o seguimiento para el pedido.
El código de seguimiento de la orden según lo indicado por el proveedor logístico.
Página web o ruta en donde el usuario podrá hacer seguimiento a su pedido.
{ "id": 32203, "object": "order", "currency_code": "PEN", "payment_status": "paid", "billing_details": { "first_name": "Manuel", "last_name": "Cornejo", "company": "", "email": "manuelcornejo@testmail.com", "document_type": "dni", "document_number": "48765432", "phone": "991231231", "address1": "Av Aviación 2405, San Borja", "city": "Lima", "province": "Lima", "district": "San Borja", "country": "Perú", "country_code": "PE", "zip_code": 15035 }, "shipping_address": { "first_name": "Manuel", "last_name": "Cornejo", "phone": 991231231, "address1": "Calle Mi Casa 123, San Borja", "address2": "Al frente de la Rambla", "city": "Lima", "province": "Lima", "district": "San Borja", "country": "Perú", "country_code": "PE", "longitude": null, "latitude": null, "zip_code": 15035 }, "lines": [ { "id": 47691, "object": "line", "product_id": 2233, "alternative_id": 2254, "image_url": "https://cdn.acelerala.com/img/123123.jpg", "sunat_product_code": "LPX123123", "quantity": 3, "weight": null, "dimensions": { "height": 100, "width": 100, "length": 100 }, "name": "Grips", "sku": "TESTAPI", "price": "100.00", "discounts_total": "120.00", "discount_allocations": [ { "discount_id": 1337, "amount": "120.00" } ], "fulfillment_details": { "requires_shipping": true, "fulfillable_quantity": "4", "preferred_date_start": null }, } ], "discount_applications": [ { "id": 1337, "discount_id": "21", "name": "Promo cyber Wow", "label": "CYBERWOW", "desctiption": "Compra 3, recibe 1 con S/ 120 descuento para todos los productos de la categoría cyber wow", "value": 120.00, "value_type": "fixed_amount", "buys": "categories", "buys_quantity": 3, "target": "categories", "target_quantity": 1, "allocation_trigger": "automatic", "allocation_order": "1", "total_allocated": "10" }, { "id": 2000, "discount_id": "23", "name": "Recibe 100 soles por más de 300 en tu compra", "label": "100PORMASDE300", "desctiption": "Por la compra de más de S/ 300 en tu carrito, ecibe 100 soles", "value": 100.00, "value_type": "fixed_amount", "buys": "anything", "buys_quantity": 1, "target": "subtotal", "allocation_trigger": "manual", "allocation_order": "2", "total_allocated": "100", } ], "discounts_total": 100.00, "taxes_included": true, "lines_total": 300, "subtotal": 30, "shipping_total": 0, "total": 30, "created": "2021-03-29T14:39:08.000Z", "modified": "2021-03-29T14:39:35.000Z", "placed": "2021-03-29T14:39:35.000Z", "fulfillment_details": { "preferred_date_start": "2021-03-31T14:39:35.000Z", "preferred_date_end": "2021-03-31T14:39:35.000Z", "scheduled_date_start": "2021-03-31T14:39:35.000Z", "scheduled_date_end": "2021-03-31T18:39:35.000Z", "status": "fulfilled" "fulfilled_datetime": "2021-03-31T14:39:35.000Z", "tracking_company": "DHL" "tracking_number": "123ADSXR567ND", "tracking_url": "https://www.dhl.com/pe-es/home/rastreo.html" } }
Requiere el siguiente permiso:
read:orders
para ver todos los pedidos de una tienda. Si se lista ordenes sin el permiso, sólo encontrará las ordenes que le pertenecen al usuario específico.
Puedes elegir cualquiera de estos campos para ordenar los pedidos:
id
,total
,created
,modified
,placed
.
Listar ordenes
GET https://api.acelerala.com/v1/orders
Listar las últimas 20 ordenes en las que el pedido se haya realizado despues de una fecha específica
GET https://api.acelerala.com/v1/orders?limit=20&sort=placed:desc&placed=gt:2019-01-10T16:58:14.000Z
Listar ordenes con solo ciertas propiedades GET https://api.acelerala.com/v1/orders?fields=id,payment_status,items
Listar ordenes con total entre 1000 y 5000, y mostrar solo 10 resultados GET https://api.acelerala.com/v1/orders?total=gt:1000,lt=5000&limit=10
Listar ordenes que hayan sido pagadas GET https://api.acelerala.com/v1/orders
Identificador único del objeto.
Nombre del objeto.
Identificador de objeto "orden" en caso el comprobante pertenezca a una orden específica.
Identificador de objeto "store", el proyecto de acelérala al cual le pertenece el comprobante.
Identificador de objeto "revoke", en caso el comprobante haya sido revocado. Se guarda
El código de tipo de documento autorizado para efectos tributarios según el Catálogo 01 especificado en SUNAT. Algunos son:
01
: Factura.
03
: Boleta de venta.
07
: Nota de crédito.
08
: Nota de débito.
09
: Guía de remisión remitente.
Empieza con "F" para FACTURAS y NOTAS ASOCIADAS. Empieza con "B" para BOLETAS DE VENTA y NOTAS ASOCIADAS. Si está comunicando un comprobante emitido en contingencia, la serie debe empezar NO debe empezar con "F" ni con "B". Debería empezar con "0", ejemplo: "0001"
Número correlativo del documento, sin ceros a la izquierda. Si estás creando un documento nuevo, se calcula automáticamente en base al último documento generado con la misma serie.
Valor concatenado con un guión (-) de la serie y el correlativo.
Código de la moneda en tres letras (Formato ISO 4217).
El código de tipo de documento afectado por la nota de crédito o débito según el Catálogo 01 especificado en SUNAT.
La serie y número del documento que una nota de crédito o débito modifica. Obligatorio si es que se está eimitiendo Notas de crédito o débito.
El código de tipo de nota. En el caso de nota de crédito electrónica, los códigos están en el Catálogo 09 especificado en SUNAT. En el caso de nota de débito electrónica, los códigos están en el Catálogo 10 especificado en SUNAT. Obligatorio si es que se está eimitiendo Notas de crédito o débito.
La descripción del código de tipo de nota. En el caso de nota de crédito electrónica, las descripciones de los códigos están en el Catálogo 09 especificado en SUNAT. En el caso de nota de débito electrónica, las descripciones de los códigos están en el Catálogo 10 especificado en SUNAT.
El código de tipo de operación según el Catálogo 51 especificado en SUNAT.
La suma de los anticipos.
La suma de los descuentos globales antes de impuestos.
La suma de los descuentos globales después de impuestos.
La suma de las percepciones u otros cargos adicionales.
La suma de los precios finales de los ítems antes de impuestos. Se calcula multiplicando el precio unitario (items.net_unit_price
) por la cantidad de ítems (items.quantity
) y luego restando el descuento total (items.discounts_total
).
El total sobre el cual se calculará el pago de impuestos. No se consideran operaciones inafectas. Este elemento es usado solo si al menos una línea de ítem está gravada con el IGV. Contiene a la sumatoria de los valores de venta gravados por ítem y la deducción de descuentos globales si lo hubiere. El total valor de venta no incluye IGV, ISC, cargos y otros Tributos si los hubiera. La sumatoria tampoco debe contener el valor de venta de las transferencias de bienes o servicios prestados a título gratuito comprendidos en la factura y que estuviesen gravados con el IGV.
El total exonerado de impuestos. Este elemento es usado solo si al menos una línea de ítem se encuentra exonerada al IGV. Contiene a la sumatoria de valor de venta por ítem exonerados por item y la deducción de descuentos globales si lo hubiere. El valor de venta no incluye ISC, cargos u otros Tributos si los hubiera. La sumatoria tampoco debe contener el valor de venta de las transferencias de bienes o servicios prestados a título gratuito comprendidos en la factura y que estuviesen exonerados del IGV.
El total de impuesto general de venta a pagar.
El total de IGV de los ítems entregados gratuitamente.
El total antes de considerar impuestos. Se calcula restando total_advancements a items_net_total.
El total de impuestos a pagar.
El total del pedido que pagará el cliente. Se calcula sumando el total antes de impuestos (net_total
) y los impuestos (taxes_total
).
El total de bienes o servicios prestados gratuitamente. Este elemento, se utilizará cuando exista transferencia de bienes o de servicios que se realice gratuitamente. Representa la sumatoria de los ítems, que correspondan a operaciones gratuitas.
El total inafecto de impuestos. Este elemento es usado solo si al menos una línea de ítem se encuentra inafecta al IGV. Contiene a la sumatoria de valor de venta por item inafectos, y la deducción de descuentos globales si los hubiere. El valor de venta no incluye ISC, cargos u otros tributos si los hubiera. La sumatoria tampoco debe contener el valor de venta de las transferencias de bienes o servicios prestados a título gratuito comprendidos en la factura y que estuviesen inafectos al IGV.
Indica si la SUNAT recibió y respondió el request, sin importar si el comprobante es aceptado o no.
Casos en los que la SUNAT responde sin CDR. Existe un proceso que cada minuto consulta los pendientes de CDR y en caso encuentre el CDR, actualiza el comprobante y este flag cambia automaticamente a 1
Indica si el comprobante fue aceptado o no por SUNAT. Los comprobantes rechazados muestran losmotivos de rechazo en el mensaje de error.
Código de rechazo SUNAT.
Mensaje de respuesa de SUNAT.
URL en donde se cargó el comprobante en formato PDF.
URL en donde se cargó el comprobante en formato PDF versión ticket para impresoras especializadas.
URL en donde se cargó el comprobante en formato ZIP con el comprobante de recepción SUNAT.
URL en donde se cargó el comprobante en formato XML.
La fecha y hora en la que se creo el comprobante (Formato ISO 8601).
La última fecha y hora en la que se modificó el comprobante (Formato ISO 8601).
El total de transacciones atribuidas a este comprobante. Se calcula con la sumatoria de claims.amount
.
El monto de la factura que aún no tiene transacciones asociadas. Se calcula restando claimed_total
de gross_total
. En base a esto, se puede obtener facturas pendientes de pago.
La información del cliente al que se le está generando el documento.
Razón social o nombre completo del cliente
Correo electrónico al que se le enviará los datos de la orden.
Tipo de documento. Obligatoriamente debes enviar este parámetro o customer_information.document_type_code
. Si se envían ambos, se respeta customer_information.document_type_code
. Posibles valores:
ruc
:RUC.
dni
: Documento nacional de identidad.
-
: Ventas menores a S/ 700.00 y otros.
ce
: Carné de extranjería.
passport
: Pasaporte.
cdi
: Cédula diplomática de identidad.
nd
: No domiciliado, sin RUC (exportacións).
dnind
: DOC.IDENT.PAIS.RESIDENCIA-NO.D.
tin
: Tax Identification Number - TIN – Doc Trib PP.NN.
in
: Identification Number - IN – Doc Trib PP. JJ.
tam
: TAM- Tarjeta Andina de Migración .
Código de tipos de documentos de identidad según los valores indicados en el Catálogo 06.
6
: RUC.
1
: Documento nacional de identidad.
-
: Ventas menores a S/ 700.00 y otros.
4
: Carné de extranjería.
7
: Pasaporte.
A
: Cédula diplomática de identidad.
0
: No domiciliado, sin RUC (exportacións).
B
: DOC.IDENT.PAIS.RESIDENCIA-NO.D.
C
: Tax Identification Number - TIN – Doc Trib PP.NN.
D
: Identification Number - IN – Doc Trib PP. JJ.
E
: TAM- Tarjeta Andina de Migración .
Número de documento.
Teléfono de contacto del cliente.
Dirección de Facturación.
Información adicional de la direción del cliente.
Departamento de la dirección de facturación.
Provincia de la dirección de facturación.
Distrito de la dirección de facturación
País de la dirección de facturación
Código de país (Formato ISO 3166).
Código postal de 6 dígitos.
La información de la empresa que genera el documento.
Razón social como está registrada.
Nombre comercial de la empresa.
RUC de la empresa.
Dirección de empresa.
Información adicional de la direción de la empresa.
Departamento de la dirección de la empresa.
Provincia de la dirección de la empresa.
Distrito de la dirección de la empresa
País de la dirección de la empresa
Código de país (Formato ISO 3166).
Ubigeo de la dirección de la empresa
Los ítems que componen el Comprobante. Contienen información de los ítems. Mostrar atributos
Nombre del producto y alternativa concatenados.
Código de producto SUNAT o Código GS1, según los valores indicados en el Catálogo de Productos.
Valores válidos:
NIU
: Es un producto.
ZZ
: Es un servicio.
Cantidad de ítems.
El porcentaje de IGV.
Códigos de tipo de afectación del IGV, según el Catálogo 07 especificado en SUNAT. Por defecto 10
.
Precio unitario neto del ítem (sin IGV incluido) antes de aplicar descuentos.
El precio unitario (items.net_unit_price
) multiplicado por la cantidad (items.quantity
).
El descuento neto total del ítem.
Monto total del ítem, menos descuentos, sin IGV incluido.
Total gravado con el IGV del ítem. No incluye IGV, ISC, cargos y otros Tributos si los hubiera. No contiene el valor de venta de las transferencias de bienes o servicios prestados a título gratuito.
El total de IGV del ítem. Es el IGV del ítem multiplicado por la cantidad.
Precio unitario del ítem con IGV incluido.
El precio bruto unitario (items.gross_unit_price
) multiplicado por la cantidad (items.quantity
).
El descuento bruto total del ítem.
Monto total de la línea con IGV incluido.
Para factura gratuita. Por ejemplo para el código de tipo de afectación IGV 12 (Gravado – Retiro por premio).
El monto gratuito unitario multiplicado por la cantidad de ítems.
El factor del impesto a las bolsas de plástico (ICBPER).
El total de ICBPER del ítem. Es el factor del impuesto a las bolsas de plástico multiplicado por la cantidad de bolsas.
SKU del ítem.
Códigos de cargos o descuentos, según el Catálogo 53 especificado en SUNAT. Por defecto 00
.
El monto neto sobre el cual se descontó. Se autogenera con el monto neto y el porcentaje de descuento.
El monto bruto sobre el cual se descontó. Se autogenera con el monto bruto y el porcentaje de descuento.
El porcentaje de descuento aplicado.
El monto neto descontado. Si se envía el monto neto y el monto bruto, se utilizará el monto bruto para calcular el monto neto.
El monto bruto descontado. Si se envía el monto neto y el monto bruto, se utilizará el monto bruto para calcular el monto neto.
En caso el código de tipo de operación sea igual a 1001, es obligatorio.
Códigos de bienes y servicios sujetos a detracción, según el Catálogo 54 especificado en SUNAT.
Medio de pago, según el Catálogo 59 especificado en SUNAT.
Número de cuenta en el Banco de la Nación
Monto de la detracción.
Porcentaje de la detracción.
En caso hayan anticipos en algún documeto anterior, se pueden agregar. Por cada anticipo, automáticamente se crea un descuento a nivel global que reduce el costo final de la factura.
Códigos de documentos relacionados tributarios, según el Catálogo 12 especificado en SUNAT.
El documento relacionado con el cual se hizo el anticipo.
El monto anticipado en el documento relacionado.
El Régimen de Percepciones constituye un sistema de pago adelantado del Impuesto General a las Ventas, mediante el cual el agente de percepción (vendedor o Administración Tributaria) percibe del importe de una venta o importación, un porcentaje adicional que tendrá que ser cancelado por el cliente o importador quien no podrá oponerse a dicho cobro.
Código de régimen de percepción, según el Catálogo 22 especificado en SUNAT.
El porcentaje se percibirá.
La base imponible sobre la cual se calcula la percepción
El monto de la percepción
El monto total incluido la percepción
Los descuentos globales son descuentos que se han aplicado al comprobante calculando diréctamente sobre el total de los ítems. Al agregar un descuento Global, se restará ese monto al total neto de los ítems, y sobre ese monto se calcularán los impuestos.
El monto neto sobre el cual se descontó. Se autogenera con el monto neto y el porcentaje de descuento.
El monto bruto sobre el cual se descontó. Se autogenera con el monto bruto y el porcentaje de descuento.
El porcentaje de descuento aplicado.
El monto neto descontado. Si se envía el monto neto y el monto bruto, se utilizará el monto bruto para calcular el monto neto.
El monto bruto descontado. Si se envía el monto neto y el monto bruto, se utilizará el monto bruto para calcular el monto neto.
{ "id": 67348, "object": "receipt", "order_id": null, "store_id": 511, "document_type_code": "01", "series": "F777", "correlative": 36862, "document_number": "F777-36862", "currency_code": "PEN", "affected_document_type_code": null, "affected_document_number": null, "note_motive_code": null, "note_motive_description": null, "operation_code": "0101", "advances_total": 0, "global_discounts_net_total": 0, "global_discounts_gross_total": 0, "other_charges_total": 0, "items_net_total": 33.9, "taxable_total": 33.9, "exempt_total": 0, "sales_tax_total": 6.1, "free_sales_tax_total": 0, "net_total": 33.9, "taxes_total": 6.1, "gross_total": 40, "free_total": 0, "unaffected_total": 0, "sunat_acknowledged": 1, "sunat_updated": 0, "sunat_accepted": 1, "sunat_revoked": 0, "revoke_motive_description": null, "sunat_code": "0", "sunat_message": "La Factura numero F777-36862, ha sido aceptada", "pdf_url": "https://efact.nyc3.cdn.digitaloceanspaces.com/receipts/20601009171/F777-36862-59eba84f-7596-4166-8211-f8b5311acad3.pdf", "mobile_pdf_url": "https://efact.nyc3.cdn.digitaloceanspaces.com/receipts/20601009171/F777-36862-59eba84f-7596-4166-8211-f8b5311acad3-mobile.pdf", "cdr_url": "https://efact.nyc3.cdn.digitaloceanspaces.com/receipts/20601009171/F777-36862-59eba84f-7596-4166-8211-f8b5311acad3.zip", "xml_url": "https://efact.nyc3.cdn.digitaloceanspaces.com/receipts/20601009171/F777-36862-59eba84f-7596-4166-8211-f8b5311acad3.xml", "created": "2022-03-27T12:30:18.000-0500", "modified": "2022-03-27T12:30:21.000-0500", "claimed_total": 40, "unclaimed_total": 0, "claims": [ { "id": 1238, "object": "claim", "store_id": 511, "receipt_id": 67348, "transaction_id": 1288, "amount": 40, "currency_code": "PEN", "created": "2022-03-27T12:30:25.000-0500", "modified": "2022-03-27T12:30:25.000-0500" } ], "legends": [ { "code": 1000, "value": "SON CUARENTA CON 00/100 SOLES" } ], "revokes": [], "vendor_information": { "name": "YUCA E.I.R.L.", "brand": null, "document_number": "20601009171", "email_recipients": null, "address1": "Calle 13 Nro 285, interior 7", "address2": null, "region": "Lima", "province": "Lima", "district": "La Molina", "country": "Perú", "country_code": "PE", "ubigeo": null }, "global_discounts": [], "items": [ { "name": "Plan Crece Mensual - Costo fijo (Del 27/03/22 al 27/04/22)", "sunat_product_code": 7123123, "unit": "ZZ", "quantity": 1, "sales_tax_rate": 18, "sales_tax_code": "10", "net_unit_price": 33.9, "net_subtotal": 33.9, "net_discounts_total": 0, "net_total": 33.9, "taxable_total": 33.9, "sales_tax_total": 6.1, "gross_unit_price": 40, "gross_subtotal": 40, "gross_discounts_total": 0, "gross_total": 40, "free_unit_price": 0, "free_total": 0, "plastic_tax_factor": null, "plastic_tax_total": null, "sku": null, "discounts": [] } ], "advances": [], "detraction": null, "customer_information": { "name": "Kalagreen Sac", "email": "ventasperu@instagreenlatam.com", "document_type": "ruc", "document_type_code": "6", "document_number": "20601373034", "phone": "990056284", "address1": null, "address2": null, "region": null, "province": null, "district": null, "country": null, "country_code": null, "zip_code": null }, "_metadata": { "customfield1": "796", "customfield2": "41", "customfield3": "553" } }
Requiere el siguiente permiso:
read:receipts
para ver todos los comprobantes de una tienda.
Puedes elegir cualquiera de estos campos para ordenar los pedidos:
id
,total
,created
,modified
,claimed_total
y unclaimed_total
.
Listar comprobantes
GET https://api.acelerala.com/v1/receipts
Listar las últimas 20 comprobantes ordenados por monto por pagar
GET https://api.acelerala.com/v1/receipts?limit=20&sort=unclaimed_total:desc
Listar comprobantes con total entre 1000 y 5000, y mostrar solo 10 resultados GET https://api.acelerala.com/v1/receipts?gross_total=gt:1000,lt=5000&limit=10
Listar comprobantes que hayan sido pagadas GET https://api.acelerala.com/v1/receipts?unclaimed_total=0
Identificador único del objeto.
Nombre del objeto.
Identificador del comercio al que pertenece la transacción.
Identificador de la orden a la que pertenece la transacción.
Identificador de la transacción asociada. Obligatorio cuando es una captura de una autorización previa. Opcional cuando se hace una devolución, en ese caso se puede enviar este campo para asociar la devolución a una compra previa.
El medio de pago utilizado para completar esta transacción:
cash
: Efectivo.
transfer
: Transferencia bancaria.
card
: Tarjeta de crédito o débito.
El tipo de transacción:
authorization
: Se autorizó una tarjeta de débito o crédito, pero aún no se captura el monto.
capture
: Se capturó el monto autorizado de una tarjeta de débito o crédito.
sale
: Para tarjetas, se autorizó y captura el monto en una misma transacción. Para otros medios de pago, se hace una venta. Por ejemplo, un cobro con transferencia bancaria siempre será sale
void
: Se dio de baja una autorización a una tarjeta de crédito o débito.
refund
: Devolución de dinero al cliente.
El monto total de la transacción
Código de la moneda en tres letras (Formato ISO 4217).
Mensaje mostrado al usuario. Algunos procesadores de pago devuelven este campo.
Mensaje para el comercio. Algunos procesadores de pago devuelven este campo.
ID de referencia de la marca procesadora. Se utiliza para tarjetas de crédito o débito.
Marca de la tarjeta:
visa
: Visa.
mastercard
: Mastercard.
american_express
: American Express
diners_club
: Diners Club.
Tipo de tarjeta:
credit
: Crédito.
debit
: Débito.
prepaid
: Prepago
Nombre de la empresa procesadora de pago:
culqi
: Culqi.
payu
: PayU.
mercadopago
: MercadoPago
niubiz
: Niubiz
acelerala
: Acelérala
ID de referencia de la procesadora de pago.
Arreglo de objetos de acreditaciones de las transacciones a distintos comprobantes. Una transacción puede ser acreditada a uno o más comprobantes.
La suma de los anticipos.
La suma de los anticipos.
La fecha y hora en la que se creo la orden (Formato ISO 8601).
La última fecha y hora en la que se modificó la orden (Formato ISO 8601).
{ "id": 13, "store_id": 4, "order_id": null, "parent_id": null, "method": "cash", "type": "sale", "amount": 200, "currency_code": "PEN", "user_message": null, "merchant_message": null, "reference_code": null, "card_brand": null, "card_type": null, "gateway": "test", "gateway_id": "123", "created": "2020-04-15T15:51:16.000Z", "modified": "2020-04-15T15:51:16.000Z", "claims": [ { "id": 14, "store_id": 4, "receipt_id": 71, "transaction_id": 13, "amount": 100, "currency_code": "PEN", "created": "2020-04-15T15:51:17.000Z", "modified": "2020-04-15T15:51:17.000Z" } ], "claimed_total": 100, "unclaimed_total": 100 }
Requiere el siguiente permiso:
read:transactions
para ver todos los comprobantes de una tienda.
Puedes elegir cualquiera de estos campos para ordenar los pedidos:
id
,amount
,created
,modified
,claimed_total
y unclaimed_total
.
Listar transacciones
GET https://api.acelerala.com/v1/transactions
Listar las últimas 20 transacciones ordenados por monto por pagar
GET https://api.acelerala.com/v1/transactions?limit=20&sort=unclaimed_total:desc
Listar transacciones con total entre 1000 y 5000, y mostrar solo 10 resultados GET https://api.acelerala.com/v1/transactions?gross_total=gt:1000,lt=5000&limit=10
Listar transacciones que hayan sido facturadas GET https://api.acelerala.com/v1/transactions?unclaimed_total=0
Identificador único del objeto.
Nombre del objeto.
Identificador del comercio al que pertenece el webhook.
Identificador del comprobante al cual está siendo acreditada el webhook.
Identificador de el webhook que está siendo acreditada al comprobante.
El monto acreditado. la suma de montos acreditados de una transacción o de un comprobante no puede ser mayor al total de el webhook o al total del comprobante.
Código de la moneda en tres letras (Formato ISO 4217). El código de moneda debe ser el mismo que el código del comprobante y de el webhook.
La fecha y hora en la que se creo la orden (Formato ISO 8601).
La última fecha y hora en la que se modificó la orden (Formato ISO 8601).
{ "id": 14, "object": "claim", "store_id": 4, "receipt_id": 71, "transaction_id": 13, "amount": 100, "currency_code": "PEN", "created": "2020-04-15T15:51:17.000Z", "modified": "2020-04-15T15:51:17.000Z" }
Requiere cualquiera de los siguientes permisos:
read:receipts
o read:transactions
para ver todas las acreditaciones de una tienda.
Puedes elegir cualquiera de estos campos para ordenar los pedidos:
id
,total
,created
,modified
,claimed_total
y unclaimed_total
.
Listar comprobantes
GET https://api.acelerala.com/v1/claims
Listar las acreditaciones de una transacción específica
GET https://api.acelerala.com/v1/claims?transaction_id=1
Identificador único del objeto.
Nombre del objeto.
Identificador del comercio al que pertenece la acreditación.
Descripción del webhook. Se usa para que otros usuarios que pertenezcan al comercio entiendan para qué se creó el webhook.
El endpoint a donde se te enviará la notificación con la data del evento.
Arreglo de los nombres de los eventos a los cuales está suscrito este webhook.
Flag para activar o desactivar el webhook.
La fecha y hora en la que se creo la orden (Formato ISO 8601).
La última fecha y hora en la que se modificó la orden (Formato ISO 8601).
{ "id": 13, "store_id": 4, "description": "Pedidos puestos", "url": "https://www.taund.com/test", "created": "2020-07-21T20:31:56.000-05", "modified": "2020-07-21T20:58:49.000-05", "active": 1, "enabled_events": [ "orders.created.placed", "orders.updated.placed" ] }
Requiere cualquiera de los siguientes permisos:
read:webhooks
para ver todos los webhooks de una tienda.
Puedes elegir cualquiera de estos campos para ordenar los pedidos:
id
,created
,modified
.
Listar webhooks
GET https://api.acelerala.com/v1/webhooks
Listar webhooks activos
GET https://api.acelerala.com/v1/webhooks?active=1