Entities

Legal entity (business, organization) management. Entities are the core organizational unit that owns customers, invoices, and items.

The Entitie object

object

Attributes

idstring

emailstring

namestring

Other attributes

addressstring

address_2string

post_codestring

citystring

statestring

countrystring

country_codestring

currency_codestring

localestring

tax_numberstring

account_idstring

environmentstring

is_tax_subjectboolean

is_enabledboolean

settingsobject

metadataobject

created_atstring<date-time>

updated_atstring<date-time>

country_rulesobject

Create a new entity

POST/entities

Create a new legal entity (business, organization, or sole proprietor). Entities are the core organizational unit that owns customers, invoices, and items. Each entity can have custom number formatting for invoices and other settings.

Request

Header parameters

x-account-idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Body parameters

emailstringoptional

namestringrequired

countrystringrequired

Other parameters

addressstringoptional

address_2stringoptional

post_codestringoptional

citystringoptional

statestringoptional

country_codestringoptional

currency_codestringoptional

localestringoptional

tax_numberstringoptional

environmentstringoptional

is_tax_subjectbooleanoptional

is_enabledbooleanoptional

settingsobjectoptional

metadataobjectoptional

curl -X POST "https://eu.spaceinvoices.com/entities" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Test Company",
    "country": "United States"
  }'

Example:

Response

Returns

idstring

emailstring

namestring

Other parameters

addressstring

address_2string

post_codestring

citystring

statestring

countrystring

country_codestring

currency_codestring

localestring

tax_numberstring

account_idstring

environmentstring

is_tax_subjectboolean

is_enabledboolean

settingsobject

metadataobject

created_atstring<date-time>

updated_atstring<date-time>

country_rulesobject

json

{
  "id": "ent_6595a27b5d35015c3ef0c3fd",
  "name": "Test Company",
  "address": null,
  "address_2": null,
  "post_code": null,
  "city": null,
  "state": null,
  "country": "United States",
  "country_code": "US",
  "currency_code": "USD",
  "locale": "en-US",
  "tax_number": null,
  "email": null,
  "environment": "live",
  "is_tax_subject": true,
  "is_enabled": true,
  "settings": {
    "number_formats": {
      "invoice": "{yyyy}-{nnnnn}",
      "estimate": "{yyyy}-{nnnnn}",
      "credit_note": "CN-{yyyy}-{nnnnn}"
    },
    "email_defaults": {
      "invoice_subject": "Invoice {document_number} from {entity_name}",
      "invoice_body": "Dear {customer_name},\n\nThank you for your business! Please find your invoice {document_number} attached.\n\nInvoice Details:\n- Invoice Number: {document_number}\n- Invoice Date: {document_date}\n- Due Date: {document_due_date}\n- Total Amount: {document_total} {document_currency}\n\nIf you have any questions, please don't hesitate to contact us at {entity_email}.\n\nBest regards,\n{entity_name}",
      "estimate_subject": "Estimate {document_number} from {entity_name}",
      "estimate_body": "Dear {customer_name},\n\nThank you for your interest! Please find your estimate {document_number} attached.\n\nEstimate Details:\n- Estimate Number: {document_number}\n- Estimate Date: {document_date}\n- Valid Until: {document_valid_until}\n- Total Amount: {document_total} {document_currency}\n\nIf you have any questions, please don't hesitate to contact us at {entity_email}.\n\nBest regards,\n{entity_name}"
    },
    "default_invoice_due_days": 30,
    "default_estimate_valid_days": 30,
    "document_footer": "{entity_name} | Due Date: {document_due_date} | Invoice #{document_number}",
    "overdue_notifications": {
      "enabled": false,
      "threshold_days": [
        7,
        14,
        30
      ],
      "email_subject": "Payment Reminder: Overdue invoice(s) from {entity_name}",
      "email_body": "Dear {customer_name},\n\nThis is a friendly reminder that you have overdue invoices from {entity_name}.\n\n{invoice_list}\n\nPlease review and pay at your earliest convenience.\n\nIf you have any questions, please contact us at {entity_email}.\n\nBest regards,\n{entity_name}"
    },
    "tax_rules": null
  },
  "account_id": "acc_6595a27b5d35015c3ef0c3fd",
  "metadata": {},
  "country_rules": {
    "max_taxes_per_item": 3,
    "features": []
  },
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z"
}

Example:

List all entities

GET/entities

Retrieve a paginated list of entities with optional filtering and sorting. Supports cursor-based pagination for efficient navigation, flexible JSON querying with MongoDB-style operators, full-text search across entity names and countries, and sorting by various entity properties.

Request

Header parameters

x-account-idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Query parameters

limitintegeroptional

Number of results per request.

Default: 10

next_cursorstringoptional

Cursor to fetch the next page of results. Use the value from pagination.next_cursor in the previous response.

prev_cursorstringoptional

Cursor to fetch the previous page of results. Use the value from pagination.prev_cursor in the previous response.

include_total_countbooleanoptional

Whether to include the total count of items in pagination.total.
Default is true.
When false, pagination.total returns -1 for better performance.

order_byoptional

querystring<json>optional

JSON query object for filtering results. Supports MongoDB-style operators.

Supported operators:
- equals or direct value - Exact match (default)
- gte - Greater than or equal
- lte - Less than or equal
- gt - Greater than
- lt - Less than
- in - Value in array
- notIn - Value not in array
- contains - String contains (case-insensitive)
- startsWith - String starts with
- endsWith - String ends with
- between - Value between two numbers/dates [min, max]

Allowed fields: id, name, country, currency_code, created_at, updated_at

Examples:
- {"total": {"gte": 1000}} - Invoices over 1000
- {"customer.name": {"contains": "Acme"}} - Customer name contains "Acme"
- {"date": {"between": ["2025-01-01", "2025-12-31"]}} - Date range

searchstringoptional

Full-text search query to filter results across multiple fields.
Searches are case-insensitive and match partial strings.
Searches across all text fields including names, descriptions, addresses, and metadata values.

environmentstringoptional

Environment making queries on. Defaults to "live".

Possible values: "live", "sandbox"

Default: "live"

curl "https://eu.spaceinvoices.com/entities" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Response

Returns

dataarray of objects

paginationobject

Pagination metadata including cursors and result counts

json

{
  "data": [
    {
      "id": "ent_7595a27b5d35015c3ef0c3fe",
      "name": "Space Invoices d.o.o.",
      "address": "Tehnološki park 24",
      "address_2": "Building A",
      "post_code": "1000",
      "city": "Ljubljana",
      "state": null,
      "country": "Slovenia",
      "country_code": "SI",
      "currency_code": "EUR",
      "locale": "sl-SI",
      "tax_number": "SI12345678",
      "email": null,
      "environment": "live",
      "is_tax_subject": true,
      "is_enabled": true,
      "settings": {
        "number_formats": {
          "invoice": "{yyyy}-{nnnnn}",
          "estimate": "{yyyy}-{nnnnn}",
          "credit_note": "CN-{yyyy}-{nnnnn}"
        },
        "email_defaults": {
          "invoice_subject": "Invoice {document_number} from {entity_name}",
          "invoice_body": "Dear {customer_name},\n\nThank you for your business! Please find your invoice {document_number} attached.\n\nInvoice Details:\n- Invoice Number: {document_number}\n- Invoice Date: {document_date}\n- Due Date: {document_due_date}\n- Total Amount: {document_total} {document_currency}\n\nIf you have any questions, please don't hesitate to contact us at {entity_email}.\n\nBest regards,\n{entity_name}",
          "estimate_subject": "Estimate {document_number} from {entity_name}",
          "estimate_body": "Dear {customer_name},\n\nThank you for your interest! Please find your estimate {document_number} attached.\n\nEstimate Details:\n- Estimate Number: {document_number}\n- Estimate Date: {document_date}\n- Valid Until: {document_valid_until}\n- Total Amount: {document_total} {document_currency}\n\nIf you have any questions, please don't hesitate to contact us at {entity_email}.\n\nBest regards,\n{entity_name}"
        },
        "default_invoice_due_days": 30,
        "default_estimate_valid_days": 30,
        "document_footer": "{entity_name} | Due Date: {document_due_date} | Invoice #{document_number}",
        "overdue_notifications": {
          "enabled": false,
          "threshold_days": [
            7,
            14,
            30
          ],
          "email_subject": "Payment Reminder: Overdue invoice(s) from {entity_name}",
          "email_body": "Dear {customer_name},\n\nThis is a friendly reminder that you have overdue invoices from {entity_name}.\n\n{invoice_list}\n\nPlease review and pay at your earliest convenience.\n\nIf you have any questions, please contact us at {entity_email}.\n\nBest regards,\n{entity_name}"
        },
        "tax_rules": {
          "eu": {
            "vies_validate_vat": true,
            "auto_reverse_charge": false,
            "auto_remove_tax_export": false,
            "require_gross_prices": false
          }
        }
      },
      "account_id": "acc_6595a27b5d35015c3ef0c3fd",
      "metadata": {
        "industry": "Technology",
        "size": "Medium"
      },
      "country_rules": {
        "max_taxes_per_item": 1,
        "features": [
          "tax_clause_defaults",
          "furs",
          "eslog",
          "upn_qr",
          "kir_report"
        ]
      },
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-09-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 1,
    "next_cursor": null,
    "prev_cursor": null,
    "has_more": false
  }
}

Update an entity

PUT/entities/{id}

Update an existing entity's details. All fields are optional; only provided fields will be updated. Use this to modify entity information, address, tax details, or custom settings. Note: Country and country_code cannot be changed after entity creation.

Request

Header parameters

x-account-idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Path parameters

idstring<resource-id>required

Space Invoices resource identifier (format: {prefix}_{hex24})

Body parameters

emailstringoptional

namestringoptional

Other parameters

addressstringoptional

address_2stringoptional

post_codestringoptional

citystringoptional

statestringoptional

currency_codestringoptional

localestringoptional

tax_numberstringoptional

is_tax_subjectbooleanoptional

is_enabledbooleanoptional

settingsobjectoptional

metadataobjectoptional

curl -X PUT "https://eu.spaceinvoices.com/entities/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Company Name"
  }'

Example:

Response

Returns

idstring

emailstring

namestring

Other parameters

addressstring

address_2string

post_codestring

citystring

statestring

countrystring

country_codestring

currency_codestring

localestring

tax_numberstring

account_idstring

environmentstring

is_tax_subjectboolean

is_enabledboolean

settingsobject

metadataobject

created_atstring<date-time>

updated_atstring<date-time>

country_rulesobject

json

{
  "id": "ent_6595a27b5d35015c3ef0c3fd",
  "name": "Updated Company Name",
  "address": null,
  "address_2": null,
  "post_code": null,
  "city": null,
  "state": null,
  "country": "Slovenia",
  "country_code": "SI",
  "currency_code": "EUR",
  "locale": "en-US",
  "tax_number": null,
  "email": null,
  "environment": "live",
  "is_tax_subject": true,
  "is_enabled": true,
  "settings": {
    "number_formats": {
      "invoice": "{yyyy}-{nnnnn}",
      "estimate": "{yyyy}-{nnnnn}",
      "credit_note": "CN-{yyyy}-{nnnnn}"
    },
    "email_defaults": {
      "invoice_subject": "Invoice {document_number} from {entity_name}",
      "invoice_body": "Dear {customer_name},\n\nThank you for your business! Please find your invoice {document_number} attached.\n\nInvoice Details:\n- Invoice Number: {document_number}\n- Invoice Date: {document_date}\n- Due Date: {document_due_date}\n- Total Amount: {document_total} {document_currency}\n\nIf you have any questions, please don't hesitate to contact us at {entity_email}.\n\nBest regards,\n{entity_name}",
      "estimate_subject": "Estimate {document_number} from {entity_name}",
      "estimate_body": "Dear {customer_name},\n\nThank you for your interest! Please find your estimate {document_number} attached.\n\nEstimate Details:\n- Estimate Number: {document_number}\n- Estimate Date: {document_date}\n- Valid Until: {document_valid_until}\n- Total Amount: {document_total} {document_currency}\n\nIf you have any questions, please don't hesitate to contact us at {entity_email}.\n\nBest regards,\n{entity_name}"
    },
    "default_invoice_due_days": 30,
    "default_estimate_valid_days": 30,
    "document_footer": "{entity_name} | Due Date: {document_due_date} | Invoice #{document_number}",
    "overdue_notifications": {
      "enabled": false,
      "threshold_days": [
        7,
        14,
        30
      ],
      "email_subject": "Payment Reminder: Overdue invoice(s) from {entity_name}",
      "email_body": "Dear {customer_name},\n\nThis is a friendly reminder that you have overdue invoices from {entity_name}.\n\n{invoice_list}\n\nPlease review and pay at your earliest convenience.\n\nIf you have any questions, please contact us at {entity_email}.\n\nBest regards,\n{entity_name}"
    },
    "tax_rules": {
      "eu": {
        "vies_validate_vat": true,
        "auto_reverse_charge": false,
        "auto_remove_tax_export": false,
        "require_gross_prices": false
      }
    }
  },
  "account_id": "acc_6595a27b5d35015c3ef0c3fd",
  "metadata": {},
  "country_rules": {
    "max_taxes_per_item": 1,
    "features": [
      "tax_clause_defaults",
      "furs",
      "eslog",
      "upn_qr",
      "kir_report"
    ]
  },
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z"
}

Example:

Enable an entity

POST/entities/{id}/enable

Re-enable a disabled entity. Enabled entities can create documents (invoices, estimates, credit notes, etc.). This operation is idempotent - enabling an already enabled entity has no effect.

Request

Header parameters

x-account-idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Path parameters

idstring<resource-id>required

Space Invoices resource identifier (format: {prefix}_{hex24})

curl -X POST "https://eu.spaceinvoices.com/entities/{id}/enable" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Response

Returns

idstring

emailstring

namestring

Other parameters

addressstring

address_2string

post_codestring

citystring

statestring

countrystring

country_codestring

currency_codestring

localestring

tax_numberstring

account_idstring

environmentstring

is_tax_subjectboolean

is_enabledboolean

settingsobject

metadataobject

created_atstring<date-time>

updated_atstring<date-time>

country_rulesobject

json

{
  "id": "string",
  "name": "string",
  "address": "string",
  "address_2": "string",
  "post_code": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "country_code": "string",
  "currency_code": "string",
  "locale": "string",
  "tax_number": "string",
  "email": "string",
  "account_id": "string",
  "environment": "string",
  "is_tax_subject": true,
  "is_enabled": true,
  "settings": {
    "pdf_template": "modern",
    "number_formats": {
      "invoice": "string",
      "estimate": "string",
      "credit_note": "string",
      "advance_invoice": "string"
    },
    "primary_color": "string",
    "has_logo": true,
    "has_signature": true,
    "default_invoice_due_days": 0,
    "default_estimate_valid_days": 0,
    "email_defaults": {
      "invoice_subject": "string",
      "invoice_body": "string",
      "estimate_subject": "string",
      "estimate_body": "string"
    },
    "default_invoice_note": "string",
    "default_invoice_payment_terms": "string",
    "default_estimate_note": "string",
    "default_estimate_payment_terms": "string",
    "default_credit_note_note": "string",
    "default_credit_note_payment_terms": "string",
    "document_footer": "string",
    "furs": {
      "enabled": false,
      "numbering_strategy": "B",
      "operator_tax_number": "string",
      "operator_label": "string",
      "certificate_file_id": "string",
      "certificate_expiry": "string",
      "certificate_passphrase": "string",
      "foreign_operator": true
    },
    "tax_rules": {
      "eu": {
        "vies_validate_vat": true,
        "auto_reverse_charge": false,
        "auto_remove_tax_export": false,
        "require_gross_prices": false
      }
    },
    "overdue_notifications": {
      "enabled": false,
      "threshold_days": [
        0
      ],
      "email_subject": "string",
      "email_body": "string"
    },
    "upn_qr": {
      "enabled": true,
      "display_mode": "qr_only",
      "purpose_code": "string"
    },
    "bank_accounts": [
      {
        "type": "iban",
        "name": "string",
        "bank_name": "string",
        "iban": "string",
        "account_number": "string",
        "bic": "string",
        "routing_number": "string",
        "sort_code": "string",
        "is_default": true
      }
    ],
    "eslog_validation_enabled": true,
    "tax_clause_defaults": {
      "domestic": "string",
      "intra_eu_b2b": "string",
      "intra_eu_b2c": "string",
      "export": "string"
    }
  },
  "metadata": {},
  "created_at": "2026-02-04T18:15:50.315Z",
  "updated_at": "2026-02-04T18:15:50.315Z",
  "country_rules": {
    "max_taxes_per_item": 0,
    "features": [
      "string"
    ]
  }
}

Disable an entity

POST/entities/{id}/disable

Disable an entity. Disabled entities cannot create documents (invoices, estimates, credit notes, etc.) but all data remains accessible and settings can still be updated. This operation is idempotent - disabling an already disabled entity has no effect.

Request

Header parameters

x-account-idstringoptional

Account Id on which the request is made. Optional if user is part of only one account.

Path parameters

idstring<resource-id>required

Space Invoices resource identifier (format: {prefix}_{hex24})

curl -X POST "https://eu.spaceinvoices.com/entities/{id}/disable" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Response

Returns

idstring

emailstring

namestring

Other parameters

addressstring

address_2string

post_codestring

citystring

statestring

countrystring

country_codestring

currency_codestring

localestring

tax_numberstring

account_idstring

environmentstring

is_tax_subjectboolean

is_enabledboolean

settingsobject

metadataobject

created_atstring<date-time>

updated_atstring<date-time>

country_rulesobject

json

{
  "id": "string",
  "name": "string",
  "address": "string",
  "address_2": "string",
  "post_code": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "country_code": "string",
  "currency_code": "string",
  "locale": "string",
  "tax_number": "string",
  "email": "string",
  "account_id": "string",
  "environment": "string",
  "is_tax_subject": true,
  "is_enabled": true,
  "settings": {
    "pdf_template": "modern",
    "number_formats": {
      "invoice": "string",
      "estimate": "string",
      "credit_note": "string",
      "advance_invoice": "string"
    },
    "primary_color": "string",
    "has_logo": true,
    "has_signature": true,
    "default_invoice_due_days": 0,
    "default_estimate_valid_days": 0,
    "email_defaults": {
      "invoice_subject": "string",
      "invoice_body": "string",
      "estimate_subject": "string",
      "estimate_body": "string"
    },
    "default_invoice_note": "string",
    "default_invoice_payment_terms": "string",
    "default_estimate_note": "string",
    "default_estimate_payment_terms": "string",
    "default_credit_note_note": "string",
    "default_credit_note_payment_terms": "string",
    "document_footer": "string",
    "furs": {
      "enabled": false,
      "numbering_strategy": "B",
      "operator_tax_number": "string",
      "operator_label": "string",
      "certificate_file_id": "string",
      "certificate_expiry": "string",
      "certificate_passphrase": "string",
      "foreign_operator": true
    },
    "tax_rules": {
      "eu": {
        "vies_validate_vat": true,
        "auto_reverse_charge": false,
        "auto_remove_tax_export": false,
        "require_gross_prices": false
      }
    },
    "overdue_notifications": {
      "enabled": false,
      "threshold_days": [
        0
      ],
      "email_subject": "string",
      "email_body": "string"
    },
    "upn_qr": {
      "enabled": true,
      "display_mode": "qr_only",
      "purpose_code": "string"
    },
    "bank_accounts": [
      {
        "type": "iban",
        "name": "string",
        "bank_name": "string",
        "iban": "string",
        "account_number": "string",
        "bic": "string",
        "routing_number": "string",
        "sort_code": "string",
        "is_default": true
      }
    ],
    "eslog_validation_enabled": true,
    "tax_clause_defaults": {
      "domestic": "string",
      "intra_eu_b2b": "string",
      "intra_eu_b2c": "string",
      "export": "string"
    }
  },
  "metadata": {},
  "created_at": "2026-02-04T18:15:50.316Z",
  "updated_at": "2026-02-04T18:15:50.316Z",
  "country_rules": {
    "max_taxes_per_item": 0,
    "features": [
      "string"
    ]
  }
}