Entities
Entities
Legal entity (business, organization) management. Entities are the core organizational unit that owns customers, invoices, and items.
The Entity object
object
Attributes
idstring
namestring
addressstringnullable
citystringnullable
countrystring
country_codestring
currency_codestringnullable
tax_numberstringnullable
emailstringnullable
metadataobjectnullable
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
Other attributes
address_2stringnullable
post_codestringnullable
statestringnullable
localestring
timezonestring
tax_number_2stringnullable
company_numberstringnullable
phonestringnullable
websitestringnullable
fiscal_region_codestringnullable
starting_capitalnumbernullable
account_idstring
environmentstring
is_tax_subjectboolean
is_enabledboolean
created_atstring<date-time>
updated_atstring<date-time>
{
"id": "ent_7595a27b5d35015c3ef0c3fe",
"name": "Orbital Systems GmbH",
"address": "Musterstraße 123",
"address_2": "Building A",
"post_code": "10115",
"city": "Berlin",
"state": null,
"country": "Germany",
"country_code": "DE",
"currency_code": "EUR",
"locale": "de-DE",
"tax_number": "DE123456789",
"tax_number_2": "12/345/67890",
"company_number": "HRB 12345",
"email": null,
"website": null,
"environment": "live",
"is_tax_subject": true,
"is_enabled": true,
"settings": {
"number_formats": {
"invoice": "{yyyy}-{nnnnn}",
"estimate": "{yyyy}-{nnnnn}",
"credit_note": "{yyyy}-{nnnnn}",
"delivery_note": "{yyyy}-{nnnnn}",
"expense": "{yyyy}-{nnnnn}"
},
"email_defaults": {
"invoice_subject": "Rechnung {document_number} von {entity_name}",
"invoice_body": "Anbei finden Sie die Rechnung {document_number}.\nFälligkeitsdatum: {document_due_date}.",
"estimate_subject": "Angebot {document_number} von {entity_name}",
"estimate_body": "Anbei finden Sie das Angebot {document_number}.\nGültig bis: {document_valid_until}.",
"credit_note_subject": "Gutschrift {document_number} von {entity_name}",
"credit_note_body": "Anbei finden Sie die Gutschrift {document_number}.",
"advance_invoice_subject": "Vorausrechnung {document_number} von {entity_name}",
"advance_invoice_body": "Anbei finden Sie die Vorausrechnung {document_number}.",
"delivery_note_subject": "Lieferschein {document_number} von {entity_name}",
"delivery_note_body": "Anbei finden Sie den Lieferschein {document_number}."
},
"default_invoice_due_days": 30,
"default_invoice_payment_terms": null,
"default_estimate_valid_days": 30,
"document_footer": "{entity_name}",
"default_document_signature": "{entity_name}",
"overdue_notifications": {
"enabled": false,
"threshold_days": [
7,
14,
30
],
"email_subject": "Zahlungserinnerung von {entity_name}",
"email_body": "Dies ist eine Erinnerung an überfällige Rechnungen von {entity_name}.\n\n{invoice_list}\n\nBitte prüfen Sie den offenen Betrag und veranlassen Sie die Zahlung."
},
"payment_reminders": {
"email_subject": "Zahlungserinnerung von {entity_name}",
"email_body": "Dies ist eine Erinnerung an überfällige Rechnungen von {entity_name}.\n\n{invoice_list}\n\nBitte prüfen Sie den offenen Betrag und veranlassen Sie die Zahlung.",
"payment_instructions": "Bitte verwenden Sie die auf dem Dokument angegebenen Bankdaten."
},
"tax_rules": {
"eu": {
"vies_validate_vat": true,
"auto_reverse_charge": false,
"auto_remove_tax_export": false,
"require_gross_prices": false
}
},
"tax_clause_defaults": {
"intra_eu_b2b": "§ 13b UStG (Reverse Charge)",
"3w_b2b": "§ 4 Nr. 1a + § 6 UStG",
"3w_b2c": "§ 4 Nr. 1a + § 6 UStG"
},
"translations": {
"default_invoice_note": {
"de-DE": "Vielen Dank fuer Ihren Auftrag."
},
"default_invoice_payment_terms": {
"de-DE": "Zahlbar innerhalb von 30 Tagen."
},
"document_footer": {
"de-DE": "Orbital Systems GmbH"
},
"default_document_signature": {
"de-DE": "Orbital Systems Team"
},
"email_defaults": {
"invoice_subject": {
"de-DE": "Rechnung {document_number} von {entity_name}"
},
"invoice_body": {
"de-DE": "Anbei finden Sie die Rechnung {document_number}."
}
},
"tax_clause_defaults": {
"intra_eu_b2b": {
"de-DE": "Steuerschuldnerschaft des Leistungsempfaengers."
}
}
}
},
"account_id": "acc_6595a27b5d35015c3ef0c3fd",
"metadata": {
"industry": "Technology",
"size": "Medium"
},
"country_rules": {
"max_taxes_per_item": 1,
"features": [
"eu_tax_rules",
"tax_clause_defaults",
"tax_number_2",
"epc_qr"
]
},
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-09-01T00:00:00.000Z"
}Create a new entity
POST
/entitiesCreate 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
account_idstringoptional
Account Id on which the request is made. Optional if user is part of only one account.
Body parameters
namestringrequired
addressstringoptionalnullable
citystringoptionalnullable
countrystringrequired
country_codestringoptionalnullable
currency_codestringoptionalnullable
tax_numberstringoptionalnullable
emailstringoptionalnullable
metadataobjectoptionalnullable
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
Other parameters
address_2stringoptionalnullable
post_codestringoptionalnullable
statestringoptionalnullable
localestringoptionalnullable
timezonestringoptional
tax_number_2stringoptionalnullable
company_numberstringoptionalnullable
phonestringoptionalnullable
websitestringoptionalnullable
fiscal_region_codestringoptionalnullable
starting_capitalnumberoptionalnullable
environmentstringoptional
is_tax_subjectbooleanoptional
is_enabledbooleanoptional
import SpaceInvoices from '@spaceinvoices/js-sdk';
const sdk = new SpaceInvoices('YOUR_API_KEY');
const response = await sdk.entities.create({
name: "Starward Equipment Co.",
country: "United States"
});
console.log(response);Example:
Response
Returns
idstring
namestring
addressstringnullable
citystringnullable
countrystring
country_codestring
currency_codestringnullable
tax_numberstringnullable
emailstringnullable
metadataobjectnullable
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
Other parameters
address_2stringnullable
post_codestringnullable
statestringnullable
localestring
timezonestring
tax_number_2stringnullable
company_numberstringnullable
phonestringnullable
websitestringnullable
fiscal_region_codestringnullable
starting_capitalnumbernullable
account_idstring
environmentstring
is_tax_subjectboolean
is_enabledboolean
created_atstring<date-time>
updated_atstring<date-time>
{
"id": "ent_6595a27b5d35015c3ef0c3fd",
"name": "Starward Equipment Co.",
"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,
"tax_number_2": null,
"company_number": null,
"email": null,
"website": null,
"environment": "live",
"is_tax_subject": true,
"is_enabled": true,
"settings": {
"number_formats": {
"invoice": "{yyyy}-{nnnnn}",
"estimate": "{yyyy}-{nnnnn}",
"credit_note": "{yyyy}-{nnnnn}",
"delivery_note": "{yyyy}-{nnnnn}",
"expense": "{yyyy}-{nnnnn}"
},
"email_defaults": {
"invoice_subject": "Invoice {document_number} from {entity_name}",
"invoice_body": "Please find invoice {document_number} attached.\nDue date: {document_due_date}.\n\n[View document]({invoice_link})",
"estimate_subject": "{document_label} {document_number} from {entity_name}",
"estimate_body": "Please find {document_label} {document_number} attached.\nValid until: {document_valid_until}.\n\n[View document]({invoice_link})",
"credit_note_subject": "Credit note {document_number} from {entity_name}",
"credit_note_body": "Please find credit note {document_number} attached.\n\n[View document]({invoice_link})",
"advance_invoice_subject": "Advance invoice {document_number} from {entity_name}",
"advance_invoice_body": "Please find advance invoice {document_number} attached.\n\n[View document]({invoice_link})",
"delivery_note_subject": "Delivery note {document_number} from {entity_name}",
"delivery_note_body": "Please find delivery note {document_number} attached.\n\n[View document]({invoice_link})"
},
"default_invoice_due_days": 30,
"default_invoice_payment_terms": null,
"default_estimate_valid_days": 30,
"document_footer": "{entity_name}",
"default_document_signature": "{entity_name}",
"overdue_notifications": {
"enabled": false,
"threshold_days": [
7,
14,
30
],
"email_subject": "Payment reminder from {entity_name}",
"email_body": "Hello,\n\nThe invoices below are overdue. Please arrange payment of {total_amount} at your earliest convenience.\n\n{invoice_list}\n\n{payment_instructions}\n\nIf you have already paid, please disregard this reminder.\n\nBest regards,"
},
"payment_reminders": {
"email_subject": "Payment reminder from {entity_name}",
"email_body": "Hello,\n\nThe invoices below are overdue. Please arrange payment of {total_amount} at your earliest convenience.\n\n{invoice_list}\n\n{payment_instructions}\n\nIf you have already paid, please disregard this reminder.\n\nBest regards,",
"payment_instructions": "Please remit payment using the bank details shown on the document."
},
"tax_rules": null
},
"account_id": "acc_6595a27b5d35015c3ef0c3fd",
"metadata": {},
"country_rules": {
"max_taxes_per_item": 3,
"features": [
"us_tax_rate_lookup"
]
},
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-09-01T00:00:00.000Z"
}Example:
List all entities
GET
/entitiesRetrieve 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
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
Opaque cursor to fetch the next page of results. Reuse only with the same effective ordering. Use the value from pagination.next_cursor in the previous response.
prev_cursorstringoptional
Opaque cursor to fetch the previous page of results. Reuse only with the same effective ordering. 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
Sort by one field or provide a repeated array for multi-column ordering. Prefix a field with - for descending order. When paginating, reuse cursors only with the same effective ordering.
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"
import SpaceInvoices from '@spaceinvoices/js-sdk';
const sdk = new SpaceInvoices('YOUR_API_KEY');
const response = await sdk.entities.list({ limit: 20 });
console.log(response);Response
Returns
{
"data": [
{
"id": "ent_7595a27b5d35015c3ef0c3fe",
"name": "Orbital Systems GmbH",
"address": "Musterstraße 123",
"address_2": "Building A",
"post_code": "10115",
"city": "Berlin",
"state": null,
"country": "Germany",
"country_code": "DE",
"currency_code": "EUR",
"locale": "de-DE",
"tax_number": "DE123456789",
"tax_number_2": "12/345/67890",
"company_number": "HRB 12345",
"email": null,
"website": null,
"environment": "live",
"is_tax_subject": true,
"is_enabled": true,
"settings": {
"number_formats": {
"invoice": "{yyyy}-{nnnnn}",
"estimate": "{yyyy}-{nnnnn}",
"credit_note": "{yyyy}-{nnnnn}",
"delivery_note": "{yyyy}-{nnnnn}",
"expense": "{yyyy}-{nnnnn}"
},
"email_defaults": {
"invoice_subject": "Rechnung {document_number} von {entity_name}",
"invoice_body": "Anbei finden Sie die Rechnung {document_number}.\nFälligkeitsdatum: {document_due_date}.",
"estimate_subject": "Angebot {document_number} von {entity_name}",
"estimate_body": "Anbei finden Sie das Angebot {document_number}.\nGültig bis: {document_valid_until}.",
"credit_note_subject": "Gutschrift {document_number} von {entity_name}",
"credit_note_body": "Anbei finden Sie die Gutschrift {document_number}.",
"advance_invoice_subject": "Vorausrechnung {document_number} von {entity_name}",
"advance_invoice_body": "Anbei finden Sie die Vorausrechnung {document_number}.",
"delivery_note_subject": "Lieferschein {document_number} von {entity_name}",
"delivery_note_body": "Anbei finden Sie den Lieferschein {document_number}."
},
"default_invoice_due_days": 30,
"default_invoice_payment_terms": null,
"default_estimate_valid_days": 30,
"document_footer": "{entity_name}",
"default_document_signature": "{entity_name}",
"overdue_notifications": {
"enabled": false,
"threshold_days": [
7,
14,
30
],
"email_subject": "Zahlungserinnerung von {entity_name}",
"email_body": "Dies ist eine Erinnerung an überfällige Rechnungen von {entity_name}.\n\n{invoice_list}\n\nBitte prüfen Sie den offenen Betrag und veranlassen Sie die Zahlung."
},
"payment_reminders": {
"email_subject": "Zahlungserinnerung von {entity_name}",
"email_body": "Dies ist eine Erinnerung an überfällige Rechnungen von {entity_name}.\n\n{invoice_list}\n\nBitte prüfen Sie den offenen Betrag und veranlassen Sie die Zahlung.",
"payment_instructions": "Bitte verwenden Sie die auf dem Dokument angegebenen Bankdaten."
},
"tax_rules": {
"eu": {
"vies_validate_vat": true,
"auto_reverse_charge": false,
"auto_remove_tax_export": false,
"require_gross_prices": false
}
},
"tax_clause_defaults": {
"intra_eu_b2b": "§ 13b UStG (Reverse Charge)",
"3w_b2b": "§ 4 Nr. 1a + § 6 UStG",
"3w_b2c": "§ 4 Nr. 1a + § 6 UStG"
},
"translations": {
"default_invoice_note": {
"de-DE": "Vielen Dank fuer Ihren Auftrag."
},
"default_invoice_payment_terms": {
"de-DE": "Zahlbar innerhalb von 30 Tagen."
},
"document_footer": {
"de-DE": "Orbital Systems GmbH"
},
"default_document_signature": {
"de-DE": "Orbital Systems Team"
},
"email_defaults": {
"invoice_subject": {
"de-DE": "Rechnung {document_number} von {entity_name}"
},
"invoice_body": {
"de-DE": "Anbei finden Sie die Rechnung {document_number}."
}
},
"tax_clause_defaults": {
"intra_eu_b2b": {
"de-DE": "Steuerschuldnerschaft des Leistungsempfaengers."
}
}
}
},
"account_id": "acc_6595a27b5d35015c3ef0c3fd",
"metadata": {
"industry": "Technology",
"size": "Medium"
},
"country_rules": {
"max_taxes_per_item": 1,
"features": [
"eu_tax_rules",
"tax_clause_defaults",
"tax_number_2",
"epc_qr"
]
},
"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
}
}Get entity by ID
GET
/entities/{id}Retrieve a single legal entity by its unique identifier. Returns the full entity including settings, metadata, and computed country rules.
Request
Header parameters
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})
import SpaceInvoices from '@spaceinvoices/js-sdk';
const sdk = new SpaceInvoices('YOUR_API_KEY');
const response = await sdk.entities.get("inv_6595a27b5d35015c3ef0c3fd");
console.log(response);Response
Returns
idstring
namestring
addressstringnullable
citystringnullable
countrystring
country_codestring
currency_codestringnullable
tax_numberstringnullable
emailstringnullable
metadataobjectnullable
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
Other parameters
address_2stringnullable
post_codestringnullable
statestringnullable
localestring
timezonestring
tax_number_2stringnullable
company_numberstringnullable
phonestringnullable
websitestringnullable
fiscal_region_codestringnullable
starting_capitalnumbernullable
account_idstring
environmentstring
is_tax_subjectboolean
is_enabledboolean
created_atstring<date-time>
updated_atstring<date-time>
{
"id": "ent_7595a27b5d35015c3ef0c3fe",
"name": "Orbital Systems GmbH",
"address": "Musterstraße 123",
"address_2": "Building A",
"post_code": "10115",
"city": "Berlin",
"state": null,
"country": "Germany",
"country_code": "DE",
"currency_code": "EUR",
"locale": "de-DE",
"tax_number": "DE123456789",
"tax_number_2": "12/345/67890",
"company_number": "HRB 12345",
"email": null,
"website": null,
"environment": "live",
"is_tax_subject": true,
"is_enabled": true,
"settings": {
"number_formats": {
"invoice": "{yyyy}-{nnnnn}",
"estimate": "{yyyy}-{nnnnn}",
"credit_note": "{yyyy}-{nnnnn}",
"delivery_note": "{yyyy}-{nnnnn}",
"expense": "{yyyy}-{nnnnn}"
},
"email_defaults": {
"invoice_subject": "Rechnung {document_number} von {entity_name}",
"invoice_body": "Anbei finden Sie die Rechnung {document_number}.\nFälligkeitsdatum: {document_due_date}.",
"estimate_subject": "Angebot {document_number} von {entity_name}",
"estimate_body": "Anbei finden Sie das Angebot {document_number}.\nGültig bis: {document_valid_until}.",
"credit_note_subject": "Gutschrift {document_number} von {entity_name}",
"credit_note_body": "Anbei finden Sie die Gutschrift {document_number}.",
"advance_invoice_subject": "Vorausrechnung {document_number} von {entity_name}",
"advance_invoice_body": "Anbei finden Sie die Vorausrechnung {document_number}.",
"delivery_note_subject": "Lieferschein {document_number} von {entity_name}",
"delivery_note_body": "Anbei finden Sie den Lieferschein {document_number}."
},
"default_invoice_due_days": 30,
"default_invoice_payment_terms": null,
"default_estimate_valid_days": 30,
"document_footer": "{entity_name}",
"default_document_signature": "{entity_name}",
"overdue_notifications": {
"enabled": false,
"threshold_days": [
7,
14,
30
],
"email_subject": "Zahlungserinnerung von {entity_name}",
"email_body": "Dies ist eine Erinnerung an überfällige Rechnungen von {entity_name}.\n\n{invoice_list}\n\nBitte prüfen Sie den offenen Betrag und veranlassen Sie die Zahlung."
},
"payment_reminders": {
"email_subject": "Zahlungserinnerung von {entity_name}",
"email_body": "Dies ist eine Erinnerung an überfällige Rechnungen von {entity_name}.\n\n{invoice_list}\n\nBitte prüfen Sie den offenen Betrag und veranlassen Sie die Zahlung.",
"payment_instructions": "Bitte verwenden Sie die auf dem Dokument angegebenen Bankdaten."
},
"tax_rules": {
"eu": {
"vies_validate_vat": true,
"auto_reverse_charge": false,
"auto_remove_tax_export": false,
"require_gross_prices": false
}
},
"tax_clause_defaults": {
"intra_eu_b2b": "§ 13b UStG (Reverse Charge)",
"3w_b2b": "§ 4 Nr. 1a + § 6 UStG",
"3w_b2c": "§ 4 Nr. 1a + § 6 UStG"
},
"translations": {
"default_invoice_note": {
"de-DE": "Vielen Dank fuer Ihren Auftrag."
},
"default_invoice_payment_terms": {
"de-DE": "Zahlbar innerhalb von 30 Tagen."
},
"document_footer": {
"de-DE": "Orbital Systems GmbH"
},
"default_document_signature": {
"de-DE": "Orbital Systems Team"
},
"email_defaults": {
"invoice_subject": {
"de-DE": "Rechnung {document_number} von {entity_name}"
},
"invoice_body": {
"de-DE": "Anbei finden Sie die Rechnung {document_number}."
}
},
"tax_clause_defaults": {
"intra_eu_b2b": {
"de-DE": "Steuerschuldnerschaft des Leistungsempfaengers."
}
}
}
},
"account_id": "acc_6595a27b5d35015c3ef0c3fd",
"metadata": {
"industry": "Technology",
"size": "Medium"
},
"country_rules": {
"max_taxes_per_item": 1,
"features": [
"eu_tax_rules",
"tax_clause_defaults",
"tax_number_2",
"epc_qr"
]
},
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-09-01T00:00:00.000Z"
}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. Settings are merged per top-level key: keys you omit keep their current value, so send only the keys you want to change. Two keys merge one level deeper: settings.translations merges per translation namespace, and settings.unit_number_sequence_starts merges per document type and business unit. Fiscalization and other dedicated-endpoint settings (settings.furs, settings.fina, settings.slovenia, settings.e_invoicing, settings.revenue_recognition) cannot be modified here and are silently ignored if sent — manage them via their dedicated endpoints (e.g. PUT /fiscalization/furs/settings, PUT /fiscalization/fina/settings). Note: Country and country_code cannot be changed after entity creation.
Request
Header parameters
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
namestringoptional
addressstringoptionalnullable
citystringoptionalnullable
currency_codestringoptionalnullable
tax_numberstringoptionalnullable
emailstringoptionalnullable
metadataobjectoptionalnullable
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
Other parameters
address_2stringoptionalnullable
post_codestringoptionalnullable
statestringoptionalnullable
localestringoptionalnullable
timezonestringoptional
tax_number_2stringoptionalnullable
company_numberstringoptionalnullable
phonestringoptionalnullable
websitestringoptionalnullable
fiscal_region_codestringoptionalnullable
starting_capitalnumberoptionalnullable
is_tax_subjectbooleanoptional
is_enabledbooleanoptional
import SpaceInvoices from '@spaceinvoices/js-sdk';
const sdk = new SpaceInvoices('YOUR_API_KEY');
const response = await sdk.entities.update("inv_6595a27b5d35015c3ef0c3fd", {
name: "Starward Equipment Co."
});
console.log(response);Example:
Response
Returns
idstring
namestring
addressstringnullable
citystringnullable
countrystring
country_codestring
currency_codestringnullable
tax_numberstringnullable
emailstringnullable
metadataobjectnullable
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
Other parameters
address_2stringnullable
post_codestringnullable
statestringnullable
localestring
timezonestring
tax_number_2stringnullable
company_numberstringnullable
phonestringnullable
websitestringnullable
fiscal_region_codestringnullable
starting_capitalnumbernullable
account_idstring
environmentstring
is_tax_subjectboolean
is_enabledboolean
created_atstring<date-time>
updated_atstring<date-time>
{
"id": "ent_6595a27b5d35015c3ef0c3fd",
"name": "Starward Equipment Co.",
"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,
"tax_number_2": null,
"company_number": null,
"email": null,
"website": null,
"environment": "live",
"is_tax_subject": true,
"is_enabled": true,
"settings": {
"number_formats": {
"invoice": "{yyyy}-{nnnnn}",
"estimate": "{yyyy}-{nnnnn}",
"credit_note": "{yyyy}-{nnnnn}",
"delivery_note": "{yyyy}-{nnnnn}",
"expense": "{yyyy}-{nnnnn}"
},
"email_defaults": {
"invoice_subject": "Invoice {document_number} from {entity_name}",
"invoice_body": "Please find invoice {document_number} attached.\nDue date: {document_due_date}.\n\n[View document]({invoice_link})",
"estimate_subject": "{document_label} {document_number} from {entity_name}",
"estimate_body": "Please find {document_label} {document_number} attached.\nValid until: {document_valid_until}.\n\n[View document]({invoice_link})",
"credit_note_subject": "Credit note {document_number} from {entity_name}",
"credit_note_body": "Please find credit note {document_number} attached.\n\n[View document]({invoice_link})",
"advance_invoice_subject": "Advance invoice {document_number} from {entity_name}",
"advance_invoice_body": "Please find advance invoice {document_number} attached.\n\n[View document]({invoice_link})",
"delivery_note_subject": "Delivery note {document_number} from {entity_name}",
"delivery_note_body": "Please find delivery note {document_number} attached.\n\n[View document]({invoice_link})"
},
"default_invoice_due_days": 30,
"default_invoice_payment_terms": null,
"default_estimate_valid_days": 30,
"document_footer": "{entity_name}",
"default_document_signature": "{entity_name}",
"overdue_notifications": {
"enabled": false,
"threshold_days": [
7,
14,
30
],
"email_subject": "Payment reminder from {entity_name}",
"email_body": "Hello,\n\nThe invoices below are overdue. Please arrange payment of {total_amount} at your earliest convenience.\n\n{invoice_list}\n\n{payment_instructions}\n\nIf you have already paid, please disregard this reminder.\n\nBest regards,"
},
"payment_reminders": {
"email_subject": "Payment reminder from {entity_name}",
"email_body": "Hello,\n\nThe invoices below are overdue. Please arrange payment of {total_amount} at your earliest convenience.\n\n{invoice_list}\n\n{payment_instructions}\n\nIf you have already paid, please disregard this reminder.\n\nBest regards,",
"payment_instructions": "Please remit payment using the bank details shown on the document."
},
"tax_rules": {
"eu": {
"vies_validate_vat": true,
"auto_reverse_charge": false,
"auto_remove_tax_export": false,
"require_gross_prices": false
}
},
"tax_clause_defaults": {
"intra_eu_b2b": "46. člen ZDDV-1",
"3w_b2b": "52. člen ZDDV-1",
"3w_b2c": "52. člen ZDDV-1"
},
"slovenia": {
"tax_residency": "resident",
"accounting_exports": {
"preferred_format": "vod_xml",
"konto_mappings": {
"receivables": "1200",
"payables": "2200",
"sales_vat_22": "26000",
"sales_vat_95": "26001",
"sales_vat_5": "26002",
"purchase_vat_recoverable_22": "16000",
"purchase_vat_recoverable_95": "16001",
"purchase_vat_recoverable_5": "16002",
"sales_revenue_22": "7600",
"sales_revenue_95": "7601",
"sales_revenue_5": "7602",
"sales_revenue_exempt": "7680",
"sales_revenue_eu_goods": "7600",
"sales_revenue_eu_services": "7601",
"sales_revenue_reverse_charge": "7600",
"sales_revenue_third_country_goods": "7600",
"sales_revenue_third_country_services": "7680",
"purchase_expense_22": "4000",
"purchase_expense_95": "4001",
"purchase_expense_5": "4002",
"purchase_expense_exempt": "4680",
"purchase_expense_eu_goods": "4000",
"purchase_expense_eu_services": "4680",
"purchase_expense_reverse_charge": "4000",
"purchase_expense_third_country_goods": "4000",
"purchase_expense_third_country_services": "4680"
}
}
}
},
"account_id": "acc_6595a27b5d35015c3ef0c3fd",
"metadata": {},
"country_rules": {
"max_taxes_per_item": 1,
"features": [
"eu_tax_rules",
"tax_clause_defaults",
"epc_qr",
"furs",
"eslog",
"upn_qr",
"kir_report",
"si_yearly_tax_report"
]
},
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-09-01T00:00:00.000Z"
}Example:
Enable an entity
POST
/entities/{id}/enableRe-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
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})
import SpaceInvoices from '@spaceinvoices/js-sdk';
const sdk = new SpaceInvoices('YOUR_API_KEY');
const response = await sdk.entities.enableEntity("inv_6595a27b5d35015c3ef0c3fd");
console.log(response);Response
Returns
idstring
namestring
addressstringnullable
citystringnullable
countrystring
country_codestring
currency_codestringnullable
tax_numberstringnullable
emailstringnullable
metadataobjectnullable
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
Other parameters
address_2stringnullable
post_codestringnullable
statestringnullable
localestring
timezonestring
tax_number_2stringnullable
company_numberstringnullable
phonestringnullable
websitestringnullable
fiscal_region_codestringnullable
starting_capitalnumbernullable
account_idstring
environmentstring
is_tax_subjectboolean
is_enabledboolean
created_atstring<date-time>
updated_atstring<date-time>
{
"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",
"timezone": "string",
"tax_number": "string",
"tax_number_2": "string",
"company_number": "string",
"phone": "string",
"email": "string",
"website": "string",
"fiscal_region_code": "string",
"starting_capital": 0,
"account_id": "string",
"environment": "live",
"is_tax_subject": true,
"is_enabled": true,
"settings": {
"pdf_template": "modern",
"number_formats": {
"invoice": "string",
"estimate": "string",
"credit_note": "string",
"advance_invoice": "string",
"delivery_note": "string",
"expense": "string"
},
"unit_number_formats": {
"invoice": "string",
"estimate": "string",
"credit_note": "string",
"advance_invoice": "string",
"delivery_note": "string"
},
"number_sequence_starts": {
"invoice": 0,
"estimate": 0,
"credit_note": 0,
"advance_invoice": 0,
"delivery_note": 0
},
"unit_number_sequence_starts": {
"invoice": {},
"estimate": {},
"credit_note": {},
"advance_invoice": {},
"delivery_note": {}
},
"primary_color": "string",
"logo_scale_percent": 0,
"has_logo": true,
"has_signature": true,
"default_invoice_due_days": 0,
"default_estimate_valid_days": 0,
"email": "string",
"email_defaults": {
"invoice_subject": "string",
"invoice_body": "string",
"estimate_subject": "string",
"estimate_body": "string",
"credit_note_subject": "string",
"credit_note_body": "string",
"advance_invoice_subject": "string",
"advance_invoice_body": "string",
"delivery_note_subject": "string",
"delivery_note_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",
"default_advance_invoice_note": "string",
"default_delivery_note_note": "string",
"document_footer": "string",
"default_document_signature": "string",
"translations": {
"default_invoice_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_invoice_payment_terms": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_estimate_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_estimate_payment_terms": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_credit_note_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_credit_note_payment_terms": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_advance_invoice_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_delivery_note_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"document_footer": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_document_signature": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"email_defaults": {
"invoice_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"invoice_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"estimate_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"estimate_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"credit_note_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"credit_note_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"advance_invoice_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"advance_invoice_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"delivery_note_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"delivery_note_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
}
},
"payment_reminders": {
"email_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"email_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"payment_instructions": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
}
},
"tax_clause_defaults": {
"domestic": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"intra_eu_b2b": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"intra_eu_b2c": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"3w_b2b": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"3w_b2c": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"export": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
}
}
},
"calculation": {
"default_mode": "b2b_standard"
},
"slovenia": {
"business_form": "sp",
"income_tax_regime": "normirani",
"vat_profile": "standard",
"tax_residency": "resident",
"yearly_reporting": {
"activity_codes": [
"string"
],
"registration_number": "string",
"accounting_type": "records",
"normiranec_insurance_basis": "full_time_self_employed",
"default_withholding_tax_amount": 0,
"default_foreign_tax_credit_amount": 0
},
"accounting_exports": {
"preferred_format": "vod_xml",
"konto_mappings": {
"receivables": "string",
"payables": "string",
"sales_vat_22": "string",
"sales_vat_95": "string",
"sales_vat_5": "string",
"purchase_vat_recoverable_22": "string",
"purchase_vat_recoverable_95": "string",
"purchase_vat_recoverable_5": "string",
"sales_revenue_22": "string",
"sales_revenue_95": "string",
"sales_revenue_5": "string",
"sales_revenue_exempt": "string",
"sales_revenue_eu_goods": "string",
"sales_revenue_eu_services": "string",
"sales_revenue_reverse_charge": "string",
"sales_revenue_third_country_goods": "string",
"sales_revenue_third_country_services": "string",
"purchase_expense_22": "string",
"purchase_expense_95": "string",
"purchase_expense_5": "string",
"purchase_expense_exempt": "string",
"purchase_expense_eu_goods": "string",
"purchase_expense_eu_services": "string",
"purchase_expense_reverse_charge": "string",
"purchase_expense_third_country_goods": "string",
"purchase_expense_third_country_services": "string"
}
}
},
"furs": {
"enabled": false,
"default_skip_fiscalization": false,
"numbering_strategy": "B",
"operator_tax_number": "string",
"operator_label": "string",
"foreign_operator": true,
"environment": "test"
},
"fina": {
"enabled": false,
"operator_oib": "string",
"operator_label": "string",
"u_sust_pdv": true,
"numbering_sequence": "N",
"unified_numbering": true,
"certificate_expiry": "string"
},
"pt": {
"operator_first_name": "string",
"operator_last_name": "string",
"operator_tax_number": "string"
},
"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"
},
"payment_reminders": {
"email_subject": "string",
"email_body": "string",
"payment_instructions": "string"
},
"upn_qr": {
"enabled": true,
"display_mode": "qr_only",
"purpose_code": "string"
},
"epc_qr": {
"enabled": true
},
"hub3_qr": {
"enabled": true,
"purpose_code": "string",
"reference_model": "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,
"ujp_validation_with_eslog_enabled": true,
"xrechnung": {
"enabled": false
},
"zugferd": {
"enabled": false
},
"delivery_note_hide_prices": true,
"credit_note_negative_values": true,
"show_payment_amounts": true,
"receipt_note": "string",
"receipt_footer": "string",
"receipt_signature": "string",
"tax_clause_defaults": {
"domestic": "string",
"intra_eu_b2b": "string",
"intra_eu_b2c": "string",
"3w_b2b": "string",
"3w_b2c": "string",
"export": "string"
},
"e_invoicing": {
"enabled": false,
"auto_send": false,
"default_scheme_id": "string"
},
"revenue_recognition": {
"default_method": "off"
},
"expense_recognition": {
"default_method": "off"
}
},
"metadata": {},
"created_at": "2025-01-15T10:30:00.000Z",
"updated_at": "2025-01-15T10:30:00.000Z",
"country_rules": {
"max_taxes_per_item": 0,
"features": [
"string"
]
}
}Disable an entity
POST
/entities/{id}/disableDisable 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
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})
import SpaceInvoices from '@spaceinvoices/js-sdk';
const sdk = new SpaceInvoices('YOUR_API_KEY');
const response = await sdk.entities.disableEntity("inv_6595a27b5d35015c3ef0c3fd");
console.log(response);Response
Returns
idstring
namestring
addressstringnullable
citystringnullable
countrystring
country_codestring
currency_codestringnullable
tax_numberstringnullable
emailstringnullable
metadataobjectnullable
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
Other parameters
address_2stringnullable
post_codestringnullable
statestringnullable
localestring
timezonestring
tax_number_2stringnullable
company_numberstringnullable
phonestringnullable
websitestringnullable
fiscal_region_codestringnullable
starting_capitalnumbernullable
account_idstring
environmentstring
is_tax_subjectboolean
is_enabledboolean
created_atstring<date-time>
updated_atstring<date-time>
{
"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",
"timezone": "string",
"tax_number": "string",
"tax_number_2": "string",
"company_number": "string",
"phone": "string",
"email": "string",
"website": "string",
"fiscal_region_code": "string",
"starting_capital": 0,
"account_id": "string",
"environment": "live",
"is_tax_subject": true,
"is_enabled": true,
"settings": {
"pdf_template": "modern",
"number_formats": {
"invoice": "string",
"estimate": "string",
"credit_note": "string",
"advance_invoice": "string",
"delivery_note": "string",
"expense": "string"
},
"unit_number_formats": {
"invoice": "string",
"estimate": "string",
"credit_note": "string",
"advance_invoice": "string",
"delivery_note": "string"
},
"number_sequence_starts": {
"invoice": 0,
"estimate": 0,
"credit_note": 0,
"advance_invoice": 0,
"delivery_note": 0
},
"unit_number_sequence_starts": {
"invoice": {},
"estimate": {},
"credit_note": {},
"advance_invoice": {},
"delivery_note": {}
},
"primary_color": "string",
"logo_scale_percent": 0,
"has_logo": true,
"has_signature": true,
"default_invoice_due_days": 0,
"default_estimate_valid_days": 0,
"email": "string",
"email_defaults": {
"invoice_subject": "string",
"invoice_body": "string",
"estimate_subject": "string",
"estimate_body": "string",
"credit_note_subject": "string",
"credit_note_body": "string",
"advance_invoice_subject": "string",
"advance_invoice_body": "string",
"delivery_note_subject": "string",
"delivery_note_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",
"default_advance_invoice_note": "string",
"default_delivery_note_note": "string",
"document_footer": "string",
"default_document_signature": "string",
"translations": {
"default_invoice_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_invoice_payment_terms": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_estimate_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_estimate_payment_terms": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_credit_note_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_credit_note_payment_terms": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_advance_invoice_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_delivery_note_note": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"document_footer": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"default_document_signature": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"email_defaults": {
"invoice_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"invoice_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"estimate_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"estimate_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"credit_note_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"credit_note_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"advance_invoice_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"advance_invoice_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"delivery_note_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"delivery_note_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
}
},
"payment_reminders": {
"email_subject": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"email_body": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"payment_instructions": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
}
},
"tax_clause_defaults": {
"domestic": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"intra_eu_b2b": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"intra_eu_b2c": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"3w_b2b": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"3w_b2c": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
},
"export": {
"en-US": "string",
"de-DE": "string",
"it-IT": "string",
"fr-FR": "string",
"es-ES": "string",
"sl-SI": "string",
"pt-PT": "string",
"nl-NL": "string",
"pl-PL": "string",
"hr-HR": "string",
"sv-SE": "string",
"fi-FI": "string",
"et-EE": "string",
"bg-BG": "string",
"cs-CZ": "string",
"sk-SK": "string",
"nb-NO": "string",
"is-IS": "string"
}
}
},
"calculation": {
"default_mode": "b2b_standard"
},
"slovenia": {
"business_form": "sp",
"income_tax_regime": "normirani",
"vat_profile": "standard",
"tax_residency": "resident",
"yearly_reporting": {
"activity_codes": [
"string"
],
"registration_number": "string",
"accounting_type": "records",
"normiranec_insurance_basis": "full_time_self_employed",
"default_withholding_tax_amount": 0,
"default_foreign_tax_credit_amount": 0
},
"accounting_exports": {
"preferred_format": "vod_xml",
"konto_mappings": {
"receivables": "string",
"payables": "string",
"sales_vat_22": "string",
"sales_vat_95": "string",
"sales_vat_5": "string",
"purchase_vat_recoverable_22": "string",
"purchase_vat_recoverable_95": "string",
"purchase_vat_recoverable_5": "string",
"sales_revenue_22": "string",
"sales_revenue_95": "string",
"sales_revenue_5": "string",
"sales_revenue_exempt": "string",
"sales_revenue_eu_goods": "string",
"sales_revenue_eu_services": "string",
"sales_revenue_reverse_charge": "string",
"sales_revenue_third_country_goods": "string",
"sales_revenue_third_country_services": "string",
"purchase_expense_22": "string",
"purchase_expense_95": "string",
"purchase_expense_5": "string",
"purchase_expense_exempt": "string",
"purchase_expense_eu_goods": "string",
"purchase_expense_eu_services": "string",
"purchase_expense_reverse_charge": "string",
"purchase_expense_third_country_goods": "string",
"purchase_expense_third_country_services": "string"
}
}
},
"furs": {
"enabled": false,
"default_skip_fiscalization": false,
"numbering_strategy": "B",
"operator_tax_number": "string",
"operator_label": "string",
"foreign_operator": true,
"environment": "test"
},
"fina": {
"enabled": false,
"operator_oib": "string",
"operator_label": "string",
"u_sust_pdv": true,
"numbering_sequence": "N",
"unified_numbering": true,
"certificate_expiry": "string"
},
"pt": {
"operator_first_name": "string",
"operator_last_name": "string",
"operator_tax_number": "string"
},
"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"
},
"payment_reminders": {
"email_subject": "string",
"email_body": "string",
"payment_instructions": "string"
},
"upn_qr": {
"enabled": true,
"display_mode": "qr_only",
"purpose_code": "string"
},
"epc_qr": {
"enabled": true
},
"hub3_qr": {
"enabled": true,
"purpose_code": "string",
"reference_model": "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,
"ujp_validation_with_eslog_enabled": true,
"xrechnung": {
"enabled": false
},
"zugferd": {
"enabled": false
},
"delivery_note_hide_prices": true,
"credit_note_negative_values": true,
"show_payment_amounts": true,
"receipt_note": "string",
"receipt_footer": "string",
"receipt_signature": "string",
"tax_clause_defaults": {
"domestic": "string",
"intra_eu_b2b": "string",
"intra_eu_b2c": "string",
"3w_b2b": "string",
"3w_b2c": "string",
"export": "string"
},
"e_invoicing": {
"enabled": false,
"auto_send": false,
"default_scheme_id": "string"
},
"revenue_recognition": {
"default_method": "off"
},
"expense_recognition": {
"default_method": "off"
}
},
"metadata": {},
"created_at": "2025-01-15T10:30:00.000Z",
"updated_at": "2025-01-15T10:30:00.000Z",
"country_rules": {
"max_taxes_per_item": 0,
"features": [
"string"
]
}
}