Skip to content
Factuplan Factuplan Documentación API para Desarrolladores | Factuplan

Establecimientos

Maneja todas las operaciones CRUD para los establecimientos en la API.

Endpoints

Section titled “Endpoints”

Obtener todos los establecimientos

Section titled “Obtener todos los establecimientos”

GET /establishments

Parámetros de consulta:

  • query: Parámetros de filtrado y ordenamiento (opcional)
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440010",
    "deletedAt": null,
    "createdAt": "2025-05-30T10:15:30.120Z",
    "updatedAt": "2025-05-30T10:15:30.120Z",
    "code": 1001,
    "name": "Establecimiento Principal",
    "address": "Av. Principal 123",
    "companyId": "550e8400-e29b-41d4-a716-446655440000",
    "tenantId": "550e8400-e29b-41d4-a716-446655440001"
  },
  {
    "id": "550e8400-e29b-41d4-a716-446655440011",
    "deletedAt": null,
    "createdAt": "2025-05-30T11:20:45.350Z",
    "updatedAt": "2025-05-30T11:20:45.350Z",
    "code": 1002,
    "name": "Sucursal Norte",
    "address": "Calle Secundaria 456",
    "companyId": "550e8400-e29b-41d4-a716-446655440000",
    "tenantId": "550e8400-e29b-41d4-a716-446655440001"
  }
]

Filtros

Section titled “Filtros”
CampoOperadorEjemplo
namelikeGET /establishments?query=filter.name__like=central
codeeqGET /establishments?query=filter.code__eq=1001
addresslikeGET /establishments?query=filter.address__like=norte

Obtener un establecimiento por ID

Section titled “Obtener un establecimiento por ID”

GET /establishments/{id}

Parámetros de URL:

  • id: ID del establecimiento a buscar
{
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "deletedAt": null,
  "createdAt": "2025-05-30T10:15:30.120Z",
  "updatedAt": "2025-05-30T10:15:30.120Z",
  "code": 1001,
  "name": "Establecimiento Principal",
  "address": "Av. Principal 123",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "tenantId": "550e8400-e29b-41d4-a716-446655440001"
}

Crear un nuevo establecimiento

Section titled “Crear un nuevo establecimiento”

POST /establishments

{
  "code": 1001,
  "name": "Establecimiento Principal",
  "address": "Av. Principal 123",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "tenantId": "550e8400-e29b-41d4-a716-446655440001"
}

Nota: El campo tenantId es opcional.

Actualizar un establecimiento existente

Section titled “Actualizar un establecimiento existente”

PUT /establishments/{id}

Parámetros de URL:

  • id: ID del establecimiento a actualizar
{
  "code": "1002",
  "address": "Calle Secundaria 456",
  "companyId": "550e8400-e29b-41d4-a716-446655440000",
  "tenantId": "550e8400-e29b-41d4-a716-446655440001"
}

Nota: Todos los campos en la actualización son opcionales excepto companyId, que es obligatorio.

Eliminar un establecimiento

Section titled “Eliminar un establecimiento”

DELETE /establishments/{id}

Parámetros de URL:

  • id: ID del establecimiento a eliminar
No content