Un cliente es a quién va dirigida una Factura. Se puede crear, actualizar y borrar clientes desde la API.

 

Obtener la lista de clientes

Petición

Para obtener una lista de los clientes se obtiene de la siguiente url por método GET

https://app.facturagorila.com/v1/api/clientes

Se pueden definir los siguientes parámetros en query:

  • p: es el número de página deseado empezando por 0 (cero)
  • epp: el número de elementos por página
  • rfc: Filtra los cliente con un RFC en particular
  • contacto: Filtra los clientes con nombre de contacto en particular
  • email: Filtra los clientes con un email en particular
  • nombre: Filtra los clientes con un nombre en particular. Se busca tanto en el nombre como en la razón social

Ejemplo:

https://app.facturagorila.com/v1/api/clientes?nombre=pepe&contacto=pepe

Respuesta de listado de clientes

Ejemplo (JSON):

{
   "TotalResultados":36,
   "CantidadPorPagina":10,
   "TotalDePaginas":4,
   "PaginaActual":0,
   "TipoDatoResultado":"Cliente",
   "Resultados":[
      {
         "ClienteId":13,
         "RFC":"TEST020202TE1",
         "RazonSocial":"Test1 Test1 Test1 Pacheco",
         "Email":"test1@bisimplex.com",
         "NombreDeContacto":"test1",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":780,
               "Calle":"Calle1",
               "NumeroExterior":"1",
               "NumeroInterior":"",
               "Colonia":"Colonia1",
               "CodigoPostal":-1,
               "NombreEstado":"Durango",
               "NombreMunicipio":"Guadalupe Victoria",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Calle1 #1 Colonia1, Guadalupe Victoria, Durango,. Mexico C.P. 35049_1"
            },
            {
               "DireccionId":781,
               "Calle":"Calle 1_1",
               "NumeroExterior":"1_1",
               "NumeroInterior":"",
               "Colonia":"colonia 1_1",
               "CodigoPostal":-1,
               "NombreEstado":"Durango",
               "NombreMunicipio":"Gomez Palacio",
               "NombrePais":"México",
               "NombrePoblacion":"",
               "DireccionCompleta":" Calle 1_1 #1_1 colonia 1_1, Gomez Palacio, Durango,. México C.P. 35049_1_1"
            }
         ]
      },
      {
         "ClienteId":14,
         "RFC":"TEST020202TE2",
         "RazonSocial":"test2 test2 test2",
         "Email":"test2@bisimplex.com",
         "NombreDeContacto":"test2",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":462,
               "Calle":"Calle2",
               "NumeroExterior":"3",
               "NumeroInterior":"",
               "Colonia":"Colonia2",
               "CodigoPostal":-1,
               "NombreEstado":"Coahuila de Zaragoza",
               "NombreMunicipio":"Morelos",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Calle2 #3 Colonia2, Morelos, Coahuila de Zaragoza,. Mexico C.P. 35049_2"
            }
         ]
      },
      {
         "ClienteId":15,
         "RFC":"DAS801010F45",
         "RazonSocial":"EmpresaClienteTest2",
         "Email":"correo2@coreeo3.com",
         "NombreDeContacto":"correo2@coreeo3.com",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":463,
               "Calle":"Centro3",
               "NumeroExterior":"1244",
               "NumeroInterior":"",
               "Colonia":"Centro3",
               "CodigoPostal":33333,
               "NombreEstado":"Durango",
               "NombreMunicipio":"Pánuco de Coronado",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Centro3 #1244 Centro3, Pánuco de Coronado, Durango,. Mexico C.P. 33333"
            }
         ]
      },
      {
         "ClienteId":16,
         "RFC":"JHP701010J78",
         "RazonSocial":"EmpresaAdvertiser88",
         "Email":"jhpachecordz@gmail.com",
         "NombreDeContacto":"Hector",
         "Telefono1":"66666666",
         "Telefono2":"8888888888888",
         "Direcciones":[
            {
               "DireccionId":639,
               "Calle":"Centro",
               "NumeroExterior":"5678",
               "NumeroInterior":"",
               "Colonia":"Centro",
               "CodigoPostal":90000,
               "NombreEstado":"Aguascalientes",
               "NombreMunicipio":"El Llano",
               "NombrePais":"Mexico",
               "NombrePoblacion":"Cieneguilla",
               "DireccionCompleta":" Centro #5678 Centro, Cieneguilla, El Llano, Aguascalientes,. Mexico C.P. 90000"
            }
         ]
      },
      {
         "ClienteId":17,
         "RFC":"DER581010D34",
         "RazonSocial":"Advertiser13Invoice",
         "Email":"factura10@bisimplex.com",
         "NombreDeContacto":"Advertiser13Invoice",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":648,
               "Calle":"Central",
               "NumeroExterior":"555",
               "NumeroInterior":"",
               "Colonia":"Independencia",
               "CodigoPostal":67677,
               "NombreEstado":"Campeche",
               "NombreMunicipio":"Candelaria",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Central #555 Independencia, Candelaria, Campeche,. Mexico C.P. 67677"
            }
         ]
      },
      {
         "ClienteId":18,
         "RFC":"PRU451010P44",
         "RazonSocial":"Prueba44",
         "Email":"jhpachecordz@gmail.com",
         "NombreDeContacto":"Prueba44",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":511,
               "Calle":"Centro",
               "NumeroExterior":"12312",
               "NumeroInterior":"",
               "Colonia":"slkdjfhsjkd",
               "CodigoPostal":23234,
               "NombreEstado":"Baja California",
               "NombreMunicipio":"Tecate",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Centro #12312 slkdjfhsjkd, Tecate, Baja California,. Mexico C.P. 23234"
            }
         ]
      },
      {
         "ClienteId":19,
         "RFC":"PRU341010D45",
         "RazonSocial":"Prueba11",
         "Email":"hector_1971@starmedia.com",
         "NombreDeContacto":"Prueba11",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":541,
               "Calle":"Centro",
               "NumeroExterior":"1234",
               "NumeroInterior":"",
               "Colonia":"Centrro",
               "CodigoPostal":33333,
               "NombreEstado":"Durango",
               "NombreMunicipio":"Gómez Palacio",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Centro #1234 Centrro, Gómez Palacio, Durango,. Mexico C.P. 33333"
            }
         ]
      },
      {
         "ClienteId":20,
         "RFC":"GOYA780416GM0",
         "RazonSocial":"Bisimplex Technologies S. de R.L.",
         "Email":"j.alejandro83rdz@gmail.com",
         "NombreDeContacto":"George",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":443,
               "Calle":"Tiro al blanco",
               "NumeroExterior":"240",
               "NumeroInterior":"",
               "Colonia":"La Feria",
               "CodigoPostal":35049,
               "NombreEstado":"Durango",
               "NombreMunicipio":"Gómez Palacio",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Tiro al blanco #240 La Feria, Gómez Palacio, Durango,. Mexico C.P. 35049"
            }
         ]
      },
      {
         "ClienteId":23,
         "RFC":"DASR551010D55",
         "RazonSocial":"Hector Rodriguez",
         "Email":"correo55@bisimplex.com",
         "NombreDeContacto":"Pacheco",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":638,
               "Calle":"Hidalgo",
               "NumeroExterior":"1111",
               "NumeroInterior":"",
               "Colonia":"Profesionistas",
               "CodigoPostal":23478,
               "NombreEstado":"Durango",
               "NombreMunicipio":"Ocampo",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Hidalgo #1111 Profesionistas, Ocampo, Durango,. Mexico C.P. 23478"
            }
         ]
      },
      {
         "ClienteId":25,
         "RFC":"DER341010D77",
         "RazonSocial":"EmpresaCliente555",
         "Email":"correo33@bisimplex.com",
         "NombreDeContacto":"Hector",
         "Telefono1":"",
         "Telefono2":"",
         "Direcciones":[
            {
               "DireccionId":646,
               "Calle":"Centro2",
               "NumeroExterior":"555",
               "NumeroInterior":"",
               "Colonia":"Centro2",
               "CodigoPostal":55555,
               "NombreEstado":"Aguascalientes",
               "NombreMunicipio":"Aguascalientes",
               "NombrePais":"Mexico",
               "NombrePoblacion":"",
               "DireccionCompleta":" Centro2 #555 Centro2, Aguascalientes, Aguascalientes,. Mexico C.P. 55555"
            }
         ]
      }
   ]
}

 

Obtener un solo cliente

Petición

Si se conoce el identificador del cliente (ClienteId) se puede obtener los datos de un cliente en particular en la siguiente url por método GET

https://app.facturagorila.com/v1/api/clientes/{id}

Respuesta de un solo cliente

Ejemplo (JSON):

 {
   "ClienteId":13,
   "RFC":"TEST020202TE1",
   "RazonSocial":"Test1 Test1 Test1 Pacheco",
   "Email":"test1@bisimplex.com",
   "NombreDeContacto":"test1",
   "Telefono1":"",
   "Telefono2":"",
   "Direcciones":[
      {
         "DireccionId":780,
         "Calle":"Calle1",
         "NumeroExterior":"1",
         "NumeroInterior":"",
         "Colonia":"Colonia1",
         "CodigoPostal":-1,
         "NombreEstado":"Durango",
         "NombreMunicipio":"Guadalupe Victoria",
         "NombrePais":"Mexico",
         "NombrePoblacion":"",
         "DireccionCompleta":" Calle1 #1 Colonia1, Guadalupe Victoria, Durango,. Mexico C.P. 35049_1"
      },
      {
         "DireccionId":781,
         "Calle":"Calle 1_1",
         "NumeroExterior":"1_1",
         "NumeroInterior":"",
         "Colonia":"colonia 1_1",
         "CodigoPostal":-1,
         "NombreEstado":"Durango",
         "NombreMunicipio":"Gomez Palacio",
         "NombrePais":"México",
         "NombrePoblacion":"",
         "DireccionCompleta":" Calle 1_1 #1_1 colonia 1_1, Gomez Palacio, Durango,. México C.P. 35049_1_1"
      }
   ]
}

 

Insertar un Cliente

Petición

Para la creación de clientes se consulta por POST a la siguiente url

https://app.facturagorila.com/v1/api/clientes/

Se envían los siguientes datos:

  • RFC
  • RazonSocial
  • Email
  • NombreDeContacto
  • Direcciones (al menos una)
  • Telefono1
  • Telefono2

Ejemplo (JSON):

{
	"Email":"Algunemail@novalido.com",
	"NombreDeContacto":"Una persona cualquiera",
	"Direcciones":[
		{
			"Colonia":"Iguana",
			"DireccionId":0,
			"NumeroExterior":"111",
			"CodigoPostal":535353,
			"NombrePais":"Mexico",
			"Calle":"1111",
			"NombreMunicipio":"Gómez palacio",
			"NombreEstado":"Durango",
			"NombrePoblacion":""
		}],
	"RazonSocial":"Nombre test",
	"RFC":"TEST020108TE8"
}

Respuesta

Se retorna el objeto recién insertado. Además se incluye en el HTTP header Location una url al elemento insertado.

Ejemplo:

{
    "ClienteId" : 88,
    "Direcciones" :[
                {
            "Calle" : "1111",
            "CodigoPostal" : 535353,
            "Colonia" : "Iguana",
            "DireccionCompleta" : " 1111 #111 Iguana, , Gómez palacio, Durango. Mexico C.P. 535353",
            "DireccionId" : 789,
            "NombreEstado" : "Durango",
            "NombreMunicipio" : "Gómez palacio",
            "NombrePais" : "Mexico",
            "NombrePoblacion" : "",
            "NumeroExterior" : 111,
            "NumeroInterior" : "",
        }
    ],
    "Email" : "Unemail@email.com",
    "NombreDeContacto" : "Una persona cualquiera",
    "RFC" : "TEST020108TE8",
    "RazonSocial" : "Nombre test",
    "Telefono1" : "",
    "Telefono2" : ""
}

 

Actualizar un Cliente

Durante la actualización de un cliente, no es posible cambiar el RFC. Si la aplicación cliente envía el RFC en el cuerpo de la consulta este es ignorado.

Peticion

Para la actualización de un cliente se consulta por método PUT a la siguiente url

https://app.facturagorila.com/v1/api/clientes/{id}

Se envían los siguientes datos:

  • RazonSocial
  • Email
  • NombreDeContacto
  • Direcciones (al menos una)
  • Telefono1
  • Telefono2

Ejemplo (JSON):

{
        "ClienteId":88;
	"Email":"Algunemail@novalido.com",
	"NombreDeContacto":"Una persona cualquiera",
	"Direcciones":[
		{
			"Colonia":"Iguana",
			"DireccionId":789,
			"NumeroExterior":"111",
			"CodigoPostal":535353,
			"NombrePais":"Mexico",
			"Calle":"1111",
			"NombreMunicipio":"Gómez palacio",
			"NombreEstado":"Durango",
			"NombrePoblacion":""
		}],
	"RazonSocial":"Nombre test",
	"RFC":"TEST020108TE8"
}

Respuesta

Se obtiene un código HTTP 200 en caso de éxito, o un 400 (Bad request) en caso de error.

 

Borrar un Cliente

 

Petición

Para borrar un cliente se consulta la siguiente url en método DELETE

https://app.facturagorila.com/v1/api/clientes/{id}

 

Respuesta

Se obtiene una respuesta vacía con código 200.