Rutas financieras originales¶

Estas rutas corresponden al contrato financiero original del API Business. Permanecen disponibles para integraciones existentes, pero las integraciones nuevas deberían utilizar los recursos REST de finanzas de comunidad y finanzas de propiedad.

Las diferencias principales son:

Solo permiten listar y crear; no ofrecen detalle, actualización ni eliminación.
Los listados contienen menos campos.
La creación responde 200 OK con un mensaje, no 201 Created con el recurso.
Los errores de referencias y validación se presentan de la misma forma genérica.
La paginación está fijada en 25 elementos.

No se anuncia actualmente una fecha de retirada. Antes de migrar una integración existente, compruebe las diferencias de respuesta descritas en esta página.

Movimientos de comunidad¶

Listar¶

GET /finances/{com_ref}

com_ref es la referencia de la comunidad dentro de la administración asociada al token.

El listado no admite filtros y devuelve 25 elementos por página, ordenados por fecha descendente, referencia descendente e ID descendente.

curl --request GET \
  --url 'https://api.onzane.com/bus/v1/finances/COM-001?page=1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>'

Respuesta 200 OK:

{
  "data": [
    {
      "reference": "RC-2026-001",
      "date": "2026-08-01T00:00:00.000000Z",
      "concept": "Cuota general de agosto",
      "charge": 125.5,
      "payment": 0,
      "balance": 325.5
    }
  ],
  "links": {
    "first": "https://api.onzane.com/bus/v1/finances/COM-001?page=1",
    "last": "https://api.onzane.com/bus/v1/finances/COM-001?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://api.onzane.com/bus/v1/finances/COM-001?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "path": "https://api.onzane.com/bus/v1/finances/COM-001",
    "per_page": 25,
    "to": 1,
    "total": 1
  }
}

El listado solo incluye movimientos generales de comunidad, es decir, aquellos sin propiedad asociada.

Crear¶

POST /finances/{com_ref}

Todos los campos siguientes, salvo reference, son obligatorios:

{
  "date": "2026-08-01",
  "reference": "RC-2026-001",
  "concept": "Cuota general de agosto",
  "charge": 125.5,
  "payment": 0,
  "balance": 325.5
}

Campo	Obligatorio	Validación
`date`	Sí	Fecha válida.
`reference`	No	Cadena o `null`, máximo 40 caracteres.
`concept`	Sí	Cadena, máximo 250 caracteres.
`charge`	Sí	Número.
`payment`	Sí	Número.
`balance`	Sí	Número. En esta ruta se almacena el valor recibido.

Respuesta 200 OK:

{
  "status": true,
  "message": "Community movement successfully added"
}

La respuesta no contiene el ID ni el movimiento creado.

Movimientos de propiedad¶

Listar¶

GET /finances/{com_ref}/{prop_ref}

prop_ref se resuelve dentro de la comunidad identificada por com_ref. El listado no admite filtros y devuelve 25 elementos por página, ordenados por fecha descendente, referencia descendente e ID descendente.

curl --request GET \
  --url 'https://api.onzane.com/bus/v1/finances/COM-001/VIV-1A?page=1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <token>'

La forma de la respuesta es la misma que en el listado de comunidad: data, links y meta. Cada elemento solo contiene reference, date, concept, charge, payment y balance.

Crear¶

POST /finances/{com_ref}/{prop_ref}

El cuerpo y sus validaciones son los mismos que en la creación de comunidad:

{
  "date": "2026-08-01",
  "reference": "REC-2026-883",
  "concept": "Recibo ordinario de agosto",
  "charge": 85.25,
  "payment": 0,
  "balance": 170.5
}

Respuesta 200 OK:

{
  "status": true,
  "message": "Property movement successfully added"
}

Errores del contrato original¶

Cuando el cuerpo no es válido, la comunidad no pertenece a la administración o la propiedad no pertenece a la comunidad, estas rutas responden 422 Unprocessable Entity:

{
  "status": false,
  "message": "Invalid inputs"
}

La respuesta no distingue qué referencia o campo produjo el error. Un token ausente o inválido continúa respondiendo 401 Unauthorized con el formato general de la API.

Migración a las rutas REST¶

Contrato original	Contrato recomendado
`GET /finances/{com_ref}`	`GET /communities/{community_reference}/finances`
`POST /finances/{com_ref}`	`POST /communities/{community_reference}/finances`
`GET /finances/{com_ref}/{prop_ref}`	`GET /properties/{property_reference}/finances`
`POST /finances/{com_ref}/{prop_ref}`	`POST /properties/{property_reference}/finances`

Al migrar, tenga en cuenta que el listado recomendado utiliza otro orden, devuelve el objeto completo y admite filtros. En las finanzas generales de comunidad, el saldo del contrato recomendado es calculado por Onzane.