Holded API

https://www.holded.com/es/desarrolladores
Admin
Holded API is a REST-based platform that enables developers to integrate and manage invoices,...
Tokens:466,740
Snippets:2,716
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GET /products

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/listado-de-productos-y-articulos-productos-con-stock-stock-d

Documentation for the GET /products endpoint that returns a paginated list of products with stock information.

```APIDOC
## GET /products

### Description
Retrieves a paginated list of products with stock information. Each product includes details such as identifiers, pricing, stock levels, and attributes.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Opaque cursor to retrieve the next page of results.

### Response
#### Success Response (200)
- **items** (array of objects) - List of products.
  - **id** (string) - Unique identifier of the product.
  - **kind** (string) - Type of item. Enum: `simple`, `variants`, `lots`, `serialnumbers`, `pack`.
  - **name** (string) - Name of the product.
  - **description** (string or null) - Description of the product.
  - **type_id** (string or null) - Identifier of the product type.
  - **price** (string or null) - Sale price as a decimal string.
  - **taxes** (array of strings) - List of tax identifiers applied to the product.
  - **total** (string or null) - Total price including taxes as a decimal string.
  - **has_stock** (boolean) - Whether the product has stock tracking enabled.
  - **stock** (string) - Current total stock across all warehouses as a decimal string.
  - **barcode** (string or null) - Barcode value (EAN, UPC, etc.).
  - **sku** (string or null) - Stock Keeping Unit code.
  - **cost** (string or null) - Cost price as a decimal string.
  - **purchase_price** (string or null) - Purchase price as a decimal string.
  - **weight** (string or null) - Weight in the account default unit as a decimal string.
  - **tags** (array of strings) - List of tags attached to the product.
  - **category_id** (string or null) - Identifier of the product category.
  - **factory_code** (string or null) - Manufacturer or factory reference code.
  - **for_sale** (boolean) - Whether the product is available for sale.
  - **for_purchase** (boolean) - Whether the product is available for purchase.
  - **sales_channel_id** (string or null) - Identifier of the sales channel assigned to this product.
  - **exp_account_id** (string or null) - Identifier of the expenses account.
  - **warehouse_id** (string or null) - Identifier of the default warehouse.
  - **archived** (boolean) - Whether the product is archived.
  - **purchase_taxes** (array of strings) - List of tax identifiers applied to purchases.
  - **min_stock** (string or null) - Minimum stock threshold as a decimal string.
  - **min_stock_alarm** (boolean) - Whether the minimum stock alarm is enabled.
  - **in_pos** (boolean) - Whether the product is available in point of sale.
  - **supplier_id** (string or null) - Identifier of the default supplier.
  - **translations** (array of objects) - Product name translations by locale.
  - **rates** (array of objects) - Price rates with different subtotals and taxes.
  - **attributes** (array of objects) - Product attributes.
  - **variants** (array of objects) - Variants of the product. Present for kinds: variants, lots, serialnumbers. Each item contains fields relevant to the kind.
  - **pack_items** (array of objects or null) - Component items included in this pack product. Only present for pack products.
  - **stocks** (array of objects) - Stock per warehouse. Each entry has warehouse_id and stock. Variant products also include variant_id.
  - **image** (object) - Main product image with its resolved URLs. Null when the product has no images.
- **cursor** (string or null) - Opaque cursor to pass as the `cursor` query parameter to retrieve the next page. Null when there are no more results.
- **has_more** (boolean) - Whether there are more results beyond this page.

#### Response Example
```json
{
  "items": [
    {
      "id": "string",
      "kind": "simple",
      "name": "string",
      "description": "string",
      "type_id": "string",
      "price": "string",
      "taxes": ["string"],
      "total": "string",
      "has_stock": true,
      "stock": "string",
      "barcode": "string",
      "sku": "string",
      "cost": "string",
      "purchase_price": "string",
      "weight": "string",
      "tags": ["string"],
      "category_id": "string",
      "factory_code": "string",
      "for_sale": true,
      "for_purchase": true,
      "sales_channel_id": "string",
      "exp_account_id": "string",
      "warehouse_id": "string",
      "archived": false,
      "purchase_taxes": ["string"],
      "min_stock": "string",
      "min_stock_alarm": false,
      "in_pos": true,
      "supplier_id": "string",
      "translations": [{}],
      "rates": [{}],
      "attributes": [{}],
      "variants": [{}],
      "pack_items": [{}],
      "stocks": [{}],
      "image": {}
    }
  ],
  "cursor": "string",
  "has_more": false
}
```

### Error Responses
- **401** - API key inválida o no proporcionada.
- **403** - Permisos insuficientes.
- **429** - Límite de solicitudes excedido.
```

--------------------------------

### GET /api/v2/projects/{projectId}

Source: https://www.holded.com/es/desarrolladores/referencia-api

Abre o ve un proyecto específico.

```APIDOC
## GET /api/v2/projects/{projectId}

### Description
Abre o ve un proyecto específico.

### Method
GET

### Endpoint
/api/v2/projects/{projectId}

### Parameters
#### Path Parameters
- **projectId** - Identificador del proyecto.

```

--------------------------------

### GET /api/v2/salary-records

Source: https://www.holded.com/es/desarrolladores/referencia-api

Listado de registros de nómina: nóminas y salarios.

```APIDOC
## GET /api/v2/salary-records

### Description
Listado de registros de nómina: nóminas y salarios.

### Method
GET

### Endpoint
/api/v2/salary-records

```

--------------------------------

### GET /api/v2/sales-receipts/{salesReceiptId}/attachments/{attachmentId}

Source: https://www.holded.com/es/desarrolladores/referencia-api

Obtiene adjunto de ticket de venta.

```APIDOC
## GET /api/v2/sales-receipts/{salesReceiptId}/attachments/{attachmentId}

### Description
Obtiene adjunto de ticket de venta.

### Method
GET

### Endpoint
/api/v2/sales-receipts/{salesReceiptId}/attachments/{attachmentId}

### Parameters
#### Path Parameters
- **salesReceiptId** (string) - Required - Identificador del ticket de venta.
- **attachmentId** (string) - Required - Identificador del adjunto.

```

--------------------------------

### Obtener imagen principal de un producto con Python

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/obtener-la-imagen-principal-de-un-producto

Realiza una petición GET al endpoint para obtener la imagen principal de un producto. Requiere un API key válida en el header Authorization y el ID del producto en la URL. Imprime la respuesta JSON.

```python
import requests

url = "https://api.holded.com/api/v2/products/{productId}/image"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Python: Get contact portal link

Source: https://www.holded.com/es/desarrolladores/referencia-api/contactos/obtener-enlace-del-portal-de-cliente-para-un-contacto

Use this Python example to obtain a portal link for a specific contact by calling the GET endpoint. Replace {contactId} with the contact's ObjectId and YOUR_API_KEY with your actual API key. The response contains the portal URL and its expiration date.

```python
import requests

url = "https://api.holded.com/api/v2/contacts/{contactId}/portal-link"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

```

--------------------------------

### Listar imágenes de un producto con Python

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/listar-imagenes-de-un-producto

Realiza una petición GET al endpoint de Holded para listar las imágenes de un producto. Requiere una API key válida en el header Authorization y el ID del producto en la URL.

```python
import requests

url = "https://api.holded.com/api/v2/products/{productId}/images"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### JSON: Get contact portal link response

Source: https://www.holded.com/es/desarrolladores/referencia-api/contactos/obtener-enlace-del-portal-de-cliente-para-un-contacto

Example JSON response from the portal-link endpoint. Contains the portal access URL and the expiration date in ISO 8601 format.

```json
{
  "url": "string",
  "expires_at": "2024-01-15T10:30:00Z"
}
```

--------------------------------

### Obtener listado de productos con requests

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/listado-de-productos-y-articulos-productos-con-stock-stock-d

Realiza una petición GET al endpoint de productos de Holded. Requiere una API key válida en el header Authorization. La respuesta se imprime en consola.

```python
import requests

url = "https://api.holded.com/api/v2/products?name=value&cursor=value&limit=50"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Python: Get sales order

Source: https://www.holded.com/es/desarrolladores/referencia-api/pedidos-de-venta/abrir-o-ver-un-pedido-de-venta

Python example using the requests library to retrieve a sales order by its ID. Requires a valid API key and the sales order ID in the URL path.

```python
import requests

url = "https://api.holded.com/api/v2/sales-orders/{salesOrderId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Adjuntar archivo a pedido de compra con Python

Source: https://www.holded.com/es/desarrolladores/referencia-api/pedidos-de-compra/adjuntar-un-archivo-a-un-pedido-de-compra

Python example using the requests library to attach a file to a purchase order. The file is sent as multipart/form-data with the key "file". Replace YOUR_API_KEY with your actual API key and file.pdf with the path to your file.

```python
import requests

url = "https://api.holded.com/api/v2/purchase-orders/{purchaseOrderId}/attachments"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

files = {"file": open("file.pdf", "rb")}
response = requests.post(url, headers=headers, files=files)
print(response.json())
```

--------------------------------

### JSON: Sales order response

Source: https://www.holded.com/es/desarrolladores/referencia-api/pedidos-de-venta/abrir-o-ver-un-pedido-de-venta

Example JSON response returned by the GET /sales-orders/{salesOrderId} endpoint. Shows the full structure of a sales order, including lines, custom fields, and shipping data.

```json
{
  "id": "507f1f77bcf86cd799439011",
  "document_number": "INV-0001",
  "contact_id": "507f1f77bcf86cd799439011",
  "contact_name": "Acme Corp",
  "description": "string",
  "date": "2024-01-15",
  "due_date": "2024-02-15",
  "subtotal": "100.00",
  "discount": "0",
  "total": "121.00",
  "tax": "21.00",
  "currency": "EUR",
  "status": "pending",
  "tags": [
    "string"
  ],
  "lines": [
    {
      "line_id": "string",
      "name": "string",
      "description": "string",
      "price": "100.00",
      "units": "1",
      "discount": "0",
      "tax": "21",
      "taxes": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "product_id": "string",
      "variant_id": "string",
      "service_id": "string",
      "sku": "string",
      "weight": "string",
      "cost_price": "string",
      "account": "string",
      "project_id": "string",
      "retention": "string",
      "unit_type": "kg",
      "supplied": false
    }
  ],
  "notes": "string",
  "language": "es",
  "currency_change": "1.00",
  "accounting_date": "2024-01-15",
  "approved_at": "2024-01-15T13:00:00",
  "draft": false,
  "custom_fields": [
    {
      "field": "string",
      "value": "string"
    }
  ],
  "projects_summary": [
    {
      "project_id": "string",
      "amount": "string"
    }
  ],
  "pipeline_id": "string",
  "warehouse_id": "string",
  "shipping": "string",
  "shipping_data": "string",
  "tracking_key": "string",
  "tracking_name": "string",
  "tracking_number": "string",
  "pickup_date": "2024-01-15",
  "delivery_date": "2024-01-20",
  "internal_notes": "string",
  "from": {
    "id": "string",
    "doc_type": "string"
  }
}
```

--------------------------------

### Actualizar contrato activo de empleado con Python (requests)

Source: https://www.holded.com/es/desarrolladores/referencia-api/empleados/actualizar-el-contrato-activo-de-un-empleado

Ejemplo de petición PUT en Python usando la librería requests. Envía todos los campos del contrato, incluyendo los obligatorios contractType y startDate. Reemplaza YOUR_API_KEY con tu clave de API.

```python
import requests

url = "https://api.holded.com/api/v2/employees/{employeeId}/contract"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "employee": "string",
    "nif": "string",
    "contractType": 421,
    "contributionType": "string",
    "royalDecree": "string",
    "startDate": "2024-01-15T10:30:00Z",
    "seniorityDate": "2024-01-15T10:30:00Z",
    "endDate": "2024-01-15T10:30:00Z",
    "educationalLevel": "string",
    "jobTitle": "string",
    "professionalCategory": "string",
    "scheduleHours": 0,
    "scheduleMode": "string",
    "workingDays": [
        "string"
    ],
    "probationPeriodDays": 0,
    "vacationDays": 0,
    "isManuallyActivated": false,
    "workModality": "string",
    "salary": 20000,
    "salaryInterval": "string",
    "salaryPayments": 0
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())
```

--------------------------------

### Python: GET /api/v2/inbox

Source: https://www.holded.com/es/desarrolladores/referencia-api/bandeja-de-entrada/listado-de-documentos-entrantes

Python example using the requests library to call the Holded API endpoint for listing incoming documents. It includes the required Authorization header with a bearer token and the Accept header. The query parameters cursor, limit, and status are shown as placeholders.

```python
import requests

url = "https://api.holded.com/api/v2/inbox?cursor=value&limit=50&status=value"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### POST /api/v2/products

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/crear-un-producto

Documentation for creating a product via the Holded API.

```APIDOC
## [POST] /api/v2/products

### Description
Creates a new product in Holded. This endpoint allows you to define product details such as name, pricing, stock, taxes, variants, and packaging.

### Method
POST

### Endpoint
https://api.holded.com/api/v2/products

### Parameters
#### Request Body
- **name** (string) - Required - Product name.
- **kind** (string) - Required - Product type, e.g., "simple".
- **description** (string) - Optional - Product description.
- **sku** (string) - Optional - Stock keeping unit.
- **barcode** (string) - Optional - Product barcode.
- **price** (string) - Optional - Selling price.
- **cost** (string) - Optional - Cost price.
- **purchase_price** (string) - Optional - Purchase price.
- **tags** (array of strings) - Optional - Tags for the product.
- **taxes** (array of strings) - Optional - Tax identifiers, e.g., "s_iva_21".
- **stock** (integer) - Optional - Stock quantity.
- **weight** (number) - Optional - Weight.
- **has_stock** (boolean) - Optional - Indicates if stock is tracked.
- **for_sale** (boolean) - Optional - Indicates if product is for sale.
- **for_purchase** (boolean) - Optional - Indicates if product is for purchase.
- **variants** (array of objects) - Optional - Product variants. Each variant can have: sku, barcode, price, cost, purchase_price, stock, description, weight, factory_code, archived, lot_number, start_date, end_date.
- **pack_items** (array of objects) - Optional - Pack items. Each item has: product_selection (string) and units (integer).
- **show_start_date** (boolean) - Optional - Show start date.
- **show_end_date** (boolean) - Optional - Show end date.
- **warehouse_id** (string) - Optional - Warehouse identifier.
- **sales_channel_id** (string) - Optional - Sales channel identifier.
- **exp_account_id** (string) - Optional - Expense account identifier.

### Request Example
{
  "name": "string",
  "kind": "simple",
  "description": "string",
  "sku": "string",
  "barcode": "string",
  "price": "99.95",
  "cost": "49.99",
  "purchase_price": "20.00",
  "tags": ["string"],
  "taxes": ["s_iva_21"],
  "stock": 10,
  "weight": 0,
  "has_stock": false,
  "for_sale": false,
  "for_purchase": false,
  "variants": [
    {
      "sku": "string",
      "barcode": "string",
      "price": "19.99",
      "cost": "string",
      "purchase_price": "string",
      "stock": 0,
      "description": "string",
      "weight": 0,
      "factory_code": "string",
      "archived": false,
      "lot_number": "string",
      "start_date": "2025-01-01",
      "end_date": "2025-12-31"
    }
  ],
  "pack_items": [
    {
      "product_selection": "507f1f77bcf86cd799439011",
      "units": 2
    }
  ],
  "show_start_date": false,
  "show_end_date": false,
  "warehouse_id": "string",
  "sales_channel_id": "string",
  "exp_account_id": "string"
}

### Response
#### Success Response (201)
- **id** (string) - The ID of the created product.

#### Response Example
{
  "id": "507f1f77bcf86cd799439011"
}

#### Error Responses
- **400** - Bad request.
- **401** - Invalid or missing API key.
- **403** - Insufficient permissions.
- **422** - Validation error.
- **429** - Rate limit exceeded.
```

--------------------------------

### Python: Get recurring invoice schedule

Source: https://www.holded.com/es/desarrolladores/referencia-api/facturas-recurrentes/consultar-el-calendario-de-una-factura-recurrente

Python example using the requests library to call the Holded API endpoint for retrieving the schedule of a recurring invoice. Replace {invoiceRecurringId} with the actual invoice ID and set the until query parameter as needed. Requires a valid API key in the Authorization header.

```python
import requests

url = "https://api.holded.com/api/v2/recurring-invoices/{invoiceRecurringId}/schedule?until=value"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Obtener resumen de un proyecto con Python

Source: https://www.holded.com/es/desarrolladores/referencia-api/proyectos/obtener-resumen-de-un-proyecto

Realiza una petición GET al endpoint de resumen de proyecto. Sustituye {projectId} por el ID del proyecto (ObjectId hexadecimal de 24 caracteres) y YOUR_API_KEY por tu clave de API. Requiere el scope projects:projects.read. La respuesta es un objeto JSON.

```Python
import requests

url = "https://api.holded.com/api/v2/projects/{projectId}/summary"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### GET /api/v2/contact-groups

Source: https://www.holded.com/es/desarrolladores/referencia-api/grupos-de-contactos/listado-de-grupos-de-contactos

Documentation for the GET endpoint that lists contact groups with pagination support.

```APIDOC
## GET /api/v2/contact-groups

### Description
Returns a paginated list of contact groups. Results are cursor-paginated: the response includes a `cursor` value and a `has_more` boolean. Pass the `cursor` to the next request to fetch the following page.

### Method
GET

### Endpoint
https://api.holded.com/api/v2/contact-groups

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Cursor opaco para paginación. Usa el valor devuelto en la respuesta anterior
- **limit** (integer) - Optional - Número máximo de elementos a devolver. Default: 50

### Request Example
```
import requests

url = "https://api.holded.com/api/v2/contact-groups?cursor=value&limit=50"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

### Response
#### Success Response (200)
- **items** (array of objects) - Required - List of contact groups
  - **id** (string) - Required - Unique identifier
  - **name** (string) - Required - Group name
  - **description** (string) - Required - Group description
  - **color** (string) - Required - Group color
- **cursor** (string or null) - Optional - Cursor for next page
- **has_more** (boolean) - Required - Indicates if there are more results

#### Response Example
```
{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "string",
      "description": "string",
      "color": "string"
    }
  ],
  "cursor": "string",
  "has_more": false
}
```

#### Error Responses
- **401** - API key inválida o no proporcionada
- **403** - Permisos insuficientes
- **429** - Límite de solicitudes excedido
```

--------------------------------

### product.create

Source: https://www.holded.com/es/desarrolladores/webhooks/productos

Se envía cuando se crea un producto en Holded. Incluye el payload con los datos del producto.

```APIDOC
## POST product.create

### Description
Se envía cuando se crea un producto en Holded.

### Method
POST

### Endpoint
product.create

### Parameters
#### Request Body
- **id** (string) - Required - Identificador único del producto
- **name** (string) - Required - Nombre del producto
- **description** (string | null) - Optional - Descripción del producto
- **kind** (string) - Required - Tipo de producto (simple, variants, lots, serial_numbers, pack)
- **sku** (string | null) - Optional - Código de referencia (SKU)
- **barcode** (string | null) - Optional - Código de barras
- **price** (string | null) - Optional - Precio de venta
- **cost** (string | null) - Optional - Precio de coste
- **stock** (string) - Required - Stock disponible
- **variants** (object[]) - Optional - Variantes del producto
  - **id** (string) - Required - Identificador único de la variante
  - **sku** (string | null) - Optional - Código de referencia (SKU)
  - **barcode** (string | null) - Optional - Código de barras
  - **price** (string | null) - Optional - Precio de venta
  - **cost** (string | null) - Optional - Precio de coste
  - **stock** (string | null) - Optional - Stock disponible
  - **description** (string | null) - Optional - Descripción de la variante
- **packItems** (object[]) - Optional - Composición del pack, presente solo en productos tipo pack
  - **productId** (string) - Required - Identificador del producto incluido en el pack
  - **variantId** (string | null) - Optional - Identificador de la variante incluida en el pack, cuando el elemento del pack es una variante
  - **units** (string) - Required - Unidades de este producto incluidas en el pack

### Request Example
```json
{
  "id": "string",
  "name": "string",
  "description": "string",
  "kind": "string",
  "sku": "string",
  "barcode": "string",
  "price": "string",
  "cost": "string",
  "stock": "string",
  "variants": [
    {
      "id": "string",
      "sku": "string",
      "barcode": "string",
      "price": "string",
      "cost": "string",
      "stock": "string",
      "description": "string"
    }
  ],
  "packItems": [
    {
      "productId": "string",
      "variantId": "string",
      "units": "string"
    }
  ]
}
```

### Response
#### Success Response (200)
No response body is documented.

```

--------------------------------

### GET /api/v2/products/{productId}/image

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/obtener-la-imagen-principal-de-un-producto

Documentation for the GET endpoint that retrieves the main image of a product.

```APIDOC
## GET /api/v2/products/{productId}/image

### Description
Retrieves the main (first) image of a product. Returns 404 if the product has no images.

### Method
GET

### Endpoint
`https://api.holded.com/api/v2/products/{productId}/image`

### Scope
`inventory:products.read`

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID del producto (ObjectId hexadecimal de 24 caracteres)

### Request Example
```python
import requests

url = "https://api.holded.com/api/v2/products/{productId}/image"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the image
- **position** (integer) - Position of the image in the product gallery (1-indexed)
- **description** (string | null) - Alt text or description of the image
- **url** (string | null) - Primary image URL (original size or raw URL)
- **sizes** (object) - Available image sizes with URLs and dimensions
  - **original** (object | null) - Original size
  - **large** (object | null) - Large size
  - **medium** (object | null) - Medium size
  - **small** (object | null) - Small size
  - **thumbnail** (object | null) - Thumbnail size

#### Response Example
```json
{
  "id": "507f1f77bcf86cd799439011",
  "position": 1,
  "description": "string",
  "url": "string",
  "sizes": {
    "original": {
      "url": "string",
      "width": 0,
      "height": 0
    },
    "large": {
      "url": "string",
      "width": 0,
      "height": 0
    },
    "medium": {
      "url": "string",
      "width": 0,
      "height": 0
    },
    "small": {
      "url": "string",
      "width": 0,
      "height": 0
    },
    "thumbnail": {
      "url": "string",
      "width": 0,
      "height": 0
    }
  }
}
```

#### Error Responses
- **401** - API key inválida o no proporcionada
- **403** - Permisos insuficientes
- **404** - Producto no encontrado o sin imágenes
- **429** - Límite de solicitudes excedido
```

--------------------------------

### Petición GET a /api/v2/leads con Python

Source: https://www.holded.com/es/desarrolladores/referencia-api/oportunidades/listado-de-oportunidades-de-venta-leads

Realiza una petición GET al endpoint de listado de oportunidades de venta (leads) de la API de Holded. Incluye el cursor opcional y el límite de 50 elementos por página. Requiere una API key válida en el encabezado de autorización.

```python
import requests

url = "https://api.holded.com/api/v2/leads?cursor=value&limit=50"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Adjuntar archivo a compra con requests (Python)

Source: https://www.holded.com/es/desarrolladores/referencia-api/compras/adjuntar-un-archivo-a-una-compra

Realiza una petición POST a la API de Holded para adjuntar un archivo a una compra. Envía el archivo como multipart/form-data usando el parámetro 'file'. Requiere un API key válido en el header Authorization.

```python
import requests

url = "https://api.holded.com/api/v2/purchases/{purchaseId}/attachments"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

files = {"file": open("file.pdf", "rb")}
response = requests.post(url, headers=headers, files=files)
print(response.json())
```

--------------------------------

### GET /api/v2/treasury/accounts/{id}/bank-movements

Source: https://www.holded.com/es/desarrolladores/referencia-api/cuentas-bancarias/listado-de-movimientos-de-una-cuenta-bancaria

Documentation for the GET endpoint that lists bank movements of a treasury account.

```APIDOC
## GET /api/v2/treasury/accounts/{id}/bank-movements

### Description
Retrieves a list of bank movements for a specific treasury account.

### Method
GET

### Endpoint
`https://api.holded.com/api/v2/treasury/accounts/{id}/bank-movements`

### Parameters
#### Path Parameters
- **id** (string) - Required - Identifier of the treasury account.

#### Query Parameters
- **cursor** (string) - Optional - Opaque cursor returned by the previous page.
- **limit** (integer) - Optional - Maximum number of movements per page. Default 50, maximum 200.
- **start_date** (string<date>) - Optional - Inclusive lower bound of the value date of the movement (ISO 8601).
- **end_date** (string<date>) - Optional - Inclusive upper bound of the value date of the movement (ISO 8601).
- **status** (string[]) - Optional - Comma-separated list of reconciliation statuses to filter: 'pending', 'reconciled', 'partial', 'forced_reconciled'.

### Request Example
```
GET https://api.holded.com/api/v2/treasury/accounts/507f1f77bcf86cd799439011/bank-movements?cursor=value&limit=50&start_date=2026-01-01
```

### Response
#### Success Response (200)
Returns a list of bank movements. The response schema is not specified in the source.

#### Response Example
Not provided in the source.
```

--------------------------------

### Python: Mover compra a una etapa del pipeline

Source: https://www.holded.com/es/desarrolladores/referencia-api/compras/cambiar-la-fase-de-compra-mover-de-etapa-o-estado-pipeline

Ejemplo de petición PUT a la API de Holded para cambiar la fase de una compra. Requiere un API key válido y el ID de la compra. El cuerpo debe incluir el pipeline_id de la etapa destino.

```Python
import requests

url = "https://api.holded.com/api/v2/purchases/{purchaseId}/pipeline"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "pipeline_id": "string"
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())
```

--------------------------------

### GET /api/v2/treasury/accounts/{id}/cash-movements

Source: https://www.holded.com/es/desarrolladores/referencia-api/cuentas-bancarias/listado-de-movimientos-de-caja-de-una-cuenta-bancaria

Documentation for the GET endpoint that lists cash movements of a banking account.

```APIDOC
## [GET] /api/v2/treasury/accounts/{id}/cash-movements

### Description
Returns a paginated list of cash movements (ledger entries) for a specific treasury account (banking account). The response includes details such as amount, currency, sign, and entry type.

### Method
GET

### Endpoint
https://api.holded.com/api/v2/treasury/accounts/{id}/cash-movements

### Parameters
#### Path Parameters
- **id** (string) - Required - Identifier of the treasury account.

#### Query Parameters
- **cursor** (string) - Optional - Opaque cursor returned by the previous page.
- **limit** (integer) - Optional - Maximum number of movements per page. Default 50, maximum 200.
- **start_date** (string<date>) - Optional - Inclusive lower bound of the accounting date of the movement (ISO 8601).
- **end_date** (string<date>) - Optional - Inclusive upper bound of the accounting date of the movement (ISO 8601).

### Request Example
```
GET https://api.holded.com/api/v2/treasury/accounts/507f1f77bcf86cd799439011/cash-movements?cursor=value&limit=50&start_date=2026-01-01
```

### Response
#### Success Response (200)
- **items** (array of objects) - List of cash movements.
  - **id** (string) - Unique identifier of the ledger entry.
  - **bankingAccountId** (string) - Identifier of the cash banking account this movement belongs to.
  - **date** (string<date-time>) - Accounting date of the ledger entry as an ISO 8601 timestamp.
  - **description** (string | null) - Description of the movement. Null when the entry has no description set.
  - **amount** (string) - Movement amount (debit minus credit) in the cash account currency. Positive for cash-in, negative for cash-out. Decimal as string.
  - **currency** (string) - ISO 4217 currency code of the cash account.
  - **accountingAccountNumber** (integer) - PGC accounting account number linked to the cash register.
  - **sign** (string) - Direction of the movement: 'in' for cash received, 'out' for cash paid. Enum: `in`, `out`.
  - **entryNumber** (integer | null) - Accounting entry group number. Null for automatically generated entries.
  - **entryType** (string) - Identifier of the source document or accounting operation. Enum: `amortization`, `reg`, `pl`, `opening`, `closing`, `entry`, `salesreceipt`, `receiptnote`, `transaction`, `collect`, `purchase`, `invoice`, `expense`, `payment`, `record`, `payroll`, `purchaserefund`, `creditnote`, `prorata_regularization`, `vat_regularization`, `purchaseshipment`.
- **cursor** (string | null) - Cursor for the next page.
- **has_more** (boolean) - Indicates if there are more pages.

#### Response Example
```json
{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "bankingAccountId": "507f1f77bcf86cd799439012",
      "date": "2024-01-15T10:30:00Z",
      "description": "string",
      "amount": "150.00",
      "currency": "EUR",
      "accountingAccountNumber": 57000001,
      "sign": "in",
      "entryNumber": 42,
      "entryType": "opening"
    }
  ],
  "cursor": "string",
  "has_more": false
}
```

### Error Responses
- **401** - Invalid or missing API key.
- **403** - Insufficient permissions.
- **404** - Banking account not found.
- **429** - Rate limit exceeded.
```

--------------------------------

### GET /api/v2/products/{productId}/images/{imageId}

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/obtener-una-imagen-de-producto-por-id

Documentation for the GET endpoint that retrieves a single product image by its ID.

```APIDOC
## GET /api/v2/products/{productId}/images/{imageId}

### Description
Retrieves a single image from a product by its image identifier. The response includes the image URL, available sizes with dimensions, position, and description.

### Method
GET

### Endpoint
`https://api.holded.com/api/v2/products/{productId}/images/{imageId}`

### Scope
`inventory:products.read`

### Parameters
#### Path Parameters
- **productId** (string) - Required - ID del producto (ObjectId hexadecimal de 24 caracteres)
- **imageId** (string) - Required - ID de la imagen (ObjectId hexadecimal de 24 caracteres)

### Request Example
```python
import requests

url = "https://api.holded.com/api/v2/products/{productId}/images/{imageId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

### Response
#### Success Response (200)
- **id** (string) - Required - Unique identifier of the image
- **position** (integer) - Required - Position of the image in the product gallery (1-indexed)
- **description** (string | null) - Required - Alt text or description of the image
- **url** (string | null) - Required - Primary image URL (original size or raw URL)
- **sizes** (object) - Required - Available image sizes with URLs and dimensions
  - **original** (object | null) - URL and dimensions for original size
  - **large** (object | null) - URL and dimensions for large size
  - **medium** (object | null) - URL and dimensions for medium size
  - **small** (object | null) - URL and dimensions for small size
  - **thumbnail** (object | null) - URL and dimensions for thumbnail size

#### Response Example
```json
{
  "id": "507f1f77bcf86cd799439011",
  "position": 1,
  "description": "string",
  "url": "string",
  "sizes": {
    "original": {
      "url": "string",
      "width": 0,
      "height": 0
    },
    "large": {
      "url": "string",
      "width": 0,
      "height": 0
    },
    "medium": {
      "url": "string",
      "width": 0,
      "height": 0
    },
    "small": {
      "url": "string",
      "width": 0,
      "height": 0
    },
    "thumbnail": {
      "url": "string",
      "width": 0,
      "height": 0
    }
  }
}
```

#### Error Responses
- **401** - API key inválida o no proporcionada
- **403** - Permisos insuficientes
- **404** - Producto o imagen no encontrada
- **429** - Límite de solicitudes excedido
```

--------------------------------

### Petición en Python para obtener una imagen de producto

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/obtener-una-imagen-de-producto-por-id

Ejemplo de petición GET usando la librería requests. Requiere una API key válida en el encabezado Authorization. Reemplaza {productId} e {imageId} con los IDs reales.

```python
import requests

url = "https://api.holded.com/api/v2/products/{productId}/images/{imageId}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### Aceptar un presupuesto con Python

Source: https://www.holded.com/es/desarrolladores/referencia-api/presupuestos/aceptar-un-presupuesto

Realiza una petición POST al endpoint de aceptación de presupuesto. Requiere un API key válido y el ID del presupuesto en la URL. El cuerpo incluye el nombre y un comentario opcional. La respuesta se imprime en consola.

```python
import requests

url = "https://api.holded.com/api/v2/estimates/{estimateId}/accept"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "name": "string",
    "comment": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
```

--------------------------------

### GET /api/v2/invoices/find-by-number

Source: https://www.holded.com/es/desarrolladores/referencia-api/facturas/buscar-facturas-por-numero

Documentación del endpoint GET para buscar facturas por número de documento.

```APIDOC
## GET /api/v2/invoices/find-by-number

### Description
Devuelve las facturas de tu cuenta cuyo número de documento coincide con el valor proporcionado. La búsqueda es fuzzy con autocompletado: los prefijos parciales (p. ej. `F260`) devuelven todas las facturas que empiezan por ese token, y se tolera algún error tipográfico.

### Method
GET

### Endpoint
`https://api.holded.com/api/v2/invoices/find-by-number`

### Parameters
#### Query Parameters
- **document_number** (string) - Required - Número de documento a buscar. Admite prefijos (p. ej. `F260`) y tolera errores tipográficos menores
- **limit** (integer) - Optional - Número máximo de facturas a devolver por página. Por defecto 50, máximo 200
- **cursor** (string) - Optional - Cursor de paginación devuelto por la respuesta anterior. Omitir para empezar desde la primera página

### Request Example
```python
import requests

url = "https://api.holded.com/api/v2/invoices/find-by-number?document_number=value&limit=50&cursor=value"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

### Response
#### Success Response (200)
No se especifica el esquema de respuesta en la documentación.

#### Response Example
No se proporciona un ejemplo de respuesta en la documentación.
```

--------------------------------

### Obtener stock en tránsito con Python

Source: https://www.holded.com/es/desarrolladores/referencia-api/productos/obtener-el-stock-en-transito-de-un-producto

Realiza una petición GET al endpoint de stock en tránsito de un producto. Requiere un API key válida en el header Authorization y el ID del producto en la URL. La respuesta se imprime en formato JSON.

```python
import requests

url = "https://api.holded.com/api/v2/products/{productId}/stock/transit"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

--------------------------------

### GET /api/v2/treasury/cashflow/invoicing-forecasts/{forecastId}

Source: https://www.holded.com/es/desarrolladores/referencia-api/previsiones-de-facturacion/abrir-o-ver-una-prevision-de-facturacion

Documentación del endpoint GET para abrir o ver una previsión de facturación específica.

```APIDOC
## [GET] /api/v2/treasury/cashflow/invoicing-forecasts/{forecastId}

### Description
Recupera todos los detalles de una previsión de facturación específica por su identificador único.

### Method
GET

### Endpoint
`https://api.holded.com/api/v2/treasury/cashflow/invoicing-forecasts/{forecastId}`

### Parameters
#### Path Parameters
- **forecastId** (string) - Required - Identificador de la previsión de facturación (ObjectId hexadecimal de 24 caracteres)

### Request Example
```python
import requests

url = "https://api.holded.com/api/v2/treasury/cashflow/invoicing-forecasts/507f1f77bcf86cd799439011"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())
```

### Response
#### Success Response (200)
Previsión de facturación encontrada

#### Error Responses
- **401** - API key inválida o no proporcionada (application/json)
- **403** - Permisos insuficientes (application/json)
- **404** - Previsión de facturación no encontrada (application/json)
- **429** - Límite de solicitudes excedido (application/json)
```
Tokens:
Raw