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 Remito Details API manages the individual line items (detalles) that make up a dispatch note (remito). Each detail links a remito to a specific donation item (idItemDonacion) and records the quantity dispatched. Line items are identified by a UUID (externalId) and can be created in bulk by supplying a JSON array in a single POST request.

Base URL

/api/detalles-remito
Path parameters use UUID format for the externalId of a detail, but the idRemito and idItemDonacion query/path parameters remain Long integers.

Endpoints

List all remito details (paginated)

Authorization
string
required
Bearer token with the DETALLE_REMITO_VER authority.
page
integer
Zero-based page index. Default: 0.
size
integer
Number of records per page. Default: 10.
sort
string
Sort field and direction (e.g. idRemito,asc).
GET /api/detalles-remito
Response — 200 OK — Spring Page<DetalleRemitoResponse> envelope.
{
  "content": [
    {
      "externalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "idRemito": 3,
      "idItemDonacion": 18,
      "cantidad": 50
    }
  ],
  "pageable": { "pageNumber": 0, "pageSize": 10 },
  "totalElements": 120,
  "totalPages": 12
}

Get details by remito ID

Authorization
string
required
Bearer token with the DETALLE_REMITO_VER authority.
idRemito
Long
required
Internal numeric ID of the remito whose details to retrieve.
GET /api/detalles-remito/remito/{idRemito}
Returns all line items belonging to the specified remito as an array (not paginated). Response — 200 OK
[
  {
    "externalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "idRemito": 3,
    "idItemDonacion": 18,
    "cantidad": 50
  },
  {
    "externalId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "idRemito": 3,
    "idItemDonacion": 22,
    "cantidad": 30
  }
]

Get details by donation item ID

Authorization
string
required
Bearer token with the DETALLE_REMITO_VER authority.
idItemDonacion
Long
required
Internal numeric ID of the donation item to look up across all remitos.
GET /api/detalles-remito/item-donacion/{idItemDonacion}
Response — 200 OK — JSON array of DetalleRemitoResponse objects.

Bulk create remito details

Authorization
string
required
Bearer token with the DETALLE_REMITO_CREAR authority.
This endpoint accepts a JSON array of NuevoDetalleRemito objects, not a single object. All items in the array are persisted atomically in one request.
POST /api/detalles-remito
Request body — List<NuevoDetalleRemito> Each element in the array must contain:
idRemito
Long
required
Internal numeric ID of the parent remito.
idItemDonacion
Long
required
Internal numeric ID of the donation item being dispatched.
cantidad
integer
required
Quantity dispatched. Must be at least 1.
Response codes
CodeMeaning
201 CreatedAll details created successfully
400 Bad RequestInvalid request data
404 Not FoundRemito or donation item not found
422 Unprocessable EntityBusiness rule violation
Response — 201 Created — JSON array of the created DetalleRemitoResponse objects.
[
  {
    "externalId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "idRemito": 3,
    "idItemDonacion": 18,
    "cantidad": 50
  },
  {
    "externalId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "idRemito": 3,
    "idItemDonacion": 22,
    "cantidad": 30
  }
]

Update remito detail

Authorization
string
required
Bearer token with the DETALLE_REMITO_ACTUALIZAR authority.
externalId
UUID
required
UUID of the detail to update.
PUT /api/detalles-remito/{externalId}
Request body — DetalleRemitoRequest
externalId
UUID
required
Must match the path parameter UUID.
idRemito
Long
required
Internal numeric ID of the parent remito.
idItemDonacion
Long
required
Internal numeric ID of the donation item.
cantidad
integer
required
Updated quantity. Must be at least 1.
Response — 200 OK — returns the updated DetalleRemitoResponse.

Delete remito detail

Authorization
string
required
Bearer token with the DETALLE_REMITO_ELIMINAR authority.
externalId
UUID
required
UUID of the detail to delete.
DELETE /api/detalles-remito/{externalId}
Response — 204 No Content — empty body on success.

Data models

NuevoDetalleRemito

FieldTypeRequiredConstraints
idRemitoLongMust not be null
idItemDonacionLongMust not be null
cantidadintegerMust be at least 1

DetalleRemitoRequest

FieldTypeRequiredConstraints
externalIdUUIDMust match the path parameter
idRemitoLongMust not be null
idItemDonacionLongMust not be null
cantidadintegerMust be at least 1

DetalleRemitoResponse

externalId
UUID
Unique identifier of the remito detail.
idRemito
Long
Internal ID of the parent remito.
idItemDonacion
Long
Internal ID of the dispatched donation item.
cantidad
integer
Quantity of the donation item dispatched.

Build docs developers (and LLMs) love