Retrieve the list of sales

GET

/api/ventas/

Authorizations

• apiKey

Parameters

Query Parameters

id__in

Array<integer>

fecha__gte

string format: date-time

fecha__lte

string format: date-time

fecha__gt

string format: date-time

fecha__lt

string format: date-time

created_by__id

integer

created_by__id__in

Array<integer>

assigned_to__id

integer

assigned_to__id__in

Array<integer>

cliente__id

integer

cliente__id__in

Array<integer>

cita__id

integer

cita__id__in

Array<integer>

limit

integer

offset

integer

Responses

200

List of requested sales

object

count

integer

next

One of:

string

string format: uri

null

null

previous

One of:

string

string format: uri

null

null

results

Array

object

id

Read only

integer

created

Read only

string format: date-time

updated

Read only

string format: date-time

fecha

Sale datetime

string format: date-time

base_imponible

Taxable base of the sale

number

total

Total sale amount, including taxes and discounts

number

importe_descuento_porcentaje

Discount percentage applied to the sale

number

importe_descuento_moneda

Absolute discount amount applied to the sale

number

importe_descuento_irpf

Amount of IRPF (Personal Income Tax) discounted

number

observaciones

Sale observations

string

forma_pago

One of:

integer

integer

object

Object that returns the value and text of the payment method, read only

object

value

integer

text

string

enum

importe_tarjeta_regalo

number

importe_tarjeta_fidelidad

number

importe_programa_puntos

number

puntos_utilizados

integer

puntos_generados

Read only

integer

importe_impuestos

number

entrega

The amount the customer delivers

number

entrega_efectivo

In case of a mixed sale, the amount the customer delivers in cash

number

entrega_tarjeta

In case of a mixed sale, the amount the customer delivers by card

number

is_pagada

boolean

is_enviar_encuesta

boolean

is_email_encuesta_sent

boolean

is_sms_encuesta_sent

boolean

num_ticket

integer

is_rectificada

boolean

created_by

object

value

User identifier

integer

text

User name

string

color

string format: hex

username

string format: email

foto_url_absolute_path

string format: uri

assigned_to

object

value

User identifier

integer

text

User name

string

color

string format: hex

username

string format: email

foto_url_absolute_path

string format: uri

cliente

object

text

Customer name

string

value

Customer identifier

integer

email

string format: email

movil

Customer mobile number

string format: tel

notas

string

is_anonymous

boolean

foto_url_absolute_path

string format: uri

localidad

string

importe_ventas

number

importe_deudas

number

code

integer

manual_code

string

fijo

string

dni

string

prefijo_tel

integer

tarjeta_regalo_usada

object

value

Gift card identifier

integer

text

Gift card name

string

precio

Gift card price

number

tarjeta_fidelidad_vendida

object

value

Loyalty card identifier

integer

text

Loyalty card name

string

precio

Loyalty card price

number

cita

Appointment identifier

integer

venta_original_rectificar

Sale rectified by this one

integer

401

Access key was not provided in the X-Koibox-Key header

Headers

WWW-Authenticate

string

default: X-Koibox-Key

Indicates the required header for authentication

403

A valid access key was not provided