NAV
cURL

Introducción

Bienvenido a la documentación de la API Gotesa Good and Boxes!

Gotesa GaB es una plataforma de integración de sistemas de gestión para PYMEs. El sistema está compuesto por una herramienta de gestión Web por una APP multiplataforma y por una API que expone la información del sistema y permite la integración de soluciones existentes.

La API sigue la arquitectura REST, donde los extremos estan construidos sobre el concepto de recursos, las acciones son representadas por los respectivos verbos del protocolo HTTP y los estados de las respuestas por los codigos de estado HTTP.

La URL de acceso a la API es:

https://api.gotesagab.com/v1

Todas las peticiones deben ser realizads sobre HTTPs.

Recursos

La URL raiz de la API provee la lista de los recursos y sus correspondientes URLS.

Respuesta HTTP

Cada llamada a la API devuelve una respuesta encapsulada en un objeto JSON.

Paginación

Cuando un recurso devuelve una colección de objetos paginada, se pueden enviar parámetros en la consulta para modificar el comportamiento de la paginación.

Parámetros de paginación

Parametro Defecto Descripción
pagina int Número de página
tam_pagina int Número de registros por página

Parámetros de consulta

En cada recurso se proporcionan los parámetros de consulta que admite. Los siguientes parámetros son admitidos por todos los recursos.

Parámetro Descripción
fecha Devuelve los registros que se han modificado desde esa fecha
ordenar Permite ordenar los registros por cualquier campo

Enumeraciones

En la API se utilizan un conjunto de enumeraciones que definen los siguientes elementos:

Primeros pasos

Para acceder a la API primero se debe dar de alta en la aplicación de gestión:

  1. Acceda a la web de GaB
  2. Pinche sobre el botón Nuevo usuario
  3. Rellene el formulario de registro
  4. Complete el asistente de creación de empresa

Una vez que se haya dado de alta en la aplicación recibirá un email con los datos de acceso. Por defecto el asistente de creación configurará la empresa con un conjunto de datos iniciales.

Autenticación

Para obtener el Token de seguridad use este código:

  curl 'https://api.gotesagab.com/v1/auth' \
   -H 'Content-Type: application/json' \
   -d \
    '{
        "username":"usuario",
        "password":"password",
        "tipo":"normal"
    }'

No olvide sustituir usuario y password por sus credenciales.

Gotesa GaB utiliza un Token de seguridad, para autenticar al usuario. Este Token se obtiene haciendo una llamada al recurso v1/auth y proporcionando los siguientes datos:

La API devolerá un objeto json con los datos del usuario, el Token de seguridad está en el campo auth_token. Este Token debe ser incluido en las siguientes peticiones a la API, en la cabecera de la petición como en el siguiente ejemplo:

Authorization: Bearer valor_del_token

Todas las respuestas HTTP serán enviadas en formato JSON, por lo que será necesario incluir la siguiente cabecera en cada petición:

Accept: application/json

Usuarios

Usuario

Ejemplo

{
    "id": 1,
    "username": "alejandro",
    "nombre_completo": "Alejandro",
    "email": "a@hola.com",
    "nombre": "Alejandro",
    "is_active": true,
    "observaciones": "",
    "direccion": "Cuenca",
    "poblacion": "Cuenca",
    "provincia": "Cuenca",
    "pais": "España",
    "telefono": "",
    "fecha_alta": "2015-07-20T15:08:03.811632Z",
    "ultima_empresa_seleccionada": 2    
}

Persona que se ha dado de alta en Gotesa Good and Boxes.

Atributos

Atributo Descripción
id Identificador único del usuario
username Nombre de usuario
nombre_completo Nombre completo del usuario
email Email del usuario
nombre Nombre del usuario
is_active Indica si el usuario esta activo en el sistema
observaciones Observaciones sobre el usuario
direccion Dirección del usuario
poblacion Población del usuario
provincia Provincia del usuario
pais País del usuario
telefono Teléfono del usuario
fecha_alta Fecha de alta del usuario
ultima_empresa_seleccionada Última empresa seleccionada por el usuario

Obtiene un usuario existente

Ejemplo

curl "https://api.gotesagab.com/v1/usuarios/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un usuario existente.

Petición HTTP

GET https://api.gotesagab.com/v1/usuarios/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del usuario

Actualiza un usuario existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/usuarios/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "direccion": "Cuenca",
    "poblacion": "Cuenca",
    "provincia": "Cuenca"
  }'

Actualiza los detalles de un usuario existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/usuarios/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del usuario

Parámetros JSON

Parámetro Descripción
*username Nombre de usuario
*email Email del usuario
*nombre Nombre del usuario
is_active Indica si el usuario esta activo en el sistema
observaciones Observaciones sobre el usuario
direccion Dirección del usuario
poblacion Población del usuario
provincia Provincia del usuario
pais País del usuario
telefono Teléfono del usuario
fecha_alta Fecha de alta del usuario
*ultima_empresa_seleccionada Última empresa seleccionada por el usuario

Borra un usuario existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/usuarios/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un usuario existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/usuarios/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del usuario

Recuperar contraseña

Ejemplo

curl "https://api.gotesagab.com/v1/usuarios/recuperar_password" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "nombreusuario": "username_o_email"    
  }'

Recupera la contraseña de un usuario.

Petición HTTP

POST https://api.gotesagab.com/v1/usuarios/recuperar_password

Parámetros de Consulta

Parámetro Descripción
nombreusuario Introducir el username o el email del usuario

Cambiar contraseña

Ejemplo

curl "https://api.gotesagab.com/v1/usuarios/cambiar_password" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "password_actual": "1234",  
    "password": "12345"
  }'

Cambia la contraseña de un usuario.

Petición HTTP

POST https://api.gotesagab.com/v1/usuarios/cambiar_password

Parámetros de Consulta

Parámetro Descripción
password_actual Contraseña actual del usuario
password Contraseña nueva para el usuario

Seleccionar empresa

Ejemplo

curl "https://api.gotesagab.com/v1/usuarios/seleccionar_empresa" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 1
  }'

Cambia la última empresa seleccionada por el usuario.

Petición HTTP

POST https://api.gotesagab.com/v1/usuarios/seleccionar_empresa

Parámetros de Consulta

Parámetro Descripción
empresa Identificador de la empresa

Empresas

Empresa

Ejemplo

{
    "id": 2,
    "mis_permisos": [
        ...
    ],
    "soy_propietario": true,
    "roles": [
        {
            "id": 1,
            "nombre": "gerencia",
            "nombre_corto": "gerencia",
            "orden": 10
        }
    ],
    "integrantes": [
        {
            "id": 1,
            "username": "alejandro",
            "nombre_completo": "Alejandro Santana Limaalejandro",
            "esta_activo": true,
            "nombre_rol": "gerencia",
            "es_propietario": true,
            "created_at": "2015-07-20T16:49:30+0000",
            "usuario": 1,
            "rol": 1,
            "almacen": 1
        },
        {
            "id": 2,
            "username": "alex",
            "nombre_completo": "Alexalex",
            "esta_activo": true,
            "nombre_rol": "gerencia",
            "es_propietario": false,
            "created_at": "2015-07-21T14:04:35+0000",
            "usuario": 2,
            "rol": 1,
            "almacen": 1
        },
        {
            "id": 6,
            "username": "julio",
            "nombre_completo": "Juliojulio",
            "esta_activo": true,
            "nombre_rol": "gerencia",
            "es_propietario": false,
            "created_at": "2015-07-23T11:39:16+0000",
            "usuario": 6,
            "rol": 20,
            "almacen": 14
        }
    ],
    "fecha_alta": "2015-07-20T16:49:23+0000",
    "fecha_modificacion": "2015-08-05T14:57:43+0000",
    "codigo": "01",
    "nombre": "Caloret Enterprises",
    "observaciones": "ipo",
    "contenido": null,
    "nombre_corto": "alejandro-empresa",
    "nif": "1",
    "razon_social": "El Caloret",
    "domicilio": "Cuenca",
    "localidad": "Cuenca",
    "email": "",
    "cod_postal": "",
    "telefono": "777777",
    "telefono_2": "",
    "telefono_movil": "",
    "fax": "",
    "web": "",
    "logotipo": "http://.../xmen.jpg",
    "plantilla_provincia": "",
    "plantilla_pais": "",
    "provincia_defecto": 20,
    "pais_defecto": 63,
    "forma_pago_defecto": 1,
    "tipo_iva_defecto": 2,
    "tarifa_defecto": 1,
    "cartera_defecto": 1,
    "almacen_defecto": 1,
    "serie_defecto": 1,
    "tipo_parada_defecto": 1,
    "regimen_iva_defecto": 25,
    "ruta_defecto": 1,
    "provincia": 20,
    "pais": 63,
    "regimen_iva": null,
    "propietario": 1,
    "plantilla_inicial": 1,
    "integrantes_empresa": [
        1,
        2,
        6
    ]
}

Una empresa es la entidad principal del sistema. El resto de entidades depende de la empresa y por lo tanto será necesario proporcionar el atributo empresa en cada petición a la API.

Atributos

Atributo Descripción
id Identificador único de la empresa
mis_permisos Conjunto de permisos efectivos del usuario
soy_propietario Indica si el usuario es propietario de la empresa
fecha_alta Fecha de creación de la empresa
fecha_modificacion Fecha de modificación de la empresa
codigo Código identificativo de la empresa
nombre Nombre de la empresa
observaciones Texto adicional para ampliar información
contenido Información HTML de la empresa
nombre_corto Identificador de la empresa
nif Número de indentificación fiscal de la empresa
razon_social Nombre comercial de la empresa
domicilio Domicilio de la empresa
localidad Localidad de la empresa
email Dirección email de la empresa
cod_postal Código postal de la empresa
telefono Teléfono de la empresa
telefono_2 Teléfono adicional de la empresa
telefono_movil Teléfono móvil de la empresa
fax Fax de la empresa
web Dirección web (URL) de la empresa
logotipo Imagen de la empresa
plantilla_provincia Provincia elegida en el asistente de creación
plantilla_pais Pais elegido en el asistente de creación
provincia_defecto Provincia por defecto usada en el resto de entidades
pais_defecto País por defecto usado en el resto de entidades
forma_pago_defecto Forma de pago por defecto usada en el resto de entidades
tipo_iva_defecto Tipo de IVA por defecto usado en el resto de entidades
tarifa_defecto Tipo de tarifa por defecto usada en el resto de entidades
cartera_defecto Tipo de cartera por defecto usada en el resto de entidades
almacen_defecto Almacén por defecto usado en el resto de entidades
serie_defecto Serie por defecto usada en el resto de entidades
tipo_parada_defecto Tipo de parada por defecto usada en el resto de entidades
regimen_iva_defecto Régimen de IVA por defecto usado en el resto de entidades
ruta_defecto Ruta por defecto usada en el resto de entidades
provincia Provincia de la empresa
pais País de la empresa
regimen_iva Régimen de IVA de la empresa
propietario Propietario de la empresa
plantilla_inicial Plantilla usada para la creación de la empresa
integrantes_empresa Lista de usuarios de la empresa

Lista de empresas

Ejemplo de petición

curl "https://api.gotesagab.com/v1/empresas" \
  -H "Authorization: meowmeowmeow"

Lista todas las empresas.

Petición HTTP

GET https://api.gotesagab.com/v1/empresas

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetro:

Parámetro Descripción
agente Filtra las empresas por el agente
nombre Filtra por el nombre de la empresa
codigo Filtra por el código de la empresa

Crear una nueva empresa

Ejemplo

curl "https://api.gotesagab.com/v1/empresas" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{    
    "codigo": "01",
    "nombre": "Enterprises",
    "observaciones": "",
    "contenido": "hola mundo",
    "nif": "1",
    "razon_social": "empresa",
    "domicilio": "",
    "localidad": "Cuenca",
    "email": "",
    "cod_postal": "",
    "telefono": "777777",
    "telefono_2": "",
    "telefono_movil": "",
    "fax": "",
    "web": "",
    "logotipo": null,
    "plantilla_provincia": "Cuenca",
    "plantilla_pais": "España"
  }'

Crea una nueva empresa en el sistema.

Petición HTTP

POST https://api.gotesagab.com/v1/empresas

Parámetros JSON

Parámetro Descripción
codigo Código de la empresa
*nombre Nombre de la empresa
observaciones Observaciones sobre la empresa
contenido Información HTML de la empresa
*nif NIF de la empresa
razon_social Razón social de la empresa
domicilio Domicilio de la empresa
localidad Localidad de la empresa
email Email de la empresa
cod_postal Código postal de la empresa
telefono Teléfono de la empresa
telefono_2 Teléfono adicional de la empresa
telefono_movil Teléfono móvil de la empresa
fax Fax de la empresa
web Web de la empresa
logotipo Logotipo de la empresa
plantilla_provincia Provincia de la empresa del asistente
plantilla_pais País de la empresa del asistente

Obtiene una empresa existente

Ejemplo

curl "https://api.gotesagab.com/v1/empresas/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una empresa existente.

Petición HTTP

GET https://api.gotesagab.com/v1/empresas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la empresa

Actualiza una empresa existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/empresas/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "uno",
    "nombre": "otra empresa"
  }'

Actualiza los detalles de una empresa existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/empresas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la empresa

Parámetros JSON

Estos parámetros son los mismos del recurso creación de empresa.

Borra una empresa existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/empresas/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una empresa existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/empresas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la empresa

Obtiene resumen de ventas

Ejemplo

curl "https://api.gotesagab.com/v1/empresas/1/dashboard?inicio=fecha_inicial&fin=fecha_final" \
  -H "Authorization: meowmeowmeow"

Obtiene el resumen de ventas de la empresa entre las fechas proporcionadas.

Petición HTTP

GET https://api.gotesagab.com/v1/empresas/id/dashboard?inicio=fecha_inicial&fin=fecha_final

Parámetros de Consulta

Parámetro Descripción
id Identificador de la empresa
*inicio Fecha de inicio de la consulta
*fin Fecha de fin de la consulta

Actualiza el logotipo de una empresa existente

Actualiza el logotipo de la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/empresas/logotipo

Parámetros de Consulta

Parámetro Descripción
id Identificador de la empresa
file Archivo de la imagen

Obtiene una empresa existente por su alias

Ejemplo

curl "https://api.gotesagab.com/v1/empresas/por_alias?alias=nombre_corto" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una empresa existente mediante su alias.

Petición HTTP

GET https://api.gotesagab.com/v1/empresas/por_alias?alias=nombre_corto

Parámetros de Consulta

Parámetro Descripción
alias Nombre corto de la empresa

Deja una empresa

Ejemplo

curl -X POST "https://api.gotesagab.com/v1/empresas/2/dejar_empresa" \
  -H "Authorization: meowmeowmeow"

Elimina al usuario de la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/empresas/id/dajar_empresa

Parámetros de Consulta

Parámetro Descripción
id Identificador de la empresa

Clientes

Cliente

Ejemplo

{
    "id": 1,
    "codigo": "0001",
    "nombre": "Alejandro",
    "empresa": 2,
    "razon_social": "",
    "localidad": "Cuenca",
    "observaciones": "",
    "ruta_principal": 1,
    "nif": "1",
    "domicilio": "Cuenca",
    "provincia": 1,
    "nombre_provincia": "Cuenca",
    "codigo_postal": "16004",
    "telefono": "",
    "telefono_movil": "",
    "email": "a@a.com",
    "logotipo": null,
    "posicion": "2.0,2.3",
    "tarifa": 1,
    "nombre_tarifa": "Normal Caloret",
    "forma_pago": 1,
    "nombre_forma_pago": "Contado - Calor",
    "contactos_cliente": [
        {
            "id": 27,
            "nombre": "Julio",
            "empresa": 2,
            "cargo": "Desarrollador",
            "telefono": "",
            "email": null
        },
        {
            "id": 3,
            "nombre": "Vincenzo",
            "empresa": 2,
            "cargo": "uno",
            "telefono": "666666666",
            "email": "adfa@asfads.com"
        },
        {
            "id": 2,
            "nombre": "Kase1",
            "empresa": 2,
            "cargo": "Jefe1",
            "telefono": "1",
            "email": "kase@o.com"
        }
    ],
    "domicilios_cobro_cliente": [
        {
            "id": 1,
            "empresa": 2,
            "nombre_banco": "Santander",
            "iban": "ES120",
            "principal": true
        }
    ],
    "porcentaje_descuento": 10.0,
    "regimen_iva": 16
}

Entidad o persona que adquiere productos o servicios de la empresa.

Atributos

Atributo Descripción
id Identificador único del cliente
codigo Código identificativo del cliente
nombre Nombre del cliente
empresa Empresa del cliente
razon_social Nombre comercial del cliente
localidad Localidad del cliente
observaciones Texto adicional para ampliar información
ruta_principal Ruta principal a la que está asignado el cliente
nif Número de indentificación fiscal del cliente
domicilio Domicilio del cliente
provincia Provincia del cliente
nombre_provincia Nombre de la provincia del cliente
codigo_postal Código postal del cliente
telefono Teléfono del cliente
telefono_movil Teléfono móvil del cliente
email Email del cliente
logotipo Logotipo del cliente
posicion Coordenadas de la ubicación del cliente
tarifa Tarifa del cliente
nombre_tarifa Nombre de la tarifa del cliente
forma_pago Forma de pago del cliente
nombre_forma_pago Nombre de la forma de pago del cliente
contactos_cliente Conjunto de contactos asociados con el cliente
domicilios_cobro_cliente Conjunto de domicilios de cobro que tiene el cliente
porcentaje_descuento Descuento aplicable a las compras del cliente
regimen_iva Régimen de IVA del cliente

Lista de clientes

Ejemplo de petición

curl "https://api.gotesagab.com/v1/clientes?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los clientes de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/clientes?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
nombre Filtra por el nombre del cliente
codigo Filtra por el código del cliente
localidad Filtra por la localidad del cliente
razon_social Filtra por el nombre comercial del cliente

Crear un nuevo cliente

Ejemplo

curl "https://api.gotesagab.com/v1/clientes" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "0001",
    "nombre": "Alejandro",
    "observaciones": "",
    "empresa": 2,
    "nif": "01234567A",
    "razon_social": "",
    "domicilio": "Cuenca",
    "localidad": "Cuenca",  
    "provincia": 1,  
    "codigo_postal": "16004",
    "telefono": "",
    "telefono_movil": "",
    "email": "a@a.com",
    "logotipo": null,
    "posicion": "2.0,2.3",
    "ruta_principal": 1,    
    "tarifa": 1,
    "forma_pago": 1,
    "porcentaje_descuento": 10.0,
    "regimen_iva": 16,
    "contactos_cliente": [
        {
            "nombre": "Julio",
            "empresa": 2,
            "cargo": "Desarrollador",
            "telefono": "",
            "telefono_movil": "",
            "email": null
        },
        {
            "nombre": "Vincenzo",
            "empresa": 2,
            "cargo": "uno",
            "telefono": "666666666",
            "telefono_movil": "",
            "email": "adfa@asfads.com"
        }       
    ],
    "domicilios_cobro_cliente": [
        {
            "empresa": 2,
            "nombre_banco": "Santander",
            "iban": "ES120",
            "principal": true
        }
    ]
  }'

Crea un nuevo cliente en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/clientes

Parámetros JSON

Parámetro Descripción
codigo Código del cliente
*nombre Nombre del cliente
observaciones Observaciones sobre el cliente
*empresa Empresa del cliente
*nif NIF del cliente
razon_social Razón social del cliente
*domicilio Domicilio del cliente
*localidad Localidad del cliente
*provincia Provincia del cliente
*codigo_postal Código postal del cliente
telefono Teléfono del cliente
telefono_movil Teléfono móvil del cliente
*email Email del cliente
logotipo Logotipo del cliente
posicion Coordenadas de la ubicación del cliente
ruta_principal Ruta principal a la que está asignado el cliente
*tarifa Tarifa del cliente
*forma_pago Forma de pago del cliente
porcentaje_descuento Descuento aplicable a las compras del cliente
*regimen_iva Régimen de IVA del cliente
*contactos_cliente Conjunto de contactos asociados con el cliente
*domicilios_cobro_cliente Conjunto de domicilios de cobro que tiene el cliente

Obtiene un cliente existente

Ejemplo

curl "https://api.gotesagab.com/v1/clientes/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un cliente existente.

Petición HTTP

GET https://api.gotesagab.com/v1/clientes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cliente

Actualiza un cliente existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/clientes/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "uno",
    "codigo_postal": "16003",
  }'

Actualiza los detalles de un cliente existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/clientes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cliente

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un cliente a excepción de los “contactos” y los “domicilios de cobro” que se deben actualizar en su recurso correspondiente.

Borra un cliente existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/clientes/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un cliente existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/clientes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cliente

Actualiza el logotipo de un cliente existente

Actualiza el logotipo del cliente.

Petición HTTP

POST https://api.gotesagab.com/v1/clientes/logotipo

Parámetros de Consulta

Parámetro Descripción
id Identificador del cliente
file Archivo de la imagen

Contacto de un cliente

Ejemplo

{
    "id": 2,
    "nombre": "Alejandro",
    "empresa": 2,
    "cargo": "Jefe",
    "telefono": "1",
    "email": "kase@o.com",
    "telefono_movil": "666555555",
    "cliente": 1
}

Persona que tiene relación con el cliente.

Atributos

Atributo Descripción
id Identificador único del contacto
nombre Nombre del contacto
empresa Empresa del contacto
telefono Teléfono del contacto
telefono_movil Teléfono móvil del contacto
email Email del contacto
cliente Cliente al que va asociado el contacto

Lista de contactos

Ejemplo de petición

curl "https://api.gotesagab.com/v1/contactos?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los contactos de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/contactos?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
cliente Filtra los contactos por cliente

Crear un nuevo contacto

Ejemplo

curl "https://api.gotesagab.com/v1/contactos" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{    
    "nombre": "Alejandro",
    "empresa": 2,
    "cargo": "Jefe",
    "telefono": "1",
    "email": "kase@o.com",
    "telefono_movil": "666555555",
    "cliente": 1
  }'

Crea un nuevo contacto para el cliente.

Petición HTTP

POST https://api.gotesagab.com/v1/contactos

Parámetros JSON

Parámetro Descripción
*nombre Nombre del contacto
*empresa Empresa del contacto
telefono Teléfono del contacto
telefono_movil Teléfono móvil del contacto
email Email del contacto
*cliente Cliente al que va asociado el contacto

Obtiene un contacto existente

Ejemplo

curl "https://api.gotesagab.com/v1/contactos/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un contacto existente.

Petición HTTP

GET https://api.gotesagab.com/v1/contactos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del contacto

Actualiza un contacto existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/contactos/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "nombre": "Miguel",
    "telefono": "123456",
  }'

Actualiza los detalles de un contacto existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/contactos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del contacto

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un contacto.

Borra un contacto existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/contactos/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un contacto existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/contactos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del contacto

Domicilio de cobro de un cliente

Ejemplo

{
    "id": 1,
    "empresa": 2,
    "nombre_banco": "Santander",
    "iban": "ES120",
    "principal": true,
    "cliente": 1
}

Datos bancarios de un cliente a donde se emitirán los recibos.

Atributos

Atributo Descripción
id Identificador único del domicilio de cobro
empresa Empresa del domicilio de cobro
nombre_banco Nombre del banco del domicilio de cobro
iban Identificador de la cuenta bancaria del domicilio de cobro
principal Identifica el domicilio de cobro principal del cliente
cliente Cliente al que va asociado el domicilio de cobro

Lista de domicilios de cobro

Ejemplo de petición

curl "https://api.gotesagab.com/v1/domicilioscobro?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los domicilios de cobro de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/domicilioscobro?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
cliente Filtra los domicilios de cobro por cliente

Crear un nuevo domicilio de cobro

Ejemplo

curl "https://api.gotesagab.com/v1/domicilioscobro" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "nombre_banco": "Santander",
    "iban": "ES120",
    "principal": true,
    "cliente": 1
  }'

Crea un nuevo domicilio de cobro para el cliente.

Petición HTTP

POST https://api.gotesagab.com/v1/domicilioscobro

Parámetros JSON

Parámetro Descripción
*empresa Empresa del domicilio de cobro
*nombre_banco Nombre del banco del domicilio de cobro
*iban Identificador de la cuenta bancaria del domicilio de cobro
*principal Identifica al domicilio de cobro principal del cliente
*cliente Cliente al que va asociado el domicilio de cobro

Obtiene un domicilio de cobro existente

Ejemplo

curl "https://api.gotesagab.com/v1/domicilioscobro/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un domicilio de cobro existente.

Petición HTTP

GET https://api.gotesagab.com/v1/domicilioscobro/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del domicilio de cobro

Actualiza un domicilio de cobro existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/domicilioscobro/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "nombre_banco": "Otro banco",
    "principal": false,
  }'

Actualiza los detalles de un domicilio de cobro existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/domicilioscobro/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del domicilio de cobro

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un domicilio de cobro.

Borra un domicilio de cobro existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/domicilioscobro/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un domicilio de cobro existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/domicilioscobro/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del domicilio de cobro

Rutas

Ruta

Ejemplo

{
    "id": 1,
    "empresa": 2,
    "codigo": "01",
    "nombre": "Centro cuenca",
    "lunes": true,
    "martes": false,
    "miercoles": true,
    "jueves": false,
    "viernes": false,
    "sabado": true,
    "domingo": true,
    "cliente_ruta": [
        {
            "id": 4,
            "cliente": 3,
            "codigo": "03",
            "nombre": "Pedro",
            "localidad": "Madrid",
            "posicion": 1,
            "observaciones": null
        },
        {
            "id": 6,
            "cliente": 19,
            "codigo": "",
            "nombre": "Carlos",
            "localidad": "Cuenca",
            "posicion": 2,
            "observaciones": null
        }
    ],
    "observaciones": "observaciones de la ruta"
}

Trayectos que realizan los agentes de ventas.

Atributos

Atributo Descripción
id Identificador único de la ruta
empresa Empresa de la ruta
codigo Código identificativo de la ruta
nombre Nombre de la ruta
lunes Indica si el trayecto se debe realizar el lunes
martes Indica si el trayecto se debe realizar el martes
miercoles Indica si el trayecto se debe realizar el miércoles
jueves Indica si el trayecto se debe realizar el jueves
viernes Indica si el trayecto se debe realizar el viernes
sabado Indica si el trayecto se debe realizar el sábado
domingo Indica si el trayecto se debe realizar el domingo
cliente_ruta Conjunto de clientes incluidos en la ruta
observaciones Observaciones sobre la ruta

Lista de rutas

Ejemplo de petición

curl "https://api.gotesagab.com/v1/rutas?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las rutas de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/rutas?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código de la ruta
nombre Filtra por el nombre de la ruta
L Devuelve las rutas activas el lunes
M Devuelve las rutas activas el martes
X Devuelve las rutas activas el miércoles
J Devuelve las rutas activas el jueves
V Devuelve las rutas activas el viernes
S Devuelve las rutas activas el sábado
D Devuelve las rutas activas el domingo

Crear una ruta

Ejemplo

curl "https://api.gotesagab.com/v1/rutas" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "codigo": "01",
    "nombre": "Centro cuenca",
    "lunes": true,
    "martes": false,
    "miercoles": true,
    "jueves": false,
    "viernes": false,
    "sabado": true,
    "domingo": true,
    "cliente_ruta": [
        {            
            "cliente": 3,
            "codigo": "03",
            "nombre": "Pedro",
            "localidad": "Madrid",
            "posicion": 1,
            "observaciones": null
        }
    ],
    "observaciones": ""
  }'

Crea una nueva ruta en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/rutas

Parámetros JSON

Parámetro Descripción
*empresa Empresa de la ruta
codigo Código identificativo de la ruta
*nombre Nombre de la ruta
*lunes Indica si el trayecto se debe realizar el lunes
*martes Indica si el trayecto se debe realizar el martes
*miercoles Indica si el trayecto se debe realizar el miércoles
*jueves Indica si el trayecto se debe realizar el jueves
*viernes Indica si el trayecto se debe realizar el viernes
*sabado Indica si el trayecto se debe realizar el sábado
*domingo Indica si el trayecto se debe realizar el domingo
observaciones Observaciones sobre la ruta
*cliente_ruta Conjunto de clientes incluidos en la ruta

Obtiene una ruta existente

Ejemplo

curl "https://api.gotesagab.com/v1/rutas/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una ruta existente.

Petición HTTP

GET https://api.gotesagab.com/v1/rutas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la ruta

Actualiza una ruta existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/rutas/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "nombre": "Fin de semana Cuenca",
    "sabado": true,
    "domingo": true,
  }'

Actualiza los detalles de una ruta existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/rutas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la ruta

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una ruta a excepción del array “cliente_ruta” que no es necesario.

Borra una ruta existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/rutas/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una ruta existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/rutas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la ruta

Cliente de una ruta

Ejemplo

{
    "id": 2,
    "empresa": 2,
    "ruta": 1,
    "cliente": 2,
    "posicion": 4,
    "observaciones": null
}

Clientes asociados a una ruta.

Atributos

Atributo Descripción
id Identificador único del cliente-ruta
empresa Empresa de la ruta
ruta Ruta a la que se asocia el cliente
cliente Cliente de la ruta
posicion Posición del cliente-ruta
observaciones Observaciones sobre el cliente-ruta

Lista de rutas

Ejemplo de petición

curl "https://api.gotesagab.com/v1/clientesruta?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los clientes asociados a alguna ruta.

Petición HTTP

GET https://api.gotesagab.com/v1/clientesruta?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
cliente Filtra por el cliente de la ruta
ruta Filtra por la ruta

Añadir cliente a una ruta

Ejemplo

curl "https://api.gotesagab.com/v1/clientesruta" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "ruta": 1,
    "cliente": 2,
    "posicion": 4,
    "observaciones": null
  }'

Añade un cliente a una ruta.

Petición HTTP

POST https://api.gotesagab.com/v1/clientesruta

Parámetros JSON

Parámetro Descripción
*empresa Empresa de la ruta
*ruta Ruta a la que se asocia el cliente
*cliente Cliente de la ruta
*posicion Posición del cliente-ruta
observaciones Observaciones sobre el cliente-ruta

Obtiene un cliente-ruta existente

Ejemplo

curl "https://api.gotesagab.com/v1/clientesruta/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de la relación existente entre un cliente y una ruta existente.

Petición HTTP

GET https://api.gotesagab.com/v1/clientesruta/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cliente-ruta

Actualiza un cliente-ruta existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/clientesruta/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "posicion": 7
  }'

Actualiza los detalles de la relación existente entre un cliente y una ruta existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/clientesruta/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cliente-ruta

Parámetros JSON

Estos parámetros son los mismos del recurso añadir cliente a una ruta.

Borra un cliente-ruta existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/clientesruta/2" \
  -H "Authorization: meowmeowmeow"

Borra la relación entre un cliente y una ruta.

Petición HTTP

DELETE https://api.gotesagab.com/v1/clientesruta/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cliente-ruta

Reordena los clientes dentro de una ruta

Ejemplo

curl "https://api.gotesagab.com/v1/clientesruta/reordenar" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{ 
    "id": 1,
    "cliente_ruta": [
                    {
                       "cliente": 13,
                       "posicion": 1
                    },
                    {
                       "cliente": 16,
                       "posicion": 2
                    }
    ]
}'

Reordena los clientes dentro de una ruta. El nuevo orden de los clientes vendrá definido por el orden dentro del array “cliente_ruta”.

Petición HTTP

POST https://api.gotesagab.com/v1/clientesruta/reordenar

Parámetros JSON

Parámetro Descripción
*id Identificador de la ruta
*ruta Ruta a la que se asocia el cliente
*cliente_ruta Conjunto de clientes incluidos en la ruta
*cliente_ruta (cliente) Identificador del cliente
*cliente_ruta (posicion) Posición del cliente en la ruta

Itinerario

Ejemplo

{
    "id": 1,
    "paradas": [
        {
            "id": 1,
            "documentos_parada": [
                {
                    "id": 3,
                    "documento": 6,
                    "pedido": null,
                    "factura": null,
                    "albaran": 1
                },
                {
                    "id": 5,
                    "documento": 6,
                    "pedido": null,
                    "factura": 1,
                    "albaran": null
                }
            ],
            "posicion": 1.0,
            "fecha": "2015-07-21T07:54:08+0000",
            "gastos": 16.0,
            "observaciones": "prueba",
            "lugar": "",
            "duracion": 2.5,
            "empresa": 2,
            "cliente": 1,
            "tipo": null,
            "intinerario": 1
        }
    ],
    "inicio": "2015-07-21T07:35:57+0000",
    "observaciones": "hola mundo",
    "empresa": 2,
    "ruta": 1,
    "usuario": 1
}

Trayecto realizado por un agente de ventas.

Atributos

Atributo Descripción
id Identificador único del itinerario
paradas Conjunto de paradas del itinerario
inicio Fecha de inicio del itinerario
observaciones Observaciones sobre el itinerario
empresa Empresa de la ruta
ruta Ruta del itinerario
usuario Agente que ha realizado el itinerario

Lista de itinerarios

Ejemplo de petición

curl "https://api.gotesagab.com/v1/itinerarios?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los itinerarios de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/itinerarios?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
usuario Filtra por el agente del itinerario
ruta Filtra por la ruta del itinerario

Crear un itinerario

Ejemplo

curl "https://api.gotesagab.com/v1/itinerarios" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "ruta": 1,
    "usuario": 1
    "inicio": "2015-07-21T07:35:57+0000",
    "observaciones": "hola mundo",      
  }'

Crea un nuevo itinerario en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/itinerarios

Parámetros JSON

Parámetro Descripción
*empresa Empresa del itinerario
*ruta Ruta del itinerario
*usuario Agente que ha realizado el itinerario
*inicio Fecha de inicio del itinerario
observaciones Observaciones sobre el itinerario

Obtiene un itinerario existente

Ejemplo

curl "https://api.gotesagab.com/v1/itinerarios/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un itinerario existente.

Petición HTTP

GET https://api.gotesagab.com/v1/itinerarios/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del itinerario

Actualiza un itinerario existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/itinerarios/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "inicio": "2015-07-21T07:35:57+0000",
  }'

Actualiza los detalles de un itinerario existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/itinerarios/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del itinerario

Parámetros JSON

Estos parámetros son los mismos del recurso crear itinerario.

Borra un itinerario existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/itinerarios/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un itinerario existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/itinerarios/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del itinerario

Parada

Ejemplo

{
    "id": 1,
    "documentos_parada": [
        {
            "id": 3,
            "documento": 6,
            "pedido": null,
            "factura": null,
            "albaran": 1
        },
        {
            "id": 5,
            "documento": 6,
            "pedido": null,
            "factura": null,
            "albaran": 1
        }
    ],
    "posicion": 1.0,
    "fecha": "2015-07-21T07:54:08+0000",
    "gastos": 16.0,
    "observaciones": "prueba",
    "lugar": "",
    "duracion": 2.5,
    "empresa": 2,
    "cliente": 1,
    "tipo": null,
    "intinerario": 1
}

Parada realizada por un agente de ventas dentro de un itinerario.

Atributos

Atributo Descripción
id Identificador único de la parada
documentos_parada Conjunto de documentos de la parada
posicion Posicion de la parada dentro del itinerario
fecha Fecha de la parada
gastos Gastos de la parada
observaciones Observaciones sobre la parada
lugar Lugar de la parada
duracion Duración de la parada
empresa Empresa de la parada
cliente Cliente de la parada
tipo Identificador del tipo de parada
intinerario Itinerario de la parada

Lista de paradas

Ejemplo de petición

curl "https://api.gotesagab.com/v1/paradas?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las paradas de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/paradas?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
intinerario Filtra por itinerario

Crear una parada

Ejemplo

curl "https://api.gotesagab.com/v1/paradas" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "documentos_parada": [        
        {
            "id": 0,
            "documento": 6,
            "pedido": null,
            "factura": null,
            "albaran": 5
        },
        {
            "id": -1,
            "documento": 6,
            "pedido": null,
            "factura": null,
            "albaran": 1
        }
    ],
    "posicion": 1.0,
    "fecha": "2015-07-21T07:54:08+0000",
    "gastos": 16.0,
    "observaciones": "hola mundo",
    "lugar": "",
    "duracion": 2.5,
    "empresa": 2,
    "cliente": 1,
    "tipo": null,
    "intinerario": 1
  }'

Crea una nueva parada en el itinerario.

Petición HTTP

POST https://api.gotesagab.com/v1/paradas

Parámetros JSON

Parámetro Descripción
*empresa Empresa de la parada
*documentos_parada Conjunto de documentos de la parada
*documentos_parada (id) Identificador del documento parada
*documentos_parada (documento) Identificador del documento configuración
*posicion Posicion de la parada dentro del itinerario
fecha Fecha de la parada
gastos Gastos de la parada
observaciones Observaciones sobre la parada
lugar Lugar de la parada
duracion Duración de la parada
cliente Cliente de la parada
tipo Identificador del tipo de parada
*intinerario Itinerario de la parada

Obtiene una parada existente

Ejemplo

curl "https://api.gotesagab.com/v1/paradas/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una parada existente.

Petición HTTP

GET https://api.gotesagab.com/v1/paradas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la parada

Actualiza una parada existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/paradas/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "documentos_parada": [        
        {
            "id": 2,
            "documento": 6,
            "pedido": null,
            "factura": null,
            "albaran": 5
        },
        {
            "id": 3,
            "documento": 6,
            "pedido": null,
            "factura": null,
            "albaran": 1
        },
        {
            "id": 0,
            "documento": 6,
            "pedido": null,
            "factura": null,
            "albaran": 5
        },
        {
            "id": -1,
            "documento": 6,
            "pedido": null,
            "factura": null,
            "albaran": 1
        }
    ],
    "posicion": 1.0,
    "fecha": "2015-07-21T07:54:08+0000",
    "gastos": 16.0,
    "observaciones": "prueba",
    "lugar": "",
    "duracion": 2.5,
    "empresa": 2,
    "cliente": 1,
    "tipo": null,
    "intinerario": 1
  }'

Actualiza los detalles de una parada existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/paradas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la parada

Parámetros JSON

Estos parámetros son los mismos del recurso crear una parada.

Borra una parada existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/paradas/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una parada existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/paradas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la parada

Artículos

Artículo

Ejemplo

{
    "id": 1,
    "codigo": "01",
    "nombre": "ventana 50x50",
    "empresa": 2,
    "nombre_familia": "ventanas aluminio",
    "logotipo": null,
    "tipo_iva": 1,
    "nombre_tipo_iva": "General",
    "familia": 1,
    "precio_compra": 26.0,
    "tarifas_articulo": [
        {
            "id": 1,
            "tarifa": 1,
            "nombre_tarifa": "Normal",
            "precio": 5.0
        },
        {
            "id": 2,
            "tarifa": 3,
            "nombre_tarifa": "Tarifa 2",
            "precio": 30.7
        }
    ],
    "observaciones": "hola mundo",
    "articulo_almacen": [
        {
            "id": 1,
            "nombre_almacen": "Almacén 1",
            "cantidad": 30
        },
        {
            "id": 30,
            "nombre_almacen": "Almacén 2",
            "cantidad": 2
        }
    ]
}

Productos y servicios que ofrece la empresa a sus clientes.

Atributos

Atributo Descripción
id Identificador único del artículo
codigo Código identificativo del artículo
nombre Nombre del artículo
empresa Empresa del artículo
familia Familia del artículo
nombre_familia Nombre de la familia del artículo
logotipo Imagen del artículo
tipo_iva Tipo de IVA del artículo
nombre_tipo_iva Nombre del tipo de IVA del artículo
precio_compra Precio de compra del artículo
tarifas_articulo Conjunto de tarifas del artículo
observaciones Observaciones sobre el artículo
articulo_almacen Conjunto de almacenes en los que se encuentra el artículo

Lista de artículos

Ejemplo de petición

curl "https://api.gotesagab.com/v1/articulos?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los artículos de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/articulos?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código del artículo
nombre Filtra por el nombre del artículo
familia__nombre Filtra por el nombre de la familia del artículo

Crear un artículo

Ejemplo

curl "https://api.gotesagab.com/v1/articulos" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "01",
    "nombre": "ventana 50x50",
    "empresa": 2,
    "logotipo": null,
    "tipo_iva": 1,
    "familia": 1,
    "precio_compra": 26.0,
    "tarifas_articulo": [
        {            
            "tarifa": 1,            
            "precio": 5.0
        },
        {            
            "tarifa": 3,            
            "precio": 30.7
        }
    ],
    "observaciones": "hola mundo",
    "articulo_almacen": [
        {            
            "almacen": 30,
            "cantidad": 30            
        },
        {            
            "almacen": 30,
            "cantidad": 2            
        }
    ]
  }'

Crea un nuevo artículo en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/articulos

Parámetros JSON

Parámetro Descripción
codigo Código identificativo del artículo
*nombre Nombre del artículo
*empresa Empresa del artículo
familia Familia del artículo
logotipo Imagen del artículo
*tipo_iva Tipo de IVA del artículo
precio_compra Precio de compra del artículo
observaciones Observaciones sobre el artículo
*tarifas_articulo Conjunto de tarifas del artículo
*articulo_almacen Conjunto de almacenes en los que se encuentra el artículo

Obtiene un artículo existente

Ejemplo

curl "https://api.gotesagab.com/v1/articulos/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un artículo existente.

Petición HTTP

GET https://api.gotesagab.com/v1/articulos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo

Actualiza un artículo existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/articulos/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "nombre": "Monitores",
    "precio_compra": 120.0  
  }'

Actualiza los detalles de un artículo existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/articulos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un artículo a excepción del array “tarifas_articulo” que no es necesario.

Borra un artículo existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/articulos/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un artículo existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/articulos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo

Actualiza el logotipo de un artículo existente

Actualiza el logotipo del artículo.

Petición HTTP

POST https://api.gotesagab.com/v1/articulos/logotipo

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo
file Archivo de la imagen

Tarifa del artículo

Ejemplo

{
    "id": 1,
    "empresa": 2,
    "tarifa": 1,
    "articulo": 1,
    "precio": 5.0,
    "nombre_tarifa": "Normal Caloret",
    "nombre_articulo": "ventana 50x50",
    "observaciones": null
}

Tarifas de un artículo.

Atributos

Atributo Descripción
id Identificador único de la tarifa-artículo
empresa Empresa del artículo
tarifa Identificador de la tarifa a relacionar con el artículo
articulo Identificador del artículo
precio Precio del artículo con esta tarifa
nombre_tarifa Nombre de la tarifa
nombre_articulo Nombre del artículo
observaciones Observaciones sobre la tarifa-artículo

Lista de las tarifas-artículo

Ejemplo de petición

curl "https://api.gotesagab.com/v1/tarifasarticulo?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las tarifas de los artículos.

Petición HTTP

GET https://api.gotesagab.com/v1/tarifasarticulo?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
tarifa Filtra por la tarifa
articulo Filtra por el artículo
articulo__familia__nombre Filtra por el nombre de la familia del artículo
articulo__codigo Filtra por código del artículo
articulo__nombre Filtra por el nombre del artículo

Crear una nueva tarifa-artículo

Ejemplo

curl "https://api.gotesagab.com/v1/tarifasarticulo" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "tarifa": 1,
    "articulo": 1,
    "precio": 5.0,
    "observaciones": null
  }'

Crea una nueva tarifa para el artículo.

Petición HTTP

POST https://api.gotesagab.com/v1/tarifasarticulo

Parámetros JSON

Parámetro Descripción
*empresa Empresa del artículo
*tarifa Identificador de la tarifa a relacionar con el artículo
*articulo Identificador del artículo
*precio Precio del artículo con esta tarifa
observaciones Observaciones sobre la tarifa-artículo

Obtiene una tarifa-artículo existente

Ejemplo

curl "https://api.gotesagab.com/v1/tarifasarticulo/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una tarifa-artículo existente.

Petición HTTP

GET https://api.gotesagab.com/v1/tarifasarticulo/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la tarifa-artículo

Actualiza una tarifa-artículo existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/tarifasarticulo/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "precio": 10.5    
  }'

Actualiza los detalles de una tarifa-artículo existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/tarifasarticulo/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la tarifa-artículo

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una taria-artículo.

Borra una tarifa-artículo existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/tarifasarticulo/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una tarifa-artículo existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/tarifasarticulo/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la tarifa-artículo

Artículos con precio

Ejemplo

curl "https://api.gotesagab.com/v1/tarifasarticulo/articulosconprecio?empresa=1" \
  -H "Authorization: meowmeowmeow"

Recurso especial de tarifas-artículo que muestra además de sus datos el precio del artículo si está incluido en alguna oferta.

Petición HTTP

GET https://api.gotesagab.com/v1/tarifasarticulo/articulosconprecio?empresa=empresa

Parámetros de Consulta

Parámetro Descripción
*empresa Filtra por empresa
tarifa Filtra por la tarifa
articulo Filtra por el artículo
articulo__familia__nombre Filtra por el nombre de la familia del artículo
articulo__codigo Filtra por código del artículo
articulo__nombre Filtra por el nombre del artículo

Almacén

Ejemplo

{
    "id": 1,
    "codigo": "01",
    "nombre": "Almacén de cuenca",
    "empresa": 2,
    "provincia": 19,
    "observaciones": "",
    "articulos": [        
        {
            "id": 1,
            "codigo": "01",
            "nombre": "ventana 50x50",
            "empresa": 2,
            "nombre_familia": "ventanas aluminio"
        },
        {
            "id": 2,
            "codigo": "02",
            "nombre": "Cajas",
            "empresa": 2,
            "nombre_familia": "Cajas"
        }
    ],
    "telefono": "",
    "email": "",
    "domicilio": "",
    "localidad": "Cuenca",
    "cod_postal": "16004"
}

Edificio o local donde se depositan géneros de cualquier especie, generalmente mercancías.

Atributos

Atributo Descripción
id Identificador único del almacén
codigo Código identificativo del almacén
nombre Nombre del almacén
empresa Empresa del almacén
provincia Provincia del almacén
articulos Conjunto de artículos del almacén
telefono Teléfono del almacén
email Email del almacén
domicilio Domicilio del almacén
localidad Localidad del almacén
cod_postal Código postal del almacén

Lista de almacenes

Ejemplo de petición

curl "https://api.gotesagab.com/v1/almacenes?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los almacenes de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/almacenes?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código del almacén
nombre Filtra por el nombre del almacén

Crear un almacén

Ejemplo

curl "https://api.gotesagab.com/v1/almacenes" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "01",
    "nombre": "Almacén de cuenca",
    "empresa": 2,
    "provincia": 19,
    "observaciones": "",   
    "telefono": "",
    "email": "",
    "domicilio": "",
    "localidad": "Cuenca",
    "cod_postal": "16004"
  }'

Crea un nuevo almacén en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/almacenes

Parámetros JSON

Parámetro Descripción
codigo Código identificativo del almacén
*nombre Nombre del almacén
empresa Empresa del almacén
provincia Provincia del almacén
telefono Teléfono del almacén
email Email del almacén
domicilio Domicilio del almacén
localidad Localidad del almacén
cod_postal Código postal del almacén

Obtiene un almacén existente

Ejemplo

curl "https://api.gotesagab.com/v1/almacenes/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un almacén existente.

Petición HTTP

GET https://api.gotesagab.com/v1/almacenes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del almacén

Actualiza un almacén existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/almacenes/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "nombre": "Almacén norte"       
  }'

Actualiza los detalles de un almacén existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/almacenes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del almacén

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un almacén.

Borra un almacén existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/almacenes/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un almacén existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/almacenes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del almacén

Artículos en el almacén

Ejemplo

{
    "id": 1,
    "empresa": 2,
    "articulo": 1,
    "almacen": 1,
    "cantidad": 33,
    "nombre_articulo": "ventana 50x50",
    "nombre_almacen": "Almacén de cuenca",
    "observaciones": null
}

Artículos disponibles en el almacén.

Atributos

Atributo Descripción
id Identificador único del artículo-almacén
empresa Empresa del almacén
articulo Identificador del artículo
almacen Identificador del almacén
cantidad Cantidad en stock del artículo
nombre_articulo Nombre del artículo
nombre_almacen Nombre del almacén
observaciones Observaciones sobre el artículo-almacén

Lista de los artículos-almacén

Ejemplo de petición

curl "https://api.gotesagab.com/v1/articulosalmacen?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los artículos-almacén.

Petición HTTP

GET https://api.gotesagab.com/v1/articulosalmacen?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
almacen Filtra por el almacén
articulo Filtra por el artículo
cantidad Filtra por la cantidad

Crear un nuevo artículo-almacén

Ejemplo

curl "https://api.gotesagab.com/v1/articulosalmacen" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "articulo": 1,
    "almacen": 1,
    "cantidad": 33,
    "observaciones": null
  }'

Crea un nuevo artículo-almacén.

Petición HTTP

POST https://api.gotesagab.com/v1/articulosalmacen

Parámetros JSON

Parámetro Descripción
*empresa Empresa del almacén
*articulo Identificador del artículo
*almacen Identificador del almacén
*cantidad Cantidad en stock del artículo
observaciones Observaciones sobre el artículo-almacén

Obtiene un artículo-almacén existente

Ejemplo

curl "https://api.gotesagab.com/v1/articulosalmacen/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un artículo-almacén existente.

Petición HTTP

GET https://api.gotesagab.com/v1/articulosalmacen/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo-almacén

Actualiza un artículo-almacén existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/articulosalmacen/2" \
  -H "Authorization: meowmeowmeow" -\
  -H "Content-Type: application/json" -d \
  '{
    "cantidad": 200    
  }'

Actualiza los detalles de un artículo-almacén existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/articulosalmacen/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo-almacén

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un artículo-almacén.

Borra un artículo-almacén existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/articulosalmacen/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un artículo-almacén existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/articulosalmacen/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo-almacén

Oferta

Ejemplo

{
    "id": 4,
    "empresa": 2,
    "codigo": "",
    "nombre": "Oferta verano",
    "inicio": "2015-08-10T11:40:33Z",
    "fin": "2015-08-11T12:05:27Z",
    "tipo": 1,
    "tarifa": 1,
    "activo": true,
    "articulo_oferta": [
        {
            "id": 23,
            "nombre_articulo": "Fanta Naranja",
            "nombre_familia": "Refrescos",
            "codigo_articulo": "",
            "precio": 0.3,
            "descuento": 0.0,            
            "articulo": 10
        }
    ],
    "observaciones": ""
}

Precios aplicados a un grupo de artículos durante un determinado tiempo.

Atributos

Atributo Descripción
id Identificador único de la oferta
codigo Código identificativo de la oferta
nombre Nombre de la oferta
empresa Empresa de la oferta
inicio Fecha de inicio de la oferta
fin Fecha de fin de la oferta
tipo Tipo de la oferta
tarifa Tarifa de la oferta
activo Indica si la oferta esta activa
articulo_oferta Conjunto de artículos incluidos en la oferta

Lista de ofertas

Ejemplo de petición

curl "https://api.gotesagab.com/v1/ofertas?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos las ofertas de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/ofertas?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código de la oferta
nombre Filtra por el nombre de la oferta
tipo Filtra por el tipo de la oferta

Crear una oferta

Ejemplo

curl "https://api.gotesagab.com/v1/ofertas" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "codigo": "",
    "nombre": "Oferta verano",
    "inicio": "2015-08-10T11:40:33Z",
    "fin": "2015-08-11T12:05:27Z",
    "tipo": 1,
    "tarifa": 1,
    "activo": true,
    "articulo_oferta": [
        {
            "precio": 0.3,
            "descuento": 0.0,
            "articulo": 10
        }
    ],
    "observaciones": ""
  }'

Crea una nueva oferta en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/ofertas

Parámetros JSON

Parámetro Descripción
codigo Código identificativo de la oferta
*nombre Nombre de la oferta
*empresa Empresa de la oferta
*inicio Fecha de inicio de la oferta
*fin Fecha de fin de la oferta
*tipo Tipo de la oferta
*tarifa Tarifa de la oferta
*activo Indica si la oferta esta activa
*articulo_oferta Conjunto de artículos incluidos en la oferta

Obtiene una oferta existente

Ejemplo

curl "https://api.gotesagab.com/v1/ofertas/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una oferta existente.

Petición HTTP

GET https://api.gotesagab.com/v1/ofertas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la oferta

Actualiza una oferta existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/ofertas/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "nombre": "Oferta verano",    
    "articulo_oferta": []       
  }'

Actualiza los detalles de una oferta existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/ofertas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la oferta

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una oferta a excepción del array “articulo_oferta” que no es necesario.

Borra una oferta existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/ofertas/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una oferta existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/ofertas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la oferta

Artículos en oferta

Ejemplo

{
    "id": 23,
    "nombre_articulo": "Fanta Naranja",
    "nombre_familia": "Refrescos",
    "codigo_articulo": "",
    "precio": 0.3,
    "descuento": 0.0,
    "empresa": 2,
    "oferta": 4,
    "articulo": 10
}

Artículos en oferta.

Atributos

Atributo Descripción
id Identificador único del artículo-oferta
nombre_articulo Nombre del artículo
nombre_familia Nombre de la familia del artículo
codigo_articulo Código identificativo del artículo
precio Precio del artículo en la oferta
descuento Descuento del artículo en la oferta
empresa Empresa de la oferta
oferta Identificador de la oferta
articulo Identificador del artículo

Lista de los artículos-oferta

Ejemplo de petición

curl "https://api.gotesagab.com/v1/articulosoferta?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los artículos-oferta.

Petición HTTP

GET https://api.gotesagab.com/v1/articulosoferta?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa

Crear un nuevo artículo-oferta

Ejemplo

curl "https://api.gotesagab.com/v1/articulosoferta" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "precio": 0.3,
    "descuento": 0.0,
    "empresa": 2,
    "oferta": 4,
    "articulo": 10
  }'

Crea un nuevo artículo-oferta.

Petición HTTP

POST https://api.gotesagab.com/v1/articulosoferta

Parámetros JSON

Parámetro Descripción
*empresa Empresa del oferta
precio Precio del artículo en la oferta
descuento Descuento del artículo en la oferta
*oferta Identificador de la oferta
*articulo Identificador del artículo

Obtiene un artículo-oferta existente

Ejemplo

curl "https://api.gotesagab.com/v1/articulosoferta/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un artículo-oferta existente.

Petición HTTP

GET https://api.gotesagab.com/v1/articulosoferta/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo-oferta

Actualiza un artículo-oferta existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/articulosoferta/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "precio": 25.5    
  }'

Actualiza los detalles de un artículo-oferta existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/articulosoferta/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo-oferta

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un artículo-oferta.

Borra un artículo-oferta existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/articulosoferta/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un artículo-oferta existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/articulosoferta/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del artículo-oferta

Agentes

Agente

Ejemplo

{
    "id": 1,
    "nombre_rol": "gerencia",
    "nombre": "Alejandro",
    "email_usuario": "hola@hola.net",
    "es_usuario_activo": true,
    "email": "hola@hola.net",
    "nombre_empresa": "Demo Enterprises",
    "nombre_corto_empresa": "alejandro-empresa",
    "invitado_por": 1,
    "documentos_integrante": [
        {
            "id": 2,
            "nombre_serie": "Serie del año 2010",
            "codigo": "01",
            "nombre": "Pedidos alejandro",
            "observaciones": null,
            "documento": 1,
            "empresa": 2,
            "integrante": 1,
            "serie": 1
        },
        {
            "id": 3,
            "nombre_serie": "Serie del año 2010",
            "codigo": "02",
            "nombre": "Albaranes alejandro",
            "observaciones": null,
            "documento": 2,
            "empresa": 2,
            "integrante": 1,
            "serie": 1
        },
        {
            "id": 4,
            "nombre_serie": "Serie del año 2010",
            "codigo": "03",
            "nombre": "Facturas alejandro",
            "observaciones": null,
            "documento": 3,
            "empresa": 2,
            "integrante": 1,
            "serie": 1
        }
    ],    
    "rutas_agente": [
        {
            "id": 1,
            "nombre_ruta": "Centro cuenca",
            "empresa": 2,
            "integrante": 1,
            "ruta": 1
        }
    ],
    "es_propietario": true,
    "created_at": "2015-07-20T16:49:30+0000",
    "texto_extra_invitacion": "",
    "orden_usuario": 10000,
    "usuario": 1,
    "empresa": 2,
    "rol": 1,
    "almacen": 1
}

Son los integrantes de la empresa.

Atributos

Atributo Descripción
id Identificador único del agente
nombre_rol Nombre del rol del agente
nombre Nombre del del agente
email_usuario Email del usuario
es_usuario_activo Indica si el usuario esta activo en el sistema
email Email del agente en la empresa
nombre_empresa Nombre de la empresa del agente
nombre_corto_empresa Nombre corto de la empresa del agente
invitado_por Usuario que ha invitado al agente a la empresa
documentos_integrante Conjunto de documentos de configuración del agente
rutas_agente Conjunto de rutas asignadas al agente
es_propietario Indica si el agente es el propietario de la empresa
texto_extra_invitacion Texto de la invitación que le llegará al agente
orden_usuario Orden del agente
usuario Usuario que es agente de la empresa
empresa Empresa del agente
rol Rol del agente
almacen Almacén del agente

Lista de agentes

Ejemplo de petición

curl "https://api.gotesagab.com/v1/integrantes?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los agentes de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/integrantes?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
rol Filtra por rol
agente Filtra por agente

Invitar a un agente

Ejemplo

curl "https://api.gotesagab.com/v1/integrantes" \
  -H "Authorization: meowmeowmeow" \ 
  -H "Content-Type: application/json" -d \
  '{
    "es_propietario": false,
    "email": "hola@hola.com",
    "texto_extra_invitacion": "Hola, te invito a mi empresa",
    "orden_usuario": 10001,
    "empresa": 9,
    "rol": 1,
    "invitado_por": 1,
    "almacen": 1
  }'

Invitar a un usuario a la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/integrantes

Parámetros JSON

Parámetro Descripción
es_propietario Indica si el agente es el propietario de la empresa
email Email del usuario
texto_extra_invitacion Texto de la invitación que le llegará al agente
orden_usuario Orden del agente
*empresa Empresa del agente
*rol Rol del agente
almacen Almacén del agente
invitado_por Usuario que ha invitado al agente a la empresa

Obtiene un agente existente

Ejemplo

curl "https://api.gotesagab.com/v1/integrantes/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un agente existente.

Petición HTTP

GET https://api.gotesagab.com/v1/integrantes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del agente

Actualiza un agente existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/integrantes/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{   
    "almacen": 1
  }'

Actualiza los detalles de un agente existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/integrantes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del agente

Parámetros JSON

Estos parámetros son los mismos del recurso invitación de un agente.

Borra un agente existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/integrantes/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un agente existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/integrantes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del agente

Reenviar invitación

Reenvía la invitación al agente.

Petición HTTP

POST https://api.gotesagab.com/v1/integrantes/id/reenviar_invitacion

Parámetros de Consulta

Parámetro Descripción
id Identificador del agente

Documento configuración

Ejemplo

{
    "id": 1,
    "nombre_serie": "Serie del año 2010",
    "codigo": "01",
    "nombre": "Pedidos alejandro",
    "observaciones": null,
    "documento": 1,
    "empresa": 2,
    "integrante": 3,
    "serie": 1
}

Es la relación que se establece entre un agente y las series que debe utilizar para cada tipo de documento.

Atributos

Atributo Descripción
id Identificador único del documento configuración
nombre_serie Nombre de la serie del documento configuración
codigo Código identificativo del documento configuración
nombre Nombre del documento configuración
observaciones Observaciones sobre el documento configuración
documento Tipo de documento del documento configuración
empresa Empresa del documento configuración
integrante Agente del documento configuración
serie Serie del documento configuración

Lista de documentos configuración

Ejemplo de petición

curl "https://api.gotesagab.com/v1/documentosconfiguracion?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los documentos configuración de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/documentosconfiguracion?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
integrante Filtra por agente
serie Filtra por serie
documento Filtra por tipo de documento
agente Filtra por usuario

Crear un documento configuración

Ejemplo

curl "https://api.gotesagab.com/v1/documentosconfiguracion" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  {
    "codigo": "01",
    "nombre": "Pedidos alejandro",
    "observaciones": null,
    "documento": 1,
    "empresa": 2,
    "integrante": 3,
    "serie": 1
  }'

Crear un nuevo documento configuración para un agente.

Petición HTTP

POST https://api.gotesagab.com/v1/documentosconfiguracion

Parámetros JSON

Parámetro Descripción
codigo Código identificativo del documento configuración
*nombre Nombre del documento configuración
observaciones Observaciones sobre el documento configuración
*documento Tipo de documento del documento configuración
*empresa Empresa del documento configuración
*integrante Agente del documento configuración
*serie Serie del documento configuración

Obtiene un documento configuración existente

Ejemplo

curl "https://api.gotesagab.com/v1/documentosconfiguracion/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un documento configuración existente.

Petición HTTP

GET https://api.gotesagab.com/v1/documentosconfiguracion/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del documento configuración

Actualiza un documento configuración existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/documentosconfiguracion/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{   
    "serie": 2
  }'

Actualiza los detalles de un documento configuración existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/documentosconfiguracion/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del agente

Parámetros JSON

Estos parámetros son los mismos del recurso crear un documento configuración.

Borra un documento configuración existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/documentosconfiguracion/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un documento configuración existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/documentosconfiguracion/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del documento configuración

Ruta agente

Ejemplo

{
    "id": 1,
    "nombre_ruta": "Centro cuenca",
    "empresa": 2,
    "integrante": 1,
    "ruta": 1
}

Conjunto de rutas asignadas al agente.

Atributos

Atributo Descripción
id Identificador único de la ruta-agente
nombre Nombre de la ruta-agente
empresa Empresa de la ruta-agente
integrante Agente al que se le asigna la ruta
ruta Ruta que se le asigna al agente

Lista de rutas-agente

Ejemplo de petición

curl "https://api.gotesagab.com/v1/rutasagente?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las rutas-agente de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/rutasagente?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
integrante Filtra por agente
ruta Filtra por ruta
agente Filtra por usuario

Crear una ruta-agente

Ejemplo

curl "https://api.gotesagab.com/v1/rutasagente" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "integrante": 1,
    "ruta": 1
  }'

Crea una nueva ruta-agente en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/rutasagente

Parámetros JSON

Parámetro Descripción
empresa Empresa de la ruta-agente
integrante Agente al que se le asigna la ruta
ruta Ruta que se le asigna al agente

Obtiene una ruta-agente existente

Ejemplo

curl "https://api.gotesagab.com/v1/rutasagente/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una ruta-agente existente.

Petición HTTP

GET https://api.gotesagab.com/v1/rutasagente/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la ruta-agente

Actualiza una ruta-agente existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/rutasagente/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "ruta": 2   
  }'

Actualiza los detalles de una ruta-agente existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/rutasagente/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la familia

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una ruta-agente.

Borra una ruta-agente existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/rutasagente/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una ruta-agente existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/rutasagente/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la ruta-agente

Pedidos

Pedido

Ejemplo

{
    "id": 1,
    "empresa": 2,
    "usuario": 1,
    "nombre_usuario": "Alejandro",
    "serie": 1,
    "codigo_serie": "10",
    "numero": 1,
    "fecha": "2015-07-21T00:00:00Z",
    "cliente": 1,
    "nombre_cliente": "Alejandro",
    "ruta": 1,
    "nombre_ruta": "Centro cuenca",
    "total": 494.15,
    "estado_pedido": 0,
    "referencia": "",
    "almacen": 1,
    "nombre_almacen": "Almacén de cuenca",
    "tarifa": 1,
    "nombre_tarifa": "Normal",
    "forma_pago": 1,
    "nombre_forma_pago": "Contado",
    "iva_incluido": true,
    "regimen_iva": 16,
    "nombre_regimen_iva": "Régimen",
    "total_bruto": 475.06,
    "observaciones": "",
    "orden_ruta": 1,
    "marca": 0,
    "albaran_venta": null,
    "lineas_pedido_venta": [
        {
            "id": 30,
            "empresa": 2,
            "pedido_venta": 1,
            "linea": 1,
            "articulo": 1,
            "descripcion": "hola mundo",
            "cantidad": 2,
            "precio": 5.0,
            "descuento": 0.0,
            "importe_linea": 10.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null,
            "nombre_articulo": "ventana 50x50",
            "codigo_articulo": "01"
        },
        {
            "id": 31,
            "empresa": 2,
            "pedido_venta": 1,
            "linea": 2,
            "articulo": 4,
            "descripcion": "Cajas bonitas",
            "cantidad": 3,
            "precio": 35.0,
            "descuento": 5.0,
            "importe_linea": 99.75,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null,
            "nombre_articulo": "Cajas bonitas",
            "codigo_articulo": "03"
        },
        {
            "id": 32,
            "empresa": 2,
            "pedido_venta": 1,
            "linea": 3,
            "articulo": 10,
            "descripcion": "Fanta Naranja",
            "cantidad": 1,
            "precio": 0.4,
            "descuento": 0.0,
            "importe_linea": 0.4,
            "tipo_iva": 2,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null,
            "nombre_articulo": "Fanta Naranja",
            "codigo_articulo": "04"
        },
        {
            "id": 33,
            "empresa": 2,
            "pedido_venta": 1,
            "linea": 3,
            "articulo": 6,
            "descripcion": null,
            "cantidad": 1,
            "precio": 400.0,
            "descuento": 4.0,
            "importe_linea": 384.0,
            "tipo_iva": 59,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null,
            "nombre_articulo": "Ordenador",
            "codigo_articulo": "U-PC"
        }
    ],
    "bases_pedidos_venta": [
        {
            "id": 22,
            "empresa": 2,
            "pedido_venta": 1,
            "tipo_iva": 1,
            "base_imponible": 90.7,
            "importe_iva": 19.05,
            "importe_recargo": 0.0,
            "bruto": 90.702479338843
        },
        {
            "id": 23,
            "empresa": 2,
            "pedido_venta": 1,
            "tipo_iva": 2,
            "base_imponible": 0.36,
            "importe_iva": 0.04,
            "importe_recargo": 0.0,
            "bruto": 0.363636363636364
        },
        {
            "id": 24,
            "empresa": 2,
            "pedido_venta": 1,
            "tipo_iva": 59,
            "base_imponible": 384.0,
            "importe_iva": 0.0,
            "importe_recargo": 0.0,
            "bruto": 384.0
        }
    ]
}

Los pedidos de venta sirven para reservar la mercancía solicitada, por un cliente, en nuestro almacén.

Atributos

Atributo Descripción
id Identificador único del pedido
empresa Empresa del pedido
usuario Agente que ha realizado el pedido
nombre_usuario Nombre del agente que ha realizado el pedido
serie Serie del pedido
codigo_serie Código identificativo de la serie
numero Número de pedido
fecha Fecha del pedido
cliente Cliente que ha realizado el pedido
nombre_cliente Nombre del cliente que ha realizado el pedido
ruta Ruta del pedido
nombre_ruta Nombre de la ruta del pedido
total Total del pedido
estado_pedido Estado del pedido
referencia Referencia del pedido
almacen Almacén del pedido
tarifa Tarifa del pedido
nombre_tarifa Nombre de la tarifa del pedido
forma_pago Forma de pago del pedido
nombre_forma_pago Nombre de la forma de pago del pedido
iva_incluido Indica si el pedido incluye el IVA
regimen_iva Régimen de IVA del pedido
nombre_regimen_iva Nombre del régimen de IVA del pedido
total_bruto Total bruto del pedido
observaciones Observaciones sobre el pedido
orden_ruta Orden del cliente en la ruta del pedido
albaran_venta Albarán que se ha generado a partir del pedido
lineas_pedido_venta Conjunto de líneas del pedido
bases_pedidos_venta Conjunto de bases del pedido

Lista de pedidos

Ejemplo de petición

curl "https://api.gotesagab.com/v1/pedidos?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los pedidos de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/pedidos?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
cliente__nombre Filtra por el nombre del cliente
agente__nombre Filtra por el nombre del agente
ruta__nombre Filtra por el nombre de la ruta

Crear un pedido

Ejemplo

curl "https://api.gotesagab.com/v1/pedidos" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "usuario": 1,
    "serie": 1,
    "numero": 1,
    "fecha": "2015-07-21T00:00:00Z",
    "cliente": 1,
    "ruta": 1,
    "total": 494.15,
    "estado_pedido": 0,
    "referencia": "",
    "almacen": 1,
    "tarifa": 1,
    "forma_pago": 1,
    "iva_incluido": true,
    "regimen_iva": 16,
    "total_bruto": 475.06,
    "observaciones": "",
    "orden_ruta": 1,
    "marca": 0,
    "albaran_venta": null,
    "lineas_pedido_venta": [
        {
            "empresa": 2,
            "linea": 1,
            "articulo": 1,
            "descripcion": "hola mundo",
            "cantidad": 2,
            "precio": 5.0,
            "descuento": 0.0,
            "importe_linea": 10.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        },
        {
            "empresa": 2,
            "linea": 2,
            "articulo": 4,
            "descripcion": "Cajas bonitas",
            "cantidad": 3,
            "precio": 35.0,
            "descuento": 5.0,
            "importe_linea": 99.75,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        },
        {
            "empresa": 2,
            "linea": 3,
            "articulo": 10,
            "descripcion": "Fanta Naranja",
            "cantidad": 1,
            "precio": 0.4,
            "descuento": 0.0,
            "importe_linea": 0.4,
            "tipo_iva": 2,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        },
        {
            "empresa": 2,
            "linea": 3,
            "articulo": 6,
            "descripcion": null,
            "cantidad": 1,
            "precio": 400.0,
            "descuento": 4.0,
            "importe_linea": 384.0,
            "tipo_iva": 59,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        }
    ],
    "bases_pedidos_venta": [
        {
            "empresa": 2,
            "tipo_iva": 1,
            "base_imponible": 90.7,
            "importe_iva": 19.05,
            "importe_recargo": 0.0,
            "bruto": 90.702479338843
        },
        {
            "empresa": 2,
            "tipo_iva": 2,
            "base_imponible": 0.36,
            "importe_iva": 0.04,
            "importe_recargo": 0.0,
            "bruto": 0.363636363636364
        },
        {
            "empresa": 2,
            "tipo_iva": 59,
            "base_imponible": 384.0,
            "importe_iva": 0.0,
            "importe_recargo": 0.0,
            "bruto": 384.0
        }
    ]
  }'

Crea un nuevo pedido en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/pedidos

Parámetros JSON

Parámetro Descripción
*empresa Empresa del pedido
*usuario Agente que ha realizado el pedido
*serie Serie del pedido
numero Número de pedido
*fecha Fecha del pedido
*cliente Cliente que ha realizado el pedido
ruta Ruta del pedido
total Total del pedido
estado_pedido Estado del pedido
referencia Referencia del pedido
almacen Almacén del pedido
tarifa Tarifa del pedido
forma_pago Forma de pago del pedido
iva_incluido Indica si el pedido incluye el IVA
*regimen_iva Régimen de IVA del pedido
total_bruto Total bruto del pedido
observaciones Observaciones sobre el pedido
orden_ruta Orden del cliente en la ruta del pedido
albaran_venta Albarán que se ha generado a partir del pedido
*lineas_pedido_venta Conjunto de líneas del pedido
*bases_pedidos_venta Conjunto de bases del pedido

Obtiene un pedido existente

Ejemplo

curl "https://api.gotesagab.com/v1/pedidos/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un pedido existente.

Petición HTTP

GET https://api.gotesagab.com/v1/pedidos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del pedido

Actualiza un pedido existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/pedidos/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{   
    "total": 494.15,    
    "lineas_pedido_venta": [
        {
            "empresa": 2,
            "linea": 1,
            "articulo": 1,
            "descripcion": "hola mundo",
            "cantidad": 2,
            "precio": 5.0,
            "descuento": 0.0,
            "importe_linea": 10.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        },
        {
            "empresa": 2,
            "linea": 2,
            "articulo": 4,
            "descripcion": "Cajas bonitas",
            "cantidad": 3,
            "precio": 35.0,
            "descuento": 5.0,
            "importe_linea": 99.75,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        },
        {
            "empresa": 2,
            "linea": 3,
            "articulo": 10,
            "descripcion": "Fanta Naranja",
            "cantidad": 1,
            "precio": 0.4,
            "descuento": 0.0,
            "importe_linea": 0.4,
            "tipo_iva": 2,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        },
        {
            "empresa": 2,
            "linea": 3,
            "articulo": 6,
            "descripcion": null,
            "cantidad": 1,
            "precio": 400.0,
            "descuento": 4.0,
            "importe_linea": 384.0,
            "tipo_iva": 59,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        }
    ],
    "bases_pedidos_venta": [
        {
            "empresa": 2,
            "tipo_iva": 1,
            "base_imponible": 90.7,
            "importe_iva": 19.05,
            "importe_recargo": 0.0,
            "bruto": 90.702479338843
        },
        {
            "empresa": 2,
            "tipo_iva": 2,
            "base_imponible": 0.36,
            "importe_iva": 0.04,
            "importe_recargo": 0.0,
            "bruto": 0.363636363636364
        },
        {
            "empresa": 2,
            "tipo_iva": 59,
            "base_imponible": 384.0,
            "importe_iva": 0.0,
            "importe_recargo": 0.0,
            "bruto": 384.0
        }
    ]
  }'

Actualiza los detalles de un pedido existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/pedidos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del pedido

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un pedido.

Borra un pedido existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/pedidos/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un pedido existente. También se eliminan todas sus líneas y bases.

Petición HTTP

DELETE https://api.gotesagab.com/v1/pedidos/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del pedido

Traspasar un pedido a albarán

Ejemplo

curl "https://api.gotesagab.com/v1/pedidos/2/traspasar" \
  -H "Authorization: meowmeowmeow"

Traspasa un pedido a albarán. El recurso devuelve el albarán que se genera.

Petición HTTP

GET https://api.gotesagab.com/v1/pedidos/id/traspasar

Parámetros de Consulta

Parámetro Descripción
id Identificador del pedido

Línea de un pedido

Ejemplo

{    
    "id": 30,
    "empresa": 2,
    "pedido_venta": 1,
    "linea": 1,
    "articulo": 1,
    "descripcion": "hola mundo",
    "cantidad": 2,
    "precio": 5.0,
    "descuento": 0.0,
    "importe_linea": 10.0,
    "tipo_iva": 1,
    "precio_medio_costo": 0.0,
    "marca": 0,
    "notas": null,
    "nombre_articulo": "ventana 50x50",
    "codigo_articulo": "01"
}

Atributos

Atributo Descripción
id Identificador único de la línea
empresa Empresa de la línea
pedido_venta Identificador del pedido
linea Número de línea
articulo Artículo de la línea
descripcion Descripción de la línea
cantidad Cantidad de artículos
precio Precio del artículo
descuento Descuento de la línea
importe_linea Importe de la línea
tipo_iva Tipo de IVA de la línea
precio_medio_costo Precio medio de costo de la línea
notas Notas de la línea
nombre_articulo Nombre del artículo de la línea
codigo_articulo Código del artículo de la línea

Crear o actualizar una línea de un pedido existente

Atributos

Atributo Descripción
*empresa Empresa de la línea
linea Número de línea
*articulo Artículo de la línea
descripcion Descripción de la línea
*cantidad Cantidad de artículos
precio Precio del artículo
descuento Descuento de la línea
importe_linea Importe de la línea
*tipo_iva Tipo de IVA de la línea
precio_medio_costo Precio medio de costo de la línea
notas Notas de la línea

Base de un pedido

Ejemplo

{
    "id": 24,
    "empresa": 2,
    "pedido_venta": 1,
    "tipo_iva": 59,
    "base_imponible": 384.0,
    "importe_iva": 0.0,
    "importe_recargo": 0.0,
    "bruto": 384.0
}

Atributos

Atributo Descripción
id Identificador único de la base
empresa Empresa de la base
pedido_venta Identificador del pedido
tipo_iva Tipo de IVA de la base
base_imponible Base imponible de la base
importe_iva Importe de IVA de la base
importe_recargo Importe de recargo de la base
bruto Total bruto de la base

Crear o actualizar una base de un pedido existente

Atributos

Atributo Descripción
*empresa Empresa de la base
*tipo_iva Tipo de IVA de la base
base_imponible Base imponible de la base
importe_iva Importe de IVA de la base
importe_recargo Importe de recargo de la base
bruto Total bruto de la base

Albaranes

Albarán

Ejemplo

{
    "id": 1,
    "empresa": 2,
    "usuario": 1,
    "nombre_usuario": "Alejandro",
    "serie": 1,
    "codigo_serie": "10",
    "numero": 1,
    "fecha": "2015-07-21T00:00:00Z",
    "cliente": 1,
    "nombre_cliente": "Alejandro",
    "ruta": 1,
    "nombre_ruta": "Centro cuenca",
    "total": 15.64,
    "estado_albaran": 2,
    "cobrado": 0.0,
    "almacen": 1,    
    "tarifa": 1,
    "nombre_tarifa": "Normal",
    "forma_pago": 1,
    "nombre_forma_pago": "Contado",
    "iva_incluido": true,
    "regimen_iva": 17,
    "nombre_regimen_iva": "Régimen 2",
    "observaciones": "",
    "factura_venta": 15,
    "orden_ruta": 1,
    "marca": 0,
    "total_bruto": 12.4,
    "pedidos_venta_albaran": [],
    "lineas_albaran_venta": [
        {
            "id": 49,
            "empresa": 2,
            "albaran_venta": 1,
            "linea": 1,
            "articulo": 1,
            "descripcion": null,
            "cantidad": 1,
            "precio": 12.0,
            "descuento": 10.0,
            "importe_linea": 15.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null,
            "nombre_articulo": "ventana 50x50",
            "codigo_articulo": "01"
        }
    ],
    "bases_albaranes_venta": [
        {
            "id": 31,
            "empresa": 2,
            "albaran_venta": 1,
            "tipo_iva": 1,
            "base_imponible": 12.4,
            "importe_iva": 2.6,
            "importe_recargo": 0.64,
            "bruto": 12.396694214876
        }
    ]
}

Los albaranes de venta son el documento que enviamos a nuestros clientes con la mercancía, es el justificante de la entrega de la misma y el documento a partir del cual se generan las facturas.

Atributos

Atributo Descripción
id Identificador único del albarán
empresa Empresa del albarán
usuario Agente que ha realizado el albarán
nombre_usuario Nombre del agente que ha realizado el albarán
serie Serie del albarán
codigo_serie Código identificativo de la serie
numero Número de albarán
fecha Fecha del albarán
cliente Cliente del albarán
nombre_cliente Nombre del cliente del albarán
ruta Ruta del albarán
nombre_ruta Nombre de la ruta del albarán
total Total del albarán
estado_albaran Estado del albarán
cobrado Importe cobrado del albarán
almacen Almacén del albarán
tarifa Tarifa del albarán
nombre_tarifa Nombre de la tarifa del albarán
forma_pago Forma de pago del albarán
nombre_forma_pago Nombre de la forma de pago del albarán
iva_incluido Indica si el albarán incluye el IVA
regimen_iva Régimen de IVA del albarán
nombre_regimen_iva Nombre del régimen de IVA del albarán
total_bruto Total bruto del albarán
observaciones Observaciones sobre el albarán
orden_ruta Orden del cliente en la ruta del albarán
factura_venta Factura que se ha generado a partir del albarán
pedidos_venta_albaran Conjunto de pedidos asociados al albarán
lineas_albaran_venta Conjunto de líneas del albarán
bases_albaranes_venta Conjunto de bases del albarán

Lista de albaranes

Ejemplo de petición

curl "https://api.gotesagab.com/v1/albaranes?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los albaranes de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/albaranes?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
cliente__nombre Filtra por el nombre del cliente
agente__nombre Filtra por el nombre del agente
ruta__nombre Filtra por el nombre de la ruta

Crear un albarán

Ejemplo

curl "https://api.gotesagab.com/v1/albaranes" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "usuario": 1,
    "serie": 1,
    "numero": 1,
    "fecha": "2015-07-21T00:00:00Z",
    "cliente": 1,
    "ruta": 1,
    "total": 15.64,
    "estado_albaran": 2,
    "almacen": 1,
    "tarifa": 1,
    "forma_pago": 1,
    "iva_incluido": true,
    "regimen_iva": 17,
    "observaciones": "",
    "factura_venta": 15,
    "orden_ruta": 1,
    "marca": 0,
    "total_bruto": 12.4,
    "lineas_albaran_venta": [
        {
            "empresa": 2,
            "linea": 1,
            "articulo": 1,
            "descripcion": null,
            "cantidad": 1,
            "precio": 12.0,
            "descuento": 10.0,
            "importe_linea": 15.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        }
    ],
    "bases_albaranes_venta": [
        {
            "id": 31,
            "empresa": 2,
            "tipo_iva": 1,
            "base_imponible": 12.4,
            "importe_iva": 2.6,
            "importe_recargo": 0.64,
            "bruto": 12.396694214876
        }
    ]
  }'

Crea un nuevo albarán en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/albaranes

Parámetros JSON

Parámetro Descripción
*empresa Empresa del albarán
*usuario Agente que ha realizado el albarán
*serie Serie del albarán
numero Número de albarán
*fecha Fecha del albarán
*cliente Cliente del albarán
ruta Ruta del albarán
total Total del albarán
estado_albaran Estado del albarán
almacen Almacén del albarán
tarifa Tarifa del albarán
forma_pago Forma de pago del albarán
iva_incluido Indica si el albarán incluye el IVA
*regimen_iva Régimen de IVA del albarán
total_bruto Total bruto del albarán
observaciones Observaciones sobre el albarán
orden_ruta Orden del cliente en la ruta del albarán
factura_venta Factura que se ha generado a partir del albarán
*lineas_albaran_venta Conjunto de líneas del albarán
*bases_albaranes_venta Conjunto de bases del albarán

Obtiene un albarán existente

Ejemplo

curl "https://api.gotesagab.com/v1/albaranes/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un albarán existente.

Petición HTTP

GET https://api.gotesagab.com/v1/albaranes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del albarán

Actualiza un albarán existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/albaranes/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "total": 15.64,   
    "lineas_albaran_venta": [
        {
            "empresa": 2,
            "linea": 1,
            "articulo": 1,
            "descripcion": null,
            "cantidad": 1,
            "precio": 12.0,
            "descuento": 10.0,
            "importe_linea": 15.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        }
    ],
    "bases_albaranes_venta": [
        {
            "empresa": 2,
            "tipo_iva": 1,
            "base_imponible": 12.4,
            "importe_iva": 2.6,
            "importe_recargo": 0.64,
            "bruto": 12.396694214876
        }
    ]
  }'

Actualiza los detalles de un albarán existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/albaranes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del albarán

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un albarán.

Borra un albarán existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/albaranes/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un albarán existente. También se eliminan todas sus líneas y bases.

Petición HTTP

DELETE https://api.gotesagab.com/v1/albaranes/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del albarán

Traspasar un albarán a factura

Ejemplo

curl "https://api.gotesagab.com/v1/albaranes/2/traspasar" \
  -H "Authorization: meowmeowmeow"

Traspasa un albarán a factura. El recurso devuelve la factura que se genera.

Petición HTTP

GET https://api.gotesagab.com/v1/albaranes/id/traspasar

Parámetros de Consulta

Parámetro Descripción
id Identificador del albarán

Línea de un albarán

Ejemplo

{    
    "id": 30,
    "empresa": 2,
    "pedido_venta": 1,
    "linea": 1,
    "articulo": 1,
    "descripcion": "hola mundo",
    "cantidad": 2,
    "precio": 5.0,
    "descuento": 0.0,
    "importe_linea": 10.0,
    "tipo_iva": 1,
    "precio_medio_costo": 0.0,
    "marca": 0,
    "notas": null,
    "nombre_articulo": "ventana 50x50",
    "codigo_articulo": "01"
}

Atributos

Atributo Descripción
id Identificador único de la línea
empresa Empresa de la línea
albaran_venta Identificador del albarán
linea Número de línea
articulo Artículo de la línea
descripcion Descripción de la línea
cantidad Cantidad de artículos
precio Precio del artículo
descuento Descuento de la línea
importe_linea Importe de la línea
tipo_iva Tipo de IVA de la línea
precio_medio_costo Precio medio de costo de la línea
notas Notas de la línea
nombre_articulo Nombre del artículo de la línea
codigo_articulo Código del artículo de la línea

Crear o actualizar una línea de un albarán existente

Atributos

Atributo Descripción
*empresa Empresa de la línea
linea Número de línea
*articulo Artículo de la línea
descripcion Descripción de la línea
*cantidad Cantidad de artículos
precio Precio del artículo
descuento Descuento de la línea
importe_linea Importe de la línea
*tipo_iva Tipo de IVA de la línea
precio_medio_costo Precio medio de costo de la línea
notas Notas de la línea

Base de un albarán

Ejemplo

{
    "id": 24,
    "empresa": 2,
    "pedido_venta": 1,
    "tipo_iva": 59,
    "base_imponible": 384.0,
    "importe_iva": 0.0,
    "importe_recargo": 0.0,
    "bruto": 384.0
}

Atributos

Atributo Descripción
id Identificador único de la base
empresa Empresa de la base
albaran_venta Identificador del albarán
tipo_iva Tipo de IVA de la base
base_imponible Base imponible de la base
importe_iva Importe de IVA de la base
importe_recargo Importe de recargo de la base
bruto Total bruto de la base

Crear o actualizar una base de un albarán existente

Atributos

Atributo Descripción
*empresa Empresa de la base
*tipo_iva Tipo de IVA de la base
base_imponible Base imponible de la base
importe_iva Importe de IVA de la base
importe_recargo Importe de recargo de la base
bruto Total bruto de la base

Facturas

Factura

Ejemplo

{
    "id": 15,
    "empresa": 2,
    "usuario": 1,
    "nombre_usuario": "Alejandro",
    "serie": 1,
    "codigo_serie": "10",
    "numero": 2,
    "fecha": "2015-08-06T07:47:25.028985Z",
    "cliente": 1,
    "nombre_cliente": "Alejandro",
    "total": 15.64,
    "estado_factura": 1,
    "cobrado": 15.64,
    "almacen": 1,
    "referencia": "",
    "bruto": 12.4,
    "dtopp": 0.0,
    "importe_dtopp": 0.0,
    "importe_retencion": 0.0,
    "forma_pago": 1,
    "nombre_forma_pago": "Contado",
    "regimen_iva": 17,
    "nombre_regimen_iva": "Régimen",
    "tarifa": 1,
    "nombre_tarifa": "Normal",
    "observaciones": "",
    "porcentaje_irpf": 0.0,
    "marca": 0,
    "base_retencion": 0.0,
    "domicilio_cobro": 1,
    "albaranes_venta_facturas": [
        {
            "id": 52
        }
    ],
    "lineas_factura_venta": [
        {
            "id": 12,
            "empresa": 2,
            "factura_venta": 15,
            "linea": 1,
            "articulo": 1,
            "descripcion": null,
            "cantidad": 1,
            "precio": 12.0,
            "descuento": 10.0,
            "importe_linea": 15.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null,
            "nombre_articulo": "ventana 50x50",
            "codigo_articulo": "01"
        }
    ],
    "bases_factura_venta": [
        {
            "id": 7,
            "empresa": 2,
            "factura_venta": 15,
            "tipo_iva": 1,
            "base_imponible": 12.4,
            "importe_iva": 2.6,
            "importe_recargo": 0.64,
            "bruto": 12.396694214876
        }
    ]
}

La factura de venta es el documento que presentamos a nuestros clientes como justificante de la venta.

Atributos

Atributo Descripción
id Identificador único de la factura
empresa Empresa de la factura
usuario Agente que ha realizado la factura
nombre_usuario Nombre del agente que ha realizado la factura
serie Serie de la factura
codigo_serie Código identificativo de la serie
numero Número de la factura
fecha Fecha de la factura
cliente Cliente de la factura
nombre_cliente Nombre del cliente de la factura
total Total de la factura
estado_factura Estado de la factura
cobrado Importe cobrado de la factura
referencia Referencia de la factura
bruto Total bruto de la factura
dtopp Descuento pronto pago de la factura
importe_dtopp Importe del descuento pronto pago de la factura
importe_retencion Importe retención de la factura
almacen Almacén de la factura
tarifa Tarifa de la factura
nombre_tarifa Nombre de la tarifa de la factura
forma_pago Forma de pago de la factura
nombre_forma_pago Nombre de la forma de pago de la factura
regimen_iva Régimen de IVA de la factura
nombre_regimen_iva Nombre del régimen de IVA de la factura
observaciones Observaciones sobre la factura
porcentaje_irpf Porcentaje de IRPF de la factura
base_retencion Base retención de la factura
domicilio_cobro Domicilio de cobro de la factura
albaranes_venta_facturas Conjunto de albaranes asociados a la factura
lineas_factura_venta Conjunto de líneas de la factura
bases_factura_venta Conjunto de bases de la factura

Lista de facturas

Ejemplo de petición

curl "https://api.gotesagab.com/v1/facturas?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las facturas de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/facturas?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
cliente__nombre Filtra por el nombre del cliente
agente__nombre Filtra por el nombre del agente
ruta__nombre Filtra por el nombre de la ruta

Crear una factura

Ejemplo

curl "https://api.gotesagab.com/v1/facturas" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "usuario": 1,
    "serie": 1,
    "numero": 2,
    "fecha": "2015-08-06T07:47:25.028985Z",
    "cliente": 1,
    "total": 15.64,
    "estado_factura": 1,
    "almacen": 1,
    "referencia": "",
    "bruto": 12.4,
    "dtopp": 0.0,
    "importe_dtopp": 0.0,
    "importe_retencion": 0.0,
    "forma_pago": 1,
    "regimen_iva": 17,
    "tarifa": 1,
    "observaciones": "",
    "porcentaje_irpf": 0.0,
    "marca": 0,
    "base_retencion": 0.0,
    "domicilio_cobro": 1,   
    "lineas_factura_venta": [
        {
            "empresa": 2,
            "linea": 1,
            "articulo": 1,
            "descripcion": null,
            "cantidad": 1,
            "precio": 12.0,
            "descuento": 10.0,
            "importe_linea": 15.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        }
    ],
    "bases_factura_venta": [
        {
            "empresa": 2,
            "tipo_iva": 1,
            "base_imponible": 12.4,
            "importe_iva": 2.6,
            "importe_recargo": 0.64,
            "bruto": 12.39
        }
    ]
  }'

Crea una factura nueva en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/facturas

Parámetros JSON

Parámetro Descripción
*empresa Empresa de la factura
*usuario Agente que ha realizado la factura
*serie Serie de la factura
numero Número de pedido
*fecha Fecha de la factura
bruto Total bruto de la factura
dtopp Descuento pronto pago de la factura
importe_dtopp Importe del descuento pronto pago de la factura
importe_retencion Importe retención de la factura
*cliente Cliente de la factura
total Total de la factura
estado_factura Estado de la factura
referencia Referencia de la factura
almacen Almacén de la factura
tarifa Tarifa de la factura
forma_pago Forma de pago de la factura
*regimen_iva Régimen de IVA de la factura
bruto Total bruto de la factura
observaciones Observaciones sobre la factura
*lineas_factura_venta Conjunto de líneas de la factura
*bases_factura_venta Conjunto de bases de la factura

Obtiene una factura existente

Ejemplo

curl "https://api.gotesagab.com/v1/facturas/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una factura existente.

Petición HTTP

GET https://api.gotesagab.com/v1/facturas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la factura

Actualiza una factura existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/facturas/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{   
    "domicilio_cobro": 1,   
    "lineas_factura_venta": [
        {
            "empresa": 2,
            "linea": 1,
            "articulo": 1,
            "descripcion": null,
            "cantidad": 1,
            "precio": 12.0,
            "descuento": 10.0,
            "importe_linea": 15.0,
            "tipo_iva": 1,
            "precio_medio_costo": 0.0,
            "marca": 0,
            "notas": null
        }
    ],
    "bases_factura_venta": [
        {
            "empresa": 2,
            "tipo_iva": 1,
            "base_imponible": 12.4,
            "importe_iva": 2.6,
            "importe_recargo": 0.64,
            "bruto": 12.396694214876
        }
    ]
  }'

Actualiza los detalles de una factura existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/facturas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la factura

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una factura.

Borra una factura existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/facturas/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una factura existente. También se eliminan todas sus líneas y bases.

Petición HTTP

DELETE https://api.gotesagab.com/v1/facturas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la factura

Línea de una factura

Ejemplo

{    
    "id": 30,
    "empresa": 2,
    "factura_venta": 1,
    "linea": 1,
    "articulo": 1,
    "descripcion": "hola mundo",
    "cantidad": 2,
    "precio": 5.0,
    "descuento": 0.0,
    "importe_linea": 10.0,
    "tipo_iva": 1,
    "precio_medio_costo": 0.0,
    "marca": 0,
    "notas": null,
    "nombre_articulo": "ventana 50x50",
    "codigo_articulo": "01"
}

Atributos

Atributo Descripción
id Identificador único de la línea
empresa Empresa de la línea
factura_venta Identificador de la factura
linea Número de línea
articulo Artículo de la línea
descripcion Descripción de la línea
cantidad Cantidad de artículos
precio Precio del artículo
descuento Descuento de la línea
importe_linea Importe de la línea
tipo_iva Tipo de IVA de la línea
precio_medio_costo Precio medio de costo de la línea
notas Notas de la línea
nombre_articulo Nombre del artículo de la línea
codigo_articulo Código del artículo de la línea

Crear o actualizar una línea de una factura existente

Atributos

Atributo Descripción
*empresa Empresa de la línea
linea Número de línea
*articulo Artículo de la línea
descripcion Descripción de la línea
*cantidad Cantidad de artículos
precio Precio del artículo
descuento Descuento de la línea
importe_linea Importe de la línea
*tipo_iva Tipo de IVA de la línea
precio_medio_costo Precio medio de costo de la línea
notas Notas de la línea

Base de una factura

Ejemplo

{
    "id": 24,
    "empresa": 2,
    "factura_venta": 1,
    "tipo_iva": 59,
    "base_imponible": 384.0,
    "importe_iva": 0.0,
    "importe_recargo": 0.0,
    "bruto": 384.0
}

Atributos

Atributo Descripción
id Identificador único de la base
empresa Empresa de la base
factura_venta Identificador de la factura
tipo_iva Tipo de IVA de la base
base_imponible Base imponible de la base
importe_iva Importe de IVA de la base
importe_recargo Importe de recargo de la base
bruto Total bruto de la base

Crear o actualizar una base de una factura existente

Atributos

Atributo Descripción
*empresa Empresa de la base
*tipo_iva Tipo de IVA de la base
base_imponible Base imponible de la base
importe_iva Importe de IVA de la base
importe_recargo Importe de recargo de la base
bruto Total bruto de la base

Cobros

cobro

Ejemplo

{
    "id": 19,
    "empresa": 2,
    "fecha": "2015-08-06T11:45:19.529000Z",
    "nombre_cliente": "Alejandro",
    "usuario": 1,
    "nombre_usuario": "Pedro",
    "tipo": 1,
    "importe": 4.78,
    "banco": "bankia",
    "numero_talon": "45685445",
    "fecha_vencimiento": null,
    "talon_nominativo": true,
    "parada": 1,
    "deudas_cobro": [
        {
            "descripcion": "Albarán - 10/11",
            "id": 86,
            "cobrado": 4.34
        },
        {
            "descripcion": "Albarán - J15/11",
            "id": 85,
            "cobrado": 0.44
        }
    ]
}

Movimiento que registra que se ha cobrado alguna deuda.

Atributos

Atributo Descripción
id Identificador único del cobro
empresa Empresa del cobro
fecha Fecha en la que se ha realizado el cobro
nombre_cliente Nombre del cliente del cobro
usuario Agente que ha realizado el cobro
nombre_usuario Nombre del agente que ha realizado el cobro
tipo Tipo de cobro
importe Importe cobrado
banco Banco del cobro
numero_talon Número de talón del cobro
fecha_vencimiento Fecha de vencimiento del talón
talon_nominativo Indica si el talón es nominativo
parada Parada en la que se ha realizado el cobro
deudas_cobro Conjunto de deudas que se han cobrado

Lista de cobros

Ejemplo de petición

curl "https://api.gotesagab.com/v1/cobros?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los cobros de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/cobros?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
agente Filtra por el nombre del agente

Crear un cobro

Ejemplo

curl "https://api.gotesagab.com/v1/cobros" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "fecha": "2015-08-06T11:45:19.529000Z",
    "usuario": 1,
    "tipo": 1,
    "banco": "bankia",
    "numero_talon": "45685445",
    "fecha_vencimiento": null,
    "talon_nominativo": true,
    "parada": 1    
  }'

Crea un nuevo cobro en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/cobros

Parámetros JSON

Parámetro Descripción
*empresa Empresa del cobro
*fecha Fecha en la que se ha realizado el cobro
*usuario Agente que ha realizado el cobro
*tipo Tipo de cobro
banco Banco del cobro
numero_talon Número de talón del cobro
fecha_vencimiento Fecha de vencimiento del talón
talon_nominativo Indica si el talón es nominativo
parada Parada en la que se ha realizado el cobro

Obtiene un cobro existente

Ejemplo

curl "https://api.gotesagab.com/v1/cobros/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un cobro existente.

Petición HTTP

GET https://api.gotesagab.com/v1/cobros/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cobro

Actualiza un cobro existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/cobros/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{   
    "parada": 1
  }'

Actualiza los detalles de un cobro existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/cobros/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cobro

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un cobro.

Borra un cobro existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/cobros/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un cobro existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/cobros/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del cobro

Deuda

Ejemplo

{
    "descripcion": "Albarán - J15/12",
    "id": 88,
    "empresa": 2,
    "fecha_documento": "2015-08-10T07:22:22Z",
    "cliente": 13,
    "nombre_cliente": "Pablo",
    "usuario": 1,
    "nombre_usuario": "Alejandro",
    "total_documento": 0.45,
    "total_pendiente": 0.45,
    "numero_documento": "J15/10",
    "tipo_documento": 2,
    "factura": null,
    "albaran": 71,
    "cobrado_previamente": 0.0,
    "cobrado": 0.0,
    "cobro": null
}

Importe pendiente de pago por el cliente.

Atributos

Atributo Descripción
descripcion Texto que describe la deuda
id Identificador único de la deuda
empresa Empresa de la deuda
fecha_documento Fecha del documento asociado a la deuda
cliente Cliente que debe abonar la deuda
nombre_cliente Nombre del cliente que debe abonar la deuda
usuario Agente que ha creado el documento de la deuda
nombre_usuario Nombre del agente que ha creado el documento de la deuda
total_documento Total del documento de la deuda
total_pendiente Total pendiente de pago por el cliente
numero_documento Serie/Número del documento de la deuda
tipo_documento Tipo de documento de la deuda
factura Factura asociada a la deuda
albaran Albarán asociado a la deuda
cobrado_previamente Importe cobrado en una deuda anterior
cobrado Importe cobrado en esta deuda
cobro Cobro al que se asocia la deuda

Lista de deudas

Ejemplo de petición

curl "https://api.gotesagab.com/v1/deudas?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos las deudas pendientes de pago de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/deudas?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
agente Filtra por el nombre del agente
cliente__nombre Filtra por el nombre del cliente
factura Filtra por factura
albaran Filtra por albarán

Crear una deuda

Ejemplo

curl "https://api.gotesagab.com/v1/deudas" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "fecha_documento": "2015-08-10T07:22:22Z",
    "cliente": 13,
    "usuario": 1,  
    "total_documento": 0.45,
    "numero_documento": "J15/10",
    "tipo_documento": 2,
    "factura": null,
    "albaran": 71,
    "cobrado_previamente": 0.0,
    "cobrado": 0.0,
    "cobro": null
  }'

Crea una deuda en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/deudas

Parámetros JSON

Parámetro Descripción
*empresa Empresa de la deuda
*fecha_documento Fecha del documento asociado a la deuda
*cliente Cliente que debe abonar la deuda
*usuario Agente que ha creado el documento de la deuda
*total_documento Total del documento de la deuda
*numero_documento Serie/Número del docuemnto de la deuda
tipo_documento Tipo de documento de la deuda
factura Factura asociada a la deuda
albaran Albarán asociado a la deuda
*cobrado_previamente Importe cobrado en una deuda anterior
cobrado Importe cobrado en esta deuda
cobro Cobro al que se asocia la deuda

Obtiene una deuda existente

Ejemplo

curl "https://api.gotesagab.com/v1/deudas/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una deuda existente.

Petición HTTP

GET https://api.gotesagab.com/v1/deudas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la deuda

Actualiza una deuda existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/deudas/2"\
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{   
    "cobrado_previamente": 0.0,
    "cobrado": 10,
    "cobro": 1
  }'

Actualiza los detalles de una deuda existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/deudas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la deuda

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una deuda.

Borra una deuda existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/deudas/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una deuda existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/deudas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la deuda

Cobrar deudas

Ejemplo

curl "https://api.gotesagab.com/v1/deudas/cobrar" \
  -H "Authorization: meowmeowmeow" \  
  -H "Content-Type: application/json" -d \
  '{
    "empresa": 2,
    "usuario": 1,
    "tipo": 1,
    "banco": "",
    "numero_talon": "",
    "fecha_vencimiento": null,
    "talon_nominativo": false,
    "parada": null,
    "deudas_cobro": [
        {
            "id":41,
            "cobrado": 10.5
        }       
    ]
  }'

Cobrar un conjunto de deudas.

Petición HTTP

POST https://api.gotesagab.com/v1/deudas/cobrar

Parámetros JSON

Parámetro Descripción
*empresa Empresa del cobro
*fecha Fecha en la que se ha realizado el cobro
*usuario Agente que ha realizado el cobro
*tipo Tipo de cobro
banco Banco del cobro
numero_talon Número de talón del cobro
fecha_vencimiento Fecha de vencimiento del talón
talon_nominativo Indica si el talón es nominativo
parada Parada en la que se ha realizado el cobro
*deudas_cobro Conjunto de deudas que serán cobradas
*deudas_cobro (id) Identificador de la deuda a cobrar
*deudas_cobro (cobrado) Importe cobrado de la deuda

Total pendiente de pago

Ejemplo

curl "https://api.gotesagab.com/v1/deudas/total?empresa=1" \
  -H "Authorization: meowmeowmeow"

Obtiene el total pendiente de pago de una empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/deudas/total?empresa=empresa

Parámetros de Consulta

Parámetro Descripción
*empresa Filtra por empresa

Notificaciones

Notificación

Ejemplo

{
    "id": 1,
    "total_notificaciones": 0,
    "ultimos_registros": [
        {
            "url": "...",
            "estado": 200,
            "duracion": 0.41752,
            "fecha_alta": "2015-08-22T09:13:31+0000",
            "id": 12
        }
    ],
    "codigo": "01",
    "nombre": "Notificación",
    "observaciones": "",
    "url": "...",
    "clave": "123456",
    "fecha_ultima_ejecucion": null,
    "activa": true,
    "notificar_clientes": true,
    "notificar_articulos": true,
    "notificar_pedidos": true,
    "notificar_albaranes": true,
    "notificar_facturas": false,
    "empresa": 2
}

Sistema que envía notificaciones a recursos de terceros cuando se producen cambios en los datos.

Atributos

Atributo Descripción
id Identificador único de la notificación
total_notificaciones Total de notificacines enviadas
ultimos_registros Últimas notificacines enviadas
codigo Código identificativo de la notificación
nombre Nombre de la notificación
observaciones Observaciones sobre la notificación
url URL a la que se enviará la notificación
clave Clave para autenticarse en la aplicación de terceros
fecha_ultima_ejecucion Fecha de la última notificación
activa Indica si la notificación esta activa
notificar_clientes Indica si se debe notificar cambios en clientes
notificar_articulos Indica si se debe notificar cambios en artículos
notificar_pedidos Indica si se debe notificar cambios en pedidos
notificar_albaranes Indica si se debe notificar cambios en albaranes
notificar_facturas Indica si se debe notificar cambios en facturas
empresa Empresa de la notificación

Lista de notificaciones

Ejemplo de petición

curl "https://api.gotesagab.com/v1/notificaciones?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las notificaciones de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/notificaciones?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código de la notificación
nombre Filtra por el nombre de la notificación

Crear una notificación

Ejemplo

curl "https://api.gotesagab.com/v1/notificaciones" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{    
    "codigo": "01",
    "nombre": "Notificación",
    "observaciones": "",
    "url": "...",
    "clave": "123456",
    "fecha_ultima_ejecucion": null,
    "activa": true,
    "notificar_clientes": true,
    "notificar_articulos": true,
    "notificar_pedidos": true,
    "notificar_albaranes": true,
    "notificar_facturas": false,
    "empresa": 2
  }'

Crea una nueva notificación en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/notificaciones

Parámetros JSON

Parámetro Descripción
codigo Código identificativo de la notificación
*nombre Nombre de la notificación
observaciones Observaciones sobre la notificación
*url URL a la que se enviará la notificación
*clave Clave para autenticarse en la aplicación de terceros
fecha_ultima_ejecucion Fecha de la última notificación
*activa Indica si la notificación esta activa
*notificar_clientes Indica si se debe notificar cambios en clientes
*notificar_articulos Indica si se debe notificar cambios en artículos
*notificar_pedidos Indica si se debe notificar cambios en pedidos
*notificar_albaranes Indica si se debe notificar cambios en albaranes
*notificar_facturas Indica si se debe notificar cambios en facturas
*empresa Empresa de la notificación

Obtiene una notificación existente

Ejemplo

curl "https://api.gotesagab.com/v1/notificaciones/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una notificación existente.

Petición HTTP

GET https://api.gotesagab.com/v1/notificaciones/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la notificación

Actualiza una notificación existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/notificaciones/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "02"    
  }'

Actualiza los detalles de una notificación existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/notificaciones/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la notificación

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una notificación.

Borra una notificación existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/notificaciones/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una notificación existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/notificaciones/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la notificación

Registro de notificaciones

Ejemplo

{
    "id": 6,
    "datos_peticion": {
        "cambio": null,
        "datos": {
            "empresa": 32,
            "posicion": "0,0",
            "id": 36,
            "telefono_movil": "",
            "provincia": 1579,
            "domicilios_cobro_cliente": [
                {
                    "empresa": 32,
                    "nombre_banco": "ccm",
                    "iban": "2105",
                    "id": 15,
                    "principal": false
                }
            ],
            "razon_social": "del cliente",
            "ruta_principal": 20,
            "porcentaje_descuento": 0.0,
            "domicilio": "cl. de las pruebas",
            "logotipo": "/media/clientes/logos.png",
            "nombre": "Nuevo cliente",
            "telefono": "",
            "email": "info@pruebas.com",
            "observaciones": null,
            "nif": "12345",
            "nombre_forma_pago": "Contado",
            "nombre_provincia": "Cuenca",
            "tarifa": 34,
            "codigo_postal": "16004",
            "regimen_iva": 43,
            "contactos_cliente": [
                {
                    "cargo": "",
                    "empresa": 32,
                    "id": 31,
                    "nombre": "uno",
                    "telefono": "",
                    "email": "un@pruebas.com"
                }
            ],
            "forma_pago": 61,
            "localidad": "cuenca",
            "codigo": "05",
            "nombre_tarifa": "Normal"
        },
        "accion": "modificar",
        "tipo": "cliente"
    },
    "cabecera_peticion": {
        "X-GABAPI-NOTIFICACION-FIRMA": "949f77f15c128d67eb3df88826aa369c25fe01a7",
        "Content-Length": "796",
        "Content-Type": "application/json"
    },
    "datos_respuesta": "{\"status\": \"success\", \"attempt\": \"89aeb918-9b04-4991-aa6d-a43ab9a24f67\", \"id\": \"5f09ba06-1c86-40db-aaf4-2c90ff5b6e05\", \"request_id\": \"FkxrDNPnvJcDNS5S\"}",
    "cabecera_respuesta": {
        "content-length": "152",
        "x-xss-protection": "1; mode=block",
        "x-content-type-options": "nosniff",
        "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
        "server": "nginx",
        "x-zapier-fast-return": "true",
        "connection": "keep-alive",
        "x-zapier-jobs": "Woooo, a hacker like yourself should consider working at Zapier!",
        "date": "Thu, 20 Aug 2015 07:08:01 GMT",
        "x-frame-options": "SAMEORIGIN",
        "access-control-allow-origin": "*",
        "content-type": "application/json",
        "p3p": "CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\"",
        "x-zapier-jobs-link": "..."
    },    
    "url": "...",
    "estado": 200,
    "duracion": 0.688826,
    "notificacion": 1
}

Datos enviados en la notificación.

Atributos

Atributo Descripción
id Identificador único del registro de notificación
url URL a la que se ha enviado la notificación
estado Estado del envío
datos_peticion Datos enviados
cabecera_peticion Cabecera enviado
datos_respuesta Datos respuesta
cabecera_respuesta Cabecera respuesta
duracion Duración

Lista de registros de notificaciones

Ejemplo de petición

curl "https://api.gotesagab.com/v1/registro_notificaciones?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los registros de notificaciones que se han generado empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/registro_notificaciones?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
notificacion Filtra por notificación

Obtiene un registro de notificación existente

Ejemplo

curl "https://api.gotesagab.com/v1/registro_notificaciones/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un registro de notificación existente.

Petición HTTP

GET https://api.gotesagab.com/v1/registro_notificaciones/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del registro de notificación

Tablas auxiliares

Familia

Ejemplo

{
    "id": 1,
    "codigo": "01",
    "nombre": "ventanas aluminio",
    "empresa": 2,
    "observaciones": ""
}

Conjunto de artículos que presentan características similares.

Atributos

Atributo Descripción
id Identificador único de la familia
codigo Código identificativo de la familia
nombre Nombre de la familia
empresa Empresa de la familia
observaciones Observaciones sobre la familia

Lista de artículos

Ejemplo de petición

curl "https://api.gotesagab.com/v1/familias?empresa=1"
  -H "Authorization: meowmeowmeow"

Lista todas las familias de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/familias?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código de la familia
nombre Filtra por el nombre de la familia

Crear una familia

Ejemplo

curl "https://api.gotesagab.com/v1/familias" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "01",
    "nombre": "ventanas aluminio",
    "empresa": 2,
    "observaciones": ""
  }'

Crea una nueva familia en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/familias

Parámetros JSON

Parámetro Descripción
codigo Código identificativo de la familia
*nombre Nombre de la familia
*empresa Empresa de la familia
observaciones Observaciones sobre la familia

Obtiene una familia existente

Ejemplo

curl "https://api.gotesagab.com/v1/familias/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una familia existente.

Petición HTTP

GET https://api.gotesagab.com/v1/familias/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la familia

Actualiza una familia existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/familias/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "02"    
  }'

Actualiza los detalles de una familia existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/familias/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la familia

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una familia.

Borra una familia existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/familias/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una familia existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/familias/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la familia

Tarifa

Ejemplo

{
    "id": 1,
    "codigo": "01",
    "nombre": "Normal",
    "observaciones": "",
    "iva_incluido": false,
    "empresa": 2
}

Tabla de precios que serán aplicados a los artículos.

Atributos

Atributo Descripción
id Identificador único de la tarifa
codigo Código identificativo de la tarifa
nombre Nombre de la tarifa
empresa Empresa de la tarifa
iva_incluido Indica si la tarifa incluye el IVA
observaciones Observaciones sobre la tarifa

Lista de tarifas

Ejemplo de petición

curl "https://api.gotesagab.com/v1/tarifas?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las tarifas de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/tarifas?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código de la tarifa
nombre Filtra por el nombre de la tarifa

Crear una tarifa

Ejemplo

curl "https://api.gotesagab.com/v1/tarifas" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "01",
    "nombre": "Normal",
    "empresa": 2,
    "iva_incluido": false,
    "observaciones": ""
  }'

Crea una nueva tarifa en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/tarifas

Parámetros JSON

Parámetro Descripción
codigo Código identificativo de la tarifa
*nombre Nombre de la tarifa
*empresa Empresa de la tarifa
*iva_incluido Indica si la tarifa incluye el IVA
observaciones Observaciones sobre la tarifa

Obtiene una tarifa existente

Ejemplo

curl "https://api.gotesagab.com/v1/tarifas/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una tarifa existente.

Petición HTTP

GET https://api.gotesagab.com/v1/tarifas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la tarifa

Actualiza una tarifa existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/tarifas/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "02"    
  }'

Actualiza los detalles de una tarifa existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/tarifas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la tarifa

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una tarifa.

Borra una tarifa existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/tarifas/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una tarifa existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/tarifas/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la tarifa

Tipo de IVA

Ejemplo

{
    "id": 1,
    "codigo": "01",
    "nombre": "General",
    "observaciones": "",
    "porcentaje": 21.0,
    "porcentaje_recargo": 5.2,
    "empresa": 2
}

Tipos de iva que serán aplicados a los artículos.

Atributos

Atributo Descripción
id Identificador único del tipo de IVA
codigo Código identificativo del tipo de IVA
nombre Nombre del tipo de IVA
empresa Empresa del tipo de IVA
porcentaje Porcentaje del tipo de IVA
porcentaje_recargo Porcentaje de recargo del tipo de IVA
observaciones Observaciones sobre el tipo de IVA

Lista de tipos de IVA

Ejemplo de petición

curl "https://api.gotesagab.com/v1/tiposiva?empresa=1"? \
  -H "Authorization: meowmeowmeow"

Lista todos los tipos de IVA de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/tiposiva?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa

Crear un tipo de IVA

Ejemplo

curl "https://api.gotesagab.com/v1/tiposiva" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "01",
    "nombre": "General",
    "observaciones": "",
    "porcentaje": 21.0,
    "porcentaje_recargo": 5.2,
    "empresa": 2
  }'

Crea un nuevo tipo de IVA en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/tiposiva

Parámetros JSON

Parámetro Descripción
codigo Código identificativo del tipo de IVA
*nombre Nombre del tipo de IVA
*empresa Empresa del tipo de IVA
*porcentaje Porcentaje del tipo de IVA
*porcentaje_recargo Porcentaje de recargo del tipo de IVA
observaciones Observaciones sobre el tipo de IVA

Obtiene un tipo de IVA existente

Ejemplo

curl "https://api.gotesagab.com/v1/tiposiva/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un tipo de IVA existente.

Petición HTTP

GET https://api.gotesagab.com/v1/tiposiva/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del tipo de IVA

Actualiza un tipo de IVA existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/tiposiva/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "02"    
  }'

Actualiza los detalles de un tipo de IVA existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/tiposiva/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del tipo de IVA

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un tipo de IVA.

Borra un tipo de IVA existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/tiposiva/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un tipo de IVA existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/tiposiva/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del tipo de IVA

Régimen de IVA

Ejemplo

{
    "id": 4,
    "codigo": "01",
    "nombre": "Sin recargo",
    "observaciones": null,
    "aplicar_iva": true,
    "aplicar_recargo": false,
    "empresa": 20
}

Régimen de IVA que será aplicado a los documentos.

Atributos

Atributo Descripción
id Identificador único del régimen de IVA
codigo Código identificativo del régimen de IVA
nombre Nombre del régimen de IVA
empresa Empresa del régimen de IVA
aplicar_iva Indica si se aplica el IVA en el régimen de IVA
aplicar_recargo Indica si se aplica el recargo en el régimen de IVA
observaciones Observaciones sobre el régimen de IVA

Lista de regímenes de IVA

Ejemplo de petición

curl "https://api.gotesagab.com/v1/regimenesiva?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los regímenes de IVA de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/regimenesiva?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa

Crear un régimen de IVA

Ejemplo

curl "https://api.gotesagab.com/v1/regimenesiva" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{    
    "codigo": "01",
    "nombre": "Sin recargo",
    "observaciones": null,
    "aplicar_iva": true,
    "aplicar_recargo": false,
    "empresa": 20
  }'

Crea un nuevo régimen de IVA en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/regimenesiva

Parámetros JSON

Parámetro Descripción
codigo Código identificativo del régimen de IVA
*nombre Nombre del régimen de IVA
*empresa Empresa del régimen de IVA
*aplicar_iva Indica si se aplica el IVA en el régimen de IVA
*aplicar_recargo Indica si se aplica el recargo en el régimen de IVA
observaciones Observaciones sobre el régimen de IVA

Obtiene un régimen de IVA existente

Ejemplo

curl "https://api.gotesagab.com/v1/regimenesiva/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un régimen de IVA existente.

Petición HTTP

GET https://api.gotesagab.com/v1/regimenesiva/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del régimen de IVA

Actualiza un régimen de IVA existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/regimenesiva/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "02"    
  }'

Actualiza los detalles de un régimen de IVA existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/regimenesiva/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del régimen de IVA

Parámetros JSON

Estos parámetros son los mismos del recurso creación de un régimen de IVA.

Borra un régimen de IVA existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/regimenesiva/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de un régimen de IVA existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/regimenesiva/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del régimen de IVA

Forma de pago

Ejemplo

{
    "id": 1,
    "codigo": "01",
    "nombre": "Contado",
    "observaciones": "",
    "cobro_directo": false,
    "empresa": 2
}

Formas de pago que pueden utilizar los clientes.

Atributos

Atributo Descripción
id Identificador único de la forma de pago
codigo Código identificativo de la forma de pago
nombre Nombre de la forma de pago
empresa Empresa de la forma de pago
cobro_directo Indica si es cobro directo
observaciones Observaciones sobre la forma de pago

Lista de formas de pago

Ejemplo de petición

curl "https://api.gotesagab.com/v1/formaspago?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las formas de pago de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/formaspago?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código de la forma de pago
nombre Filtra por el nombre de la forma de pago

Crear una forma de pago

Ejemplo

curl "https://api.gotesagab.com/v1/formaspago" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "01",
    "nombre": "Contado",
    "observaciones": "",
    "cobro_directo": false,
    "empresa": 2
  }'

Crea una nueva forma de pago en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/formaspago

Parámetros JSON

Parámetro Descripción
codigo Código identificativo de la forma de pago
*nombre Nombre de la forma de pago
*empresa Empresa de la forma de pago
*cobro_directo Indica si es cobro directo
observaciones Observaciones sobre la forma de pago

Obtiene una forma de pago existente

Ejemplo

curl "https://api.gotesagab.com/v1/formaspago/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una forma de pago existente.

Petición HTTP

GET https://api.gotesagab.com/v1/formaspago/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la forma de pago

Actualiza una forma de pago existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/formaspago/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "02"    
  }'

Actualiza los detalles de una forma de pago existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/formaspago/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la forma de pago

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una forma de pago.

Borra una forma de pago existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/formaspago/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una forma de pago existente.

Petición HTTP

DELETE https://api.gotesagab.com/v1/formaspago/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la forma de pago

Serie

Ejemplo

{
    "id": 1,
    "codigo": "10",
    "nombre": "Serie del año 2010",
    "empresa": 2,
    "observaciones": "",
    "contadores_serie": [        
        {
            "id": 2,
            "empresa": 2,
            "serie": 1,
            "documento": 1,
            "numero": 18
        },
        {
            "id": 3,
            "empresa": 2,
            "serie": 1,
            "documento": 2,
            "numero": 19
        },
        {
            "id": 4,
            "empresa": 2,
            "serie": 1,
            "documento": 3,
            "numero": 17
        }
    ]
}

Las series de venta están concebidas para poder clasificar las ventas que realice una empresa por distintos sectores.

Atributos

Atributo Descripción
id Identificador único de la serie
codigo Código identificativo de la serie
nombre Nombre de la serie
empresa Empresa de la serie
observaciones Observaciones sobre la serie
contadores_serie Conjunto de contadores de la serie

Lista de series

Ejemplo de petición

curl "https://api.gotesagab.com/v1/series?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todas las series de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/series?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa
codigo Filtra por el código de la serie
nombre Filtra por el nombre de la serie

Crear una serie

Ejemplo

curl "https://api.gotesagab.com/v1/series" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "15",
    "nombre": "Serie 15",
    "empresa": 2,
    "observaciones": "Hola mundo"
  }'

Crea una nueva serie en la empresa.

Petición HTTP

POST https://api.gotesagab.com/v1/series

Parámetros JSON

Parámetro Descripción
codigo Código identificativo de la serie
*nombre Nombre de la serie
*empresa Empresa de la serie
observaciones Observaciones sobre la serie

Obtiene una serie existente

Ejemplo

curl "https://api.gotesagab.com/v1/series/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de una serie existente.

Petición HTTP

GET https://api.gotesagab.com/v1/series/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la serie

Actualiza una serie existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/series/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "codigo": "02"    
  }'

Actualiza los detalles de una serie existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/series/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la serie

Parámetros JSON

Estos parámetros son los mismos del recurso creación de una serie.

Borra una serie existente

Ejemplo

curl -X DELETE "https://api.gotesagab.com/v1/series/2" \
  -H "Authorization: meowmeowmeow"

Borra los detalles de una serie existente. También se borran todos sus contadores.

Petición HTTP

DELETE https://api.gotesagab.com/v1/series/id

Parámetros de Consulta

Parámetro Descripción
id Identificador de la serie

Series disponibles

Ejemplo

{
    "series_disponibles_pedidos": [
        {
            "nombre": "Serie Julio 2015",
            "id": 18
        },
        {
            "nombre": "serie 50",
            "id": 43
        },
        {
            "nombre": "Serie del año 2010",
            "id": 1
        },
        {
            "nombre": "Serie 15",
            "id": 47
        }
    ],
    "series_disponibles_albaranes": [
        {
            "nombre": "Serie Julio 2015",
            "id": 18
        },       
        {
            "nombre": "Serie del año 2010",
            "id": 1
        },
        {
            "nombre": "Serie 15",
            "id": 47
        }
    ],
    "series_disponibles_facturas": [
        {
            "nombre": "Serie Julio 2015",
            "id": 18
        },
        {
            "nombre": "serie 50",
            "id": 43
        },
        {
            "nombre": "Serie del año 2010",
            "id": 1
        }        
    ]
}

Lista las series disponibles que pueden ser asignadas a los agentes para cada tipo de documento.

Petición HTTP

GET https://api.gotesagab.com/v1/series/disponibles?empresa=empresa

Parámetros de Consulta

Parámetro Descripción
*empresa Filtra por empresa

Contador

Ejemplo

{
    "id": 2,
    "empresa": 2,
    "serie": 1,
    "documento": 1,
    "numero": 18
}

Los contadores se utilizan para almacenar el último número utilizado en cada uno de los documentos de una serie.

Atributos

Atributo Descripción
id Identificador único del contador
empresa Empresa del contador
serie Serie del contador
documento Tipo de documento del contador
numero Último número del contador

Lista de contadores

Ejemplo de petición

curl "https://api.gotesagab.com/v1/contadores?empresa=1" \
  -H "Authorization: meowmeowmeow"

Lista todos los contadores de la empresa.

Petición HTTP

GET https://api.gotesagab.com/v1/contadores?empresa=empresa

Parámetros de Consulta

Además de los parámetros de paginación este recurso dispone de los siguientes parámetros:

Parámetro Descripción
*empresa Filtra por empresa

Crear un contador

Obtiene un contador existente

Ejemplo

curl "https://api.gotesagab.com/v1/contadores/2" \
  -H "Authorization: meowmeowmeow"

Obtiene los detalles de un contador existente.

Petición HTTP

GET https://api.gotesagab.com/v1/contadores/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del contador

Actualiza un contador existente

Ejemplo

curl --request PATCH "https://api.gotesagab.com/v1/contadores/2" \
  -H "Authorization: meowmeowmeow" \
  -H "Content-Type: application/json" -d \
  '{
    "numero": 25   
  }'

Actualiza los detalles de un contador existente.

Petición HTTP

PATCH https://api.gotesagab.com/v1/contadores/id

Parámetros de Consulta

Parámetro Descripción
id Identificador del contador

Parámetros JSON

Borra un contador existente

Errores

La API Gotesa Good and Boxes utiliza los siguientes códigos de error:

Código Descripción
400 Bad Request – Su petición es erronea
403 Forbidden – Usted no tiene permisos para ejecutar esta acción
404 Not Found – La página solicitada no se encuentra
405 Method Not Allowed – Método no permitido
409 Conflict – La petición no se ha procesado ya que generaría un conflicto entre los datos
500 Internal Server Error – Ha ocurrido un problema en el servidor. Inténtelo nuevamente