Tasks

Link a task to an entity

Link a task to a Factuarea entity (entity_type + entity_id). An entity that does not exist, belongs to another company or whose module is not accessible returns 404 linked_entity_not_found. Linking it again returns the existing link.

post/companies/{company}/tasks/{task}/entity-links

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/tasks/{task}/entity-links
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

taskstring uuid required

Public identifier (UUID v7) of the task.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

entity_type'invoice' | 'quote' | 'proforma' | 'delivery_note' | 'purchase_invoice' | 'recurring_invoice' | 'contact' | 'product' | 'employee' required

Entity type: invoice, quote, proforma, delivery_note, purchase_invoice, recurring_invoice, contact, product or employee.

entity_idstring uuid required

Public identifier (UUID v7) of the company entity.

Response

Example response

{
  "data": {
    "id": "0193a4f2-dea8-7c99-8d3a-2f4a6b8c0e01",
    "object": "task_entity_link",
    "task_id": "0193a4f2-8f53-7d44-8e85-7a9b1c3d5f12",
    "entity_type": "invoice",
    "entity_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a42",
    "available": true,
    "summary": {
      "title": "FAC-2026-00042",
      "number": "FAC-2026-00042",
      "status": "paid"
    },
    "created_at": "2026-09-18T13:27:51+02:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.