# Holded

> Manage contacts, contact groups and services, and read invoices, products, payments, ledger entries, taxes, projects, tasks and treasury accounts.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/holded

## Actions

### Create a contact

Create a contact.

**Inputs**

- Name (`name`, text, required): Contact full name or company name
- Code (`code`, text): Tax identification number (NIF, CIF, etc.)
- VAT number (`vat_number`, text): EU VAT number
- Trade name (`trade_name`, text): Commercial or trade name, if different from legal name
- Is person (`is_person`, true/false): True if the contact is an individual, false if a company
- Email (`email`, text): Email address. Several can be sent separated by commas or semicolons: the first is the primary, the rest are returned in `extra_emails`. Invalid ones are ignored (400 if none is valid).
- Phone (`phone`, text): Landline phone number
- Mobile (`mobile`, text): Mobile phone number
- Website (`website`, text): Website URL
- Type (`type`, text): Contact classification. One of: `client`, `debtor`, `supplier`, `creditor`, `lead`.
- Client record (`client_record`, number): Number of the accounting account (chart of accounts) used when this contact acts as a client
- Supplier record (`supplier_record`, number): Number of the accounting account (chart of accounts) used when this contact acts as a supplier
- IBAN (`iban`, text): IBAN bank account number
- Swift (`swift`, text): SWIFT/BIC code of the bank
- Sepa ref (`sepa_ref`, text): SEPA mandate reference for direct debit collections
- Sepa date (`sepa_date`, date): Date the SEPA direct debit mandate was signed
- Tax operation (`tax_operation`, text): Fiscal operation type of the contact (e.g. general, intra, receq, exento). Must be one of the operations defined by the account tax scheme
- Bill address (`bill_address`, object): Billing address
- Tags (`tags`, list): Tags attached to the contact
- Custom fields (`custom_fields`, list): User-defined custom fields
- Defaults (`defaults`, object): Default settings applied to documents created for this contact

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "id": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Create a contact group

Create a contact group.

**Inputs**

- Name (`name`, text, required): Group name
- Description (`description`, text): Group description
- Color (`color`, text): Group color (hex code)

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "id": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Create a service

Create a service.

**Inputs**

- Name (`name`, text, required): Service name
- Description (`description`, text): Service description
- Price (`price`, number): Unit sale price
- Cost (`cost`, number): Unit cost price
- Tax (`tax`, number): Tax percentage
- Taxes (`taxes`, list): List of tax identifiers to apply
- Tags (`tags`, list): List of tag names
- Sales channel ID (`sales_channel_id`, text): Sales channel identifier
- Code (`code`, text): Internal reference code
- Color (`color`, text): Display color
- Duration (`duration`, number): Duration in minutes

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "id": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Delete a contact

Delete a contact.

**Inputs**

- ContactId (`contactId`, text, required): Contact ID (24-char hex ObjectId)

**Outputs**

- `data` (null): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}
```

### Delete a contact group

Delete a contact group.

**Inputs**

- ContactGroupId (`contactGroupId`, text, required): Contact Group ID (24-char hex ObjectId)

**Outputs**

- `data` (null): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}
```

### Delete a service

Delete a service.

**Inputs**

- ServiceId (`serviceId`, text, required): Service ID (24-char hex ObjectId)

**Outputs**

- `data` (null): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}
```

### Get a contact by ID

Get a contact by ID.

**Inputs**

- ContactId (`contactId`, text, required): Contact ID (24-char hex ObjectId)

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "bill_address": null,
    "client_record": null,
    "code": null,
    "contact_persons": [],
    "created_at": null,
    "custom_fields": [],
    "custom_id": null,
    "defaults": null,
    "email": null,
    "extra_emails": [],
    "group_id": null,
    "iban": null,
    "id": "example",
    "is_person": false,
    "mobile": null,
    "name": "example",
    "notes": [],
    "phone": null,
    "rate": null,
    "sepa_date": null,
    "sepa_ref": null,
    "shipping_addresses": [],
    "social_networks": null,
    "supplier_record": null,
    "swift": null,
    "tags": [],
    "tax_operation": null,
    "trade_name": null,
    "type": "client",
    "updated_at": null,
    "vat_number": null,
    "website": null
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get a contact group

Get a contact group.

**Inputs**

- ContactGroupId (`contactGroupId`, text, required): Contact Group ID (24-char hex ObjectId)

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "color": "example",
    "description": "example",
    "id": "example",
    "name": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get a product by ID

Get a product by ID.

**Inputs**

- ProductId (`productId`, text, required): Product ID (24-char hex ObjectId)

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

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

### Get a service

Get a service.

**Inputs**

- ServiceId (`serviceId`, text, required): Service ID (24-char hex ObjectId)

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "archived": false,
    "code": "example",
    "color": null,
    "cost": "example",
    "description": "example",
    "duration": null,
    "id": "example",
    "name": "example",
    "price": "example",
    "sales_channel_id": null,
    "tags": [],
    "taxes": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Get an invoice

Get an invoice.

**Inputs**

- InvoiceId (`invoiceId`, text, required): Invoice ID (24-char hex ObjectId)

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "accounting_date": null,
    "approved_at": null,
    "body": null,
    "contact_id": null,
    "contact_name": null,
    "currency": "example",
    "currency_change": "example",
    "custom_fields": [],
    "date": null,
    "description": null,
    "discount": "example",
    "document_number": null,
    "draft": null,
    "due_date": null,
    "forecast_date": null,
    "from": null,
    "id": "example",
    "language": null,
    "lines": [],
    "multiple_due_dates": null,
    "notes": null,
    "payment_method_id": null,
    "payments_detail": [],
    "payments_pending": "example",
    "payments_refunds": "example",
    "payments_total": "example",
    "pipeline_id": null,
    "projects_summary": [],
    "shipping": null,
    "shipping_data": null,
    "status": "failed",
    "subtotal": "example",
    "tags": [],
    "tax": "example",
    "total": "example",
    "warehouse_id": null
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List all products

List all products.

**Inputs**

- Name (`name`, text): Search products by name across your whole catalog. Optional.
- Cursor (`cursor`, text): Opaque cursor for pagination
- Limit (`limit`, number): Number of products per page. Defaults to 50, maximum 200. At most 200.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List all tasks

List all tasks.

**Inputs**

- Cursor (`cursor`, text): Pagination cursor returned by the previous response. Omit to start from the first page.
- Limit (`limit`, number): Maximum number of items to return. At most 200.
- Status (`status`, text): `open`: tasks not in a done status and not archived. `done`: tasks in a done status, archived ones included. Omit to list every task, archived ones included. One of: `open`, `done`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List all taxes

List all taxes.

**Inputs**: None.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List contact groups

List contact groups.

**Inputs**

- Cursor (`cursor`, text): Pagination cursor returned by the previous response. Omit to start from the first page.
- Limit (`limit`, number): Maximum number of items to return. At most 200.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List contacts

List contacts.

**Inputs**

- Phone (`phone`, text): Filter contacts by exact phone number match
- Mobile (`mobile`, text): Filter contacts by exact mobile number match
- Email (`email`, text): Filter contacts by exact email address match
- Custom ID (`custom_id`, text): Filter contacts by your external reference identifier
- Code (`code`, text): Filter contacts by exact tax identification number (NIF/CIF)
- Cursor (`cursor`, text): Opaque cursor for pagination. Use the value returned in the previous response to fetch the next page.
- Limit (`limit`, number): Maximum number of contacts to return per page. Defaults to 25, maximum 100. At most 200.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List invoices

List invoices.

**Inputs**

- Limit (`limit`, number): Maximum number of invoices to return per page. Defaults to 50, maximum 200. At most 200.
- Cursor (`cursor`, text): Pagination cursor returned by the previous response. Omit to start from the first page.
- Contact ID (`contact_id`, text): Filter invoices by contact identifier
- Status (`status`, text): Filter invoices by payment status. "pending" matches invoices with no payment recorded and "partial" those collected in part; both still owe a balance. "outstanding" returns the two together, "overdue" narrows that set to a due date already past, and "completed" returns the settled ones. One of: `pending`, `completed`, `partial`, `cancelled`, `failed`, `overdue`, `outstanding`.
- Start date (`start_date`, date and time): Filter invoices from this date. Accepts ISO 8601 datetime (e.g. 2026-01-01T00:00:00+00:00) or date only (e.g. 2026-01-01)
- End date (`end_date`, date and time): Filter invoices up to this date. Accepts ISO 8601 datetime (e.g. 2026-12-31T23:59:59+00:00) or date only (e.g. 2026-12-31). A date without a time (YYYY-MM-DD) includes that whole day; a value with a time is applied exactly as sent.
- Due date start (`due_date_start`, date and time): Filter invoices whose DUE date is on or after this date. Accepts ISO 8601 datetime or date only (e.g. 2026-01-01).
- Due date end (`due_date_end`, date and time): Filter invoices whose DUE date is on or before this date. Accepts ISO 8601 datetime or date only (e.g. 2026-03-12). A date without a time (YYYY-MM-DD) includes that whole day; a value with a time is applied exactly as sent.
- Sort (`sort`, text): Sort order for results. Prefix with - for descending. One of: `date`, `-date`, `dueDate`, `-dueDate`, `total`, `-total`.
- Approval status (`approval_status`, text): Filter by approval status. Use "draft" for unapproved invoices, "approved" for approved ones. One of: `draft`, `approved`.
- Accounting account num (`accounting_account_num`, number): Filter invoices that have at least one line booked to this accounting account, identified by its numeric PGC code (e.g. 70000000 for "Ventas de mercaderias"). Only the numeric code is accepted; a non-numeric value returns 400. Returns 404 if no accounting account with that number exists in the tenant. When called through the AI assistant, an account name is resolved to its code automatically before the request reaches this endpoint.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List ledger entries

List ledger entries.

**Inputs**

- Start date (`start_date`, date, required): Filter entries from this date onward
- End date (`end_date`, date, required): Filter entries up to this date
- Cursor (`cursor`, text): Opaque cursor for pagination
- Limit (`limit`, number): Maximum number of ledger entries to return per page. Defaults to 50, maximum 200. At most 200.
- Account (`account`, number): Filter entries by accounting account number (e.g. 70500001). Returns only entries posted to this exact account.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List payments

List payments.

**Inputs**

- Start date (`start_date`, date and time): Filter payments from this date onward. Accepts ISO 8601 datetime (e.g. 2024-01-01T00:00:00+00:00) or date only (e.g. 2024-01-01)
- End date (`end_date`, date and time): Filter payments up to this date. Accepts ISO 8601 datetime (e.g. 2024-12-31T23:59:59+00:00) or date only (e.g. 2024-12-31)
- Document ID (`document_id`, text): Filter payments linked to this document. Combine with document_type to match a specific document
- Document type (`document_type`, text): Filter payments by document type. Can be used alone, or combined with document_id to match a specific document
- Banking account ID (`banking_account_id`, text): Filter payments linked to this banking account
- Cursor (`cursor`, text): Opaque cursor for pagination
- Limit (`limit`, number): Maximum number of payments to return per page. At most 200.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List projects

List projects.

**Inputs**

- Cursor (`cursor`, text): Pagination cursor returned by the previous response. Omit to start from the first page.
- Limit (`limit`, number): Maximum number of items to return. At most 200.
- Status (`status`, text): Filter projects by status. Use "active" or "in_progress" to retrieve only active/in-progress projects. One of: `active`, `in_progress`, `completed`, `cancelled`, `waiting`, `budgeted`.

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List services

List services.

**Inputs**

- Limit (`limit`, number): Maximum number of services to return per page. Defaults to 25, maximum 100.
- Cursor (`cursor`, text): Pagination cursor returned by the previous response. Omit to start from the first page.
- Include archived (`include_archived`, true/false): Whether to include archived services in the results

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### List treasury accounts

List treasury accounts.

**Inputs**

- Cursor (`cursor`, text): Opaque cursor for pagination
- Limit (`limit`, number): Maximum number of banking accounts to return per page. At most 200.
- Type (`type`, text): Filter banking accounts by account type. Allowed values: `bank` (bank account), `card` (credit or debit card), `gateway` (payment gateway such as Stripe or PayPal), `cash` (cash register / petty cash). One of: `bank`, `card`, `gateway`, `cash`.
- Archived (`archived`, true/false): Filter by archived state. `true` returns only archived accounts, `false` returns only active accounts. Omit to return both (default).

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "cursor": null,
    "has_more": false,
    "items": []
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Update a contact

Update a contact.

**Inputs**

- ContactId (`contactId`, text, required): Contact ID (24-char hex ObjectId)
- Name (`name`, text, required): Contact full name or company name
- Code (`code`, text): Tax identification number (NIF, CIF, etc.)
- VAT number (`vat_number`, text): EU VAT number
- Trade name (`trade_name`, text): Commercial or trade name, if different from legal name
- Is person (`is_person`, true/false): True if the contact is an individual, false if a company
- Email (`email`, text): Email address. Several can be sent separated by commas or semicolons: the first is the primary, the rest are returned in `extra_emails`. Invalid ones are ignored (400 if none is valid).
- Phone (`phone`, text): Landline phone number
- Mobile (`mobile`, text): Mobile phone number
- Website (`website`, text): Website URL
- Type (`type`, text): Contact classification. One of: `client`, `debtor`, `supplier`, `creditor`, `lead`.
- Client record (`client_record`, number): Number of the accounting account (chart of accounts) used when this contact acts as a client
- Supplier record (`supplier_record`, number): Number of the accounting account (chart of accounts) used when this contact acts as a supplier
- IBAN (`iban`, text): IBAN bank account number
- Swift (`swift`, text): SWIFT/BIC code of the bank
- Sepa ref (`sepa_ref`, text): SEPA mandate reference for direct debit collections
- Sepa date (`sepa_date`, date): Date the SEPA direct debit mandate was signed
- Tax operation (`tax_operation`, text): Fiscal operation type of the contact (e.g. general, intra, receq, exento). Must be one of the operations defined by the account tax scheme. On update, omitting it (or sending null) keeps the current value
- Bill address (`bill_address`, object): Billing address
- Tags (`tags`, list): Tags attached to the contact
- Contact persons (`contact_persons`, list): Linked contact persons (by their contact ID)
- Custom fields (`custom_fields`, list): User-defined custom fields
- Defaults (`defaults`, object): Default settings applied to documents created for this contact

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "status": 0
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Update a contact group

Update a contact group.

**Inputs**

- ContactGroupId (`contactGroupId`, text, required): Contact Group ID (24-char hex ObjectId)
- Name (`name`, text): Group name
- Description (`description`, text): Group description
- Color (`color`, text): Group color (hex code)

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "id": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```

### Update a service

Update a service.

**Inputs**

- ServiceId (`serviceId`, text, required): Service ID (24-char hex ObjectId)
- Name (`name`, text): Name
- Description (`description`, text): Description
- Price (`price`, number): Price
- Cost (`cost`, number): Cost
- Tax (`tax`, number): Tax
- Taxes (`taxes`, list): Array of tax keys to apply. Retrieve valid keys from GET /api/v2/taxes before setting this field.
- Tags (`tags`, list): Tags
- Sales channel ID (`sales_channel_id`, text): Sales channel id
- Code (`code`, text): Code
- Color (`color`, text): Color
- Duration (`duration`, number): Duration

**Outputs**

- `data` (object): The response returned by the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation token for the next page.

**Example output**

```json
{
  "data": {
    "id": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}
```
