Factura gorila permite a sus usuario tener registradas y emitir facturas desde multiples sucursales

La sucursal es un dato relevante durante la creación de la factura. Un usuario siempre tiene al menos una sucursal que es conocida como la sucursal matriz. La sucursal matriz se crea durante el registro de un usuario y los datos de esta sucursal son los mismos que los de la dirección fiscal.

Para facilitar la creación de las facturas, el desde el punto usuario se pueden obtener con una sola consulta todos los datos necesarios para poder emitir una factura, y entre ellos estan las sucurales configuradas, sin embargo, el punto Sucursales permite consultar y además administrar las sucursales. Es recomendable que se utilize el punto de Usuario para obtener las sucursales, mientras que se utilize el punto de sucursales para alta/baja/cambio.

Puedes ver las características de un objeto Sucursal en la sección de Tipos de dato.

 

Obtener una lista de sucursales

Se accede por método GET a

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

Se obtiene la lista completa de sucursales de un usuario envueltos en un objeto consulta.Como se mencionaba arriba, se recomienda mejor utilizar el punto Usuario para obtener la lista de sucursales.

Ejemplo (json):

{ "CantidadPorPagina" : 8,
  "PaginaActual" : 0,
  "Resultados" : [ { "Direccion" : { "Calle" : "Tiro al blanco",
            "CodigoPostal" : 27100,
            "Colonia" : "Centro",
            "DireccionCompleta" : " Tiro al blanco #3500 Centro, Ocampo, Durango,. Aguascalientes C.P. 27100",
            "DireccionId" : 831,
            "NombreEstado" : "Durango",
            "NombreMunicipio" : "Ocampo",
            "NombrePais" : "Aguascalientes",
            "NombrePoblacion" : "",
            "NumeroExterior" : "3500",
            "NumeroInterior" : ""
          },
        "Folio" : 619,
        "Nombre" : "Oficina Matriz",
        "Serie" : "C",
        "SucursalId" : 49
      },
      { "Direccion" : { "Calle" : "Centro",
            "CodigoPostal" : 35666,
            "Colonia" : "Centro",
            "DireccionCompleta" : " Centro #333 Centro, Juárez, Chihuahua,. Mexico C.P. 35666",
            "DireccionId" : 581,
            "NombreEstado" : "Chihuahua",
            "NombreMunicipio" : "Juárez",
            "NombrePais" : "Mexico",
            "NombrePoblacion" : "",
            "NumeroExterior" : "333",
            "NumeroInterior" : ""
          },
        "Folio" : 34,
        "Nombre" : "Sucursal Gomez Palacio",
        "Serie" : "J",
        "SucursalId" : 51
      },
      { "Direccion" : { "Calle" : "fghdfg",
            "CodigoPostal" : 222222227,
            "Colonia" : "Centro",
            "DireccionCompleta" : " fghdfg #100 Centro, Mexicali, Baja California,. Mexico C.P. 222222227",
            "DireccionId" : 605,
            "NombreEstado" : "Baja California",
            "NombreMunicipio" : "Mexicali",
            "NombrePais" : "Mexico",
            "NombrePoblacion" : "",
            "NumeroExterior" : "100",
            "NumeroInterior" : ""
          },
        "Folio" : 9,
        "Nombre" : "Prueba Web Api",
        "Serie" : "",
        "SucursalId" : 54
      },
      { "Direccion" : { "Calle" : "Centro",
            "CodigoPostal" : 34222,
            "Colonia" : "Independencia",
            "DireccionCompleta" : " Centro #123 Independencia, Campeche, Campeche,. Mexico C.P. 34222",
            "DireccionId" : 797,
            "NombreEstado" : "Campeche",
            "NombreMunicipio" : "Campeche",
            "NombrePais" : "Mexico",
            "NombrePoblacion" : "",
            "NumeroExterior" : "123",
            "NumeroInterior" : ""
          },
        "Folio" : 137,
        "Nombre" : "PrimeraSucursal3",
        "Serie" : "E",
        "SucursalId" : 56
      },
      { "Direccion" : { "Calle" : "Macias Puerta",
            "CodigoPostal" : 43534,
            "Colonia" : "Centro",
            "DireccionCompleta" : " Macias Puerta #232 Centro, Gomez Palacio, Durango,. Mexico C.P. 43534",
            "DireccionId" : 863,
            "NombreEstado" : "Durango",
            "NombreMunicipio" : "Gomez Palacio",
            "NombrePais" : "Mexico",
            "NombrePoblacion" : "",
            "NumeroExterior" : "232",
            "NumeroInterior" : ""
          },
        "Folio" : 44,
        "Nombre" : "Oficina Matriz",
        "Serie" : "Z",
        "SucursalId" : 74
      },
      { "Direccion" : { "Calle" : "Rojo Gomez",
            "CodigoPostal" : 27100,
            "Colonia" : "Fracc. El Tajito",
            "DireccionCompleta" : " Rojo Gomez #198 Fracc. El Tajito, Torreón, Coahuila,. México C.P. 27100",
            "DireccionId" : 864,
            "NombreEstado" : "Coahuila",
            "NombreMunicipio" : "Torreón",
            "NombrePais" : "México",
            "NombrePoblacion" : "",
            "NumeroExterior" : "198",
            "NumeroInterior" : ""
          },
        "Folio" : 1,
        "Nombre" : "Rojo Gomez",
        "Serie" : "A",
        "SucursalId" : 78
      },
      { "Direccion" : { "Calle" : "San Karim",
            "CodigoPostal" : 27000,
            "Colonia" : "Fracc. San Karim",
            "DireccionCompleta" : " San Karim #208 Fracc. San Karim, Gómez Palacio, Durango,. México C.P. 27000",
            "DireccionId" : 885,
            "NombreEstado" : "Durango",
            "NombreMunicipio" : "Gómez Palacio",
            "NombrePais" : "México",
            "NombrePoblacion" : "",
            "NumeroExterior" : "208",
            "NumeroInterior" : ""
          },
        "Folio" : 2,
        "Nombre" : "Notas de crédito",
        "Serie" : "",
        "SucursalId" : 79
      },
      { "Direccion" : { "Calle" : "San Karim",
            "CodigoPostal" : 27000,
            "Colonia" : "Fracc. San Karim",
            "DireccionCompleta" : " San Karim #208 Fracc. San Karim, Torreón, Durango,. México C.P. 27000",
            "DireccionId" : 886,
            "NombreEstado" : "Durango",
            "NombreMunicipio" : "Torreón",
            "NombrePais" : "México",
            "NombrePoblacion" : "",
            "NumeroExterior" : "208",
            "NumeroInterior" : ""
          },
        "Folio" : 2,
        "Nombre" : "Notas de crédito 2",
        "Serie" : "",
        "SucursalId" : 80
      }
    ],
  "TipoDatoResultado" : "Sucursal",
  "TotalDePaginas" : 1,
  "TotalResultados" : 8
}

Obtener una sucursal

Conociendo el id de una sucursal es posible consultarla en la siguiente url por método GET

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

Ejemplo respuesta (JSON):

{ "Direccion" : { "Calle" : "San Karim",
      "CodigoPostal" : 27000,
      "Colonia" : "Fracc. San Karim",
      "DireccionCompleta" : " San Karim #208 Fracc. San Karim, Torreón, Durango,. México C.P. 27000",
      "DireccionId" : 886,
      "NombreEstado" : "Durango",
      "NombreMunicipio" : "Torreón",
      "NombrePais" : "México",
      "NombrePoblacion" : "",
      "NumeroExterior" : "208",
      "NumeroInterior" : ""
    },
  "Folio" : 2,
  "Nombre" : "Notas de crédito 2",
  "Serie" : "",
  "SucursalId" : 80
}

Insertar una sucursal

Petición

Para crear una sucursal se utiliza la siguiente url en método POST

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

Lo siguientes parámetros son obligatorios:

  • Nombre
  • Dirección
  • Folio

La dirección es un dato complejo. Para ver detalles sobre las propiedades visita la sección de Tipos de dato.

Ejemplo (JSON):

{ "Direccion" : { "Calle" : "Hidalgo",
      "CodigoPostal" : "35434",
      "Colonia" : "Centro",
      "DireccionCompleta" : null,
      "DireccionId" : -1,
      "NombreEstado" : "Durango",
      "NombreMunicipio" : "Gomez Palacio",
      "NombrePais" : "Mexico",
      "NombrePoblacion" : "",
      "NumeroExterior" : "1234",
      "NumeroInterior" : "1-B"
    },
  "Folio" : "0",
  "Nombre" : "Sucursal X",
  "Serie" : "D",
}

Respuesta

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

Ejemplo (JSON):

{ "Direccion" : { "Calle" : "Hidalgo",
      "CodigoPostal" : "35434",
      "Colonia" : "Centro",
      "DireccionCompleta" : null,
      "DireccionId" : -1,
      "NombreEstado" : "Durango",
      "NombreMunicipio" : "Gomez Palacio",
      "NombrePais" : "Mexico",
      "NombrePoblacion" : "",
      "NumeroExterior" : "1234",
      "NumeroInterior" : "1-B"
    },
  "Folio" : "0",
  "Nombre" : "Sucursal X",
  "Serie" : "D",
  "SucursalId" : 100
}

Actualizar una Sucursal

Petición

Para actualizar una sucursal se accede a la siguiente url en método PUT

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

Ejemplo JSON

{ "Direccion" : { "Calle" : "Hidalgo",
      "CodigoPostal" : "35434",
      "Colonia" : "Centro",
      "DireccionCompleta" : null,
      "DireccionId" : -1,
      "NombreEstado" : "Durango",
      "NombreMunicipio" : "Gomez Palacio",
      "NombrePais" : "Mexico",
      "NombrePoblacion" : "",
      "NumeroExterior" : "1234",
      "NumeroInterior" : "1-B"
    },
  "Folio" : "0",
  "Nombre" : "Sucursal X",
  "Serie" : "D",
  "SucursalId" : 100
}

Respuesta

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

 

Borrar una Sucursal

Petición

Para borrar una sucursal se accede a la siguiente url en método DELETE

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

Respuesta

Se regresa con un código de estado 200