Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/alvarezlautaro/BancoAlimentos/llms.txt

Use this file to discover all available pages before exploring further.

The Remitos API manages dispatch notes — documents that record when and to which institution a food delivery was made. Each remito is identified by a UUID, links to an institution by its internal Long ID, and carries a delivery date. The list endpoint accepts flexible date filters so operations staff can query deliveries by month, year, or an arbitrary date range.

​
Base URL

/api/remitos
Path parameters use UUID format (e.g. 3fa85f64-5717-4562-b3fc-2c963f66afa6).

​
Endpoints

​
Create remito

​
Authorization
string
required
Bearer token with the REMITO_CREAR authority.
POST /api/remitos
Request body — NuevoRemitoDTO
​
fecha
LocalDate
required
Delivery date in YYYY-MM-DD format. Must not be a future date.
​
idInstitucion
Long
required
Internal numeric ID of the destination institution.
Response codes
CodeMeaning
201 CreatedRemito created successfully
400 Bad RequestInvalid request data
404 Not FoundInstitution not found
422 Unprocessable EntityBusiness rule violation
Response — 201 Created 
{
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fecha": "2024-11-15",
  "idInstitucion": 7
}

​
List all remitos (paginated)

​
Authorization
string
required
Bearer token with the REMITO_VER authority.
​
mes
integer
Filter by month (1–12). Optional.
​
anio
integer
Filter by year (e.g. 2024). Optional.
​
desde
LocalDate
Start of date range in YYYY-MM-DD format. Optional.
​
hasta
LocalDate
End of date range in YYYY-MM-DD format. Optional.
​
page
integer
Zero-based page index. Default: 0.
​
size
integer
Number of records per page. Default: 10.
​
sort
string
Sort field and direction. Default: fecha.
GET /api/remitos
Response — 200 OK — Spring Page<RemitoDTO> envelope. 
{
  "content": [
    {
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fecha": "2024-10-20",
      "idInstitucion": 7
    }
  ],
  "pageable": { "pageNumber": 0, "pageSize": 10 },
  "totalElements": 18,
  "totalPages": 2
}

​
Get remito by ID

​
Authorization
string
required
Bearer token with the REMITO_VER authority.
​
id
UUID
required
External UUID of the remito.
GET /api/remitos/{id}
Response — 200 OK — single RemitoDTO object.

​
Full update

​
Authorization
string
required
Bearer token with the REMITO_ACTUALIZAR authority.
​
id
UUID
required
External UUID of the remito to update.
PUT /api/remitos/{id}
Request body uses ActualizarRemitoDTO fields (see Data models below). Response — 200 OK — returns the updated RemitoDTO.

​
Partial update

​
Authorization
string
required
Bearer token with the REMITO_ACTUALIZAR authority.
​
id
UUID
required
External UUID of the remito.
PATCH /api/remitos/{id}
Accepts the same ActualizarRemitoDTO shape; only provided fields are updated. Response — 200 OK — returns the updated RemitoDTO.

​
Delete remito

​
Authorization
string
required
Bearer token with the REMITO_ELIMINAR authority.
​
id
UUID
required
External UUID of the remito to delete.
DELETE /api/remitos/{id}
Response — 204 No Content — empty body on success.

​
Data models

​
NuevoRemitoDTO

​
fecha
LocalDate
required
Delivery date (YYYY-MM-DD). Must not be in the future.
​
idInstitucion
Long
required
Internal numeric ID of the destination institution.

​
RemitoDTO

​
externalId
UUID
Unique identifier of the remito, assigned by the system.
​
fecha
LocalDate
Delivery date in YYYY-MM-DD format.
​
idInstitucion
Long
Internal numeric ID of the destination institution.

​
ActualizarRemitoDTO

FieldTypeRequiredConstraints
fechaLocalDateMust not be a future date
idInstitucionLongInternal institution ID

​
Pagination

List responses use Spring’s standard Page<T> envelope.
Query paramDefaultDescription
page0Zero-based page number
size10Records per page
sortfechaSort field and optional direction (asc/desc)
Date filters (mes, anio, desde, hasta) can be combined freely. When both mes/anio and desde/hasta are supplied, the server’s filtering logic applies.

Build docs developers (and LLMs) love

Get started for freeTalk to us