Advance Invoices

Advance invoice management operations. Create, retrieve, and list advance invoices. Advance invoices are issued before goods/services are delivered to collect prepayment. When linked to a final invoice, the paid amount is applied as a payment.

The Advance Invoice object

object

Attributes

idstring

Other attributes

numberstring

is_draftboolean

datestring<date-time>

issuerobject

customer_idstring

customerobject

notestring

tax_clausestring

totalnumber

total_with_taxnumber

taxesarray of objects

currency_codestring

entity_idstring

date_yearinteger

shareable_idstring

voided_atstring<date>

transaction_typestring

metadataobject

exchange_rateobject

total_convertednumber

total_with_tax_convertednumber

rounding_correctionnumber

eslogobject

viesobject

created_atstring<date-time>

updated_atstring<date-time>

date_duestring<date-time>

total_paidnumber

total_duenumber

paid_in_fullboolean

fursobject

date_servicestring

date_service_tostring

payment_termsstring

itemsarray of objects

Examplejson

{
  "id": "adv_6595a27b5d35015c3ef0c402",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "DOC-2025-001",
  "date": "2025-03-15T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "My Company Ltd",
    "address": "123 Business St",
    "city": "San Francisco",
    "state": "CA",
    "post_code": "94102",
    "country": "USA",
    "country_code": "US",
    "tax_number": "12345678"
  },
  "customer_id": "cus_6595a27b5d35015c3ef0c403",
  "customer": {
    "name": "Acme Corporation",
    "address": "456 Client Ave",
    "city": "New York",
    "state": "NY",
    "post_code": "10001",
    "country": "USA",
    "country_code": "US",
    "tax_number": "87654321"
  },
  "items": [
    {
      "id": "adv_item_6595a27b5d35015c3ef0c402",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
      "name": "Professional Services - Consulting",
      "description": "Strategic consulting services for Q1 2025",
      "quantity": 40,
      "price": 150,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "unit": null,
      "total": 6000,
      "total_with_tax": 7320,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "project_code": "PROJ-2025-001",
        "department": "Consulting"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    },
    {
      "id": "adv_item_6595a27b5d35015c3ef0c403",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
      "name": "Software License - Annual",
      "description": "Enterprise software license renewal",
      "quantity": 1,
      "price": 2500,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "unit": null,
      "total": 2500,
      "total_with_tax": 3050,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "license_type": "enterprise",
        "seats": "50"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    }
  ],
  "note": "Thank you for your business!",
  "total": 8500,
  "total_with_tax": 10370,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "base": 8500,
      "rate": 22,
      "amount": 1870,
      "reverse_charge": false
    }
  ],
  "date_year": 2025,
  "metadata": {
    "project_id": "PROJ-2025-001",
    "contract_id": "CTR-2024-789"
  },
  "created_at": "2025-03-15T00:00:00.000Z",
  "updated_at": "2025-03-15T00:00:00.000Z",
  "voided_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "date_due": "2025-04-15T00:00:00.000Z",
  "total_paid": 0,
  "total_due": 10370,
  "paid_in_full": false,
  "furs": null
}

Create a new advance invoice

POST/advance-invoices

Create a new advance invoice with line items. Advance invoices are issued before goods/services are delivered to collect prepayment. When payment is received, the advance can be linked to a final invoice to apply the prepaid amount.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Body parameters

itemsarray of objectsrequired

Line items for the advance invoice. At least one item is required.

datestringoptional

Document date in YYYY-MM-DD format

date_duestringoptional

Document due date in YYYY-MM-DD format

customer_idstringoptional

Referenced Customer ID. Required if customer is not provided.

customerobjectoptional

Customer of the advance invoice.
Both customer and customer_id are optional - advance invoices can be created without customer information.
If customer_id is provided with save_customer=true, the existing customer will be updated.
If only customer is provided, the system checks for duplicates by tax_number or name.

metadataobjectoptional

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

is_draftbooleanoptional

issuerobjectoptional

notestringoptional

tax_clausestringoptional

currency_codestringoptional

date_servicestringoptional

date_service_tostringoptional

linked_documentsarray of stringsoptional

paymentobjectoptional

fursobjectoptional

expected_total_with_taxnumberoptional

curl -X POST "https://eu.spaceinvoices.com/advance-invoices" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "name": "Professional Services",
        "quantity": 1,
        "price": 1500
      }
    ]
  }'

Example:

Response

Returns

idstring

numberstring

itemsarray of objects

datestring<date-time>

Date the advance invoice was created (ISO 8601 datetime at midnight UTC)

date_duestring<date-time>

Date the advance invoice is due (ISO 8601 datetime at midnight UTC)

customer_idstring

customerobject

Customer information

totalnumber

total_with_taxnumber

taxesarray of objects

Applied taxes summary

metadataobject

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

is_draftboolean

issuerobject

notestring

tax_clausestring

currency_codestring

entity_idstring

date_yearinteger

shareable_idstring

voided_atstring<date>

transaction_typestring

exchange_rateobject

total_convertednumber

total_with_tax_convertednumber

rounding_correctionnumber

eslogobject

viesobject

created_atstring<date-time>

updated_atstring<date-time>

total_paidnumber

total_duenumber

paid_in_fullboolean

fursobject

date_servicestring

date_service_tostring

payment_termsstring

json

{
  "id": "adv_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "2026-00001",
  "date": "2026-01-01T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "Test Entity",
    "country": "United States",
    "country_code": "US"
  },
  "customer_id": null,
  "customer": null,
  "items": [
    {
      "id": "adv_item_6595a27b5d35015c3ef0c3fd",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c3fd",
      "name": "Professional Services",
      "description": null,
      "quantity": 1,
      "price": 1500,
      "gross_price": null,
      "taxes": [],
      "discounts": [],
      "unit": null,
      "total": 1500,
      "total_with_tax": 1500,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {},
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "note": null,
  "total": 1500,
  "total_with_tax": 1500,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [],
  "date_year": 2026,
  "metadata": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "voided_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "date_due": "2026-02-01T00:00:00.000Z",
  "total_paid": 0,
  "total_due": 1500,
  "paid_in_full": false,
  "furs": null
}

Example:

List all advance invoices

GET/advance-invoices

Retrieve a paginated list of advance invoices with optional filtering and sorting. Supports cursor-based pagination, JSON querying with MongoDB-style operators, full-text search, and sorting.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

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, number, date, customer, customer.name, customer.email, customer.address, customer.city, customer.country, total, total_with_tax, items.name, items.description, payments.type, payments.date, metadata, created_at, updated_at, paid_in_full, voided_at, date_due, paid_in_full, voided_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.

includestringoptional

Comma-separated list of relations to include in the response. Allowed: payments

curl "https://eu.spaceinvoices.com/advance-invoices" \
  -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": "adv_6595a27b5d35015c3ef0c402",
      "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
      "number": "DOC-2025-001",
      "date": "2025-03-15T00:00:00.000Z",
      "currency_code": "USD",
      "issuer": {
        "name": "My Company Ltd",
        "address": "123 Business St",
        "city": "San Francisco",
        "state": "CA",
        "post_code": "94102",
        "country": "USA",
        "country_code": "US",
        "tax_number": "12345678"
      },
      "customer_id": "cus_6595a27b5d35015c3ef0c403",
      "customer": {
        "name": "Acme Corporation",
        "address": "456 Client Ave",
        "city": "New York",
        "state": "NY",
        "post_code": "10001",
        "country": "USA",
        "country_code": "US",
        "tax_number": "87654321"
      },
      "items": [
        {
          "id": "adv_item_6595a27b5d35015c3ef0c402",
          "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
          "name": "Professional Services - Consulting",
          "description": "Strategic consulting services for Q1 2025",
          "quantity": 40,
          "price": 150,
          "gross_price": null,
          "taxes": [
            {
              "rate": 22,
              "tax_id": "tax_6595a27b5d35015c3ef0c402"
            }
          ],
          "discounts": [],
          "unit": null,
          "total": 6000,
          "total_with_tax": 7320,
          "total_converted": null,
          "total_with_tax_converted": null,
          "metadata": {
            "project_code": "PROJ-2025-001",
            "department": "Consulting"
          },
          "created_at": "2025-03-15T00:00:00.000Z",
          "updated_at": "2025-03-15T00:00:00.000Z"
        },
        {
          "id": "adv_item_6595a27b5d35015c3ef0c403",
          "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
          "name": "Software License - Annual",
          "description": "Enterprise software license renewal",
          "quantity": 1,
          "price": 2500,
          "gross_price": null,
          "taxes": [
            {
              "rate": 22,
              "tax_id": "tax_6595a27b5d35015c3ef0c402"
            }
          ],
          "discounts": [],
          "unit": null,
          "total": 2500,
          "total_with_tax": 3050,
          "total_converted": null,
          "total_with_tax_converted": null,
          "metadata": {
            "license_type": "enterprise",
            "seats": "50"
          },
          "created_at": "2025-03-15T00:00:00.000Z",
          "updated_at": "2025-03-15T00:00:00.000Z"
        }
      ],
      "note": "Thank you for your business!",
      "total": 8500,
      "total_with_tax": 10370,
      "total_converted": null,
      "total_with_tax_converted": null,
      "shareable_id": null,
      "taxes": [
        {
          "base": 8500,
          "rate": 22,
          "amount": 1870,
          "reverse_charge": false
        }
      ],
      "date_year": 2025,
      "metadata": {
        "project_id": "PROJ-2025-001",
        "contract_id": "CTR-2024-789"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z",
      "voided_at": null,
      "exchange_rate": null,
      "rounding_correction": null,
      "transaction_type": "domestic",
      "vies": null,
      "tax_clause": null,
      "date_due": "2025-04-15T00:00:00.000Z",
      "total_paid": 0,
      "total_due": 10370,
      "paid_in_full": false,
      "furs": null
    }
  ],
  "pagination": {
    "total": 1,
    "next_cursor": null,
    "prev_cursor": null,
    "has_more": false
  }
}

Get advance invoice by ID

GET/advance-invoices/{id}

Retrieve a single advance invoice by its unique identifier. Returns the complete advance invoice details including all line items, customer information, and calculated totals.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstring<resource-id>required

Unique resource identifier

Query parameters

includestringoptional

Comma-separated list of relations to include in the response. Allowed: payments

curl "https://eu.spaceinvoices.com/advance-invoices/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Response

Returns

idstring

numberstring

itemsarray of objects

datestring<date-time>

Date the advance invoice was created (ISO 8601 datetime at midnight UTC)

date_duestring<date-time>

Date the advance invoice is due (ISO 8601 datetime at midnight UTC)

customer_idstring

customerobject

Customer information

totalnumber

total_with_taxnumber

taxesarray of objects

Applied taxes summary

metadataobject

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

is_draftboolean

issuerobject

notestring

tax_clausestring

currency_codestring

entity_idstring

date_yearinteger

shareable_idstring

voided_atstring<date>

transaction_typestring

exchange_rateobject

total_convertednumber

total_with_tax_convertednumber

rounding_correctionnumber

eslogobject

viesobject

created_atstring<date-time>

updated_atstring<date-time>

total_paidnumber

total_duenumber

paid_in_fullboolean

fursobject

date_servicestring

date_service_tostring

payment_termsstring

json

{
  "id": "adv_6595a27b5d35015c3ef0c402",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "DOC-2025-001",
  "date": "2025-03-15T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "My Company Ltd",
    "address": "123 Business St",
    "city": "San Francisco",
    "state": "CA",
    "post_code": "94102",
    "country": "USA",
    "country_code": "US",
    "tax_number": "12345678"
  },
  "customer_id": "cus_6595a27b5d35015c3ef0c403",
  "customer": {
    "name": "Acme Corporation",
    "address": "456 Client Ave",
    "city": "New York",
    "state": "NY",
    "post_code": "10001",
    "country": "USA",
    "country_code": "US",
    "tax_number": "87654321"
  },
  "items": [
    {
      "id": "adv_item_6595a27b5d35015c3ef0c402",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
      "name": "Professional Services - Consulting",
      "description": "Strategic consulting services for Q1 2025",
      "quantity": 40,
      "price": 150,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "unit": null,
      "total": 6000,
      "total_with_tax": 7320,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "project_code": "PROJ-2025-001",
        "department": "Consulting"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    },
    {
      "id": "adv_item_6595a27b5d35015c3ef0c403",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
      "name": "Software License - Annual",
      "description": "Enterprise software license renewal",
      "quantity": 1,
      "price": 2500,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "unit": null,
      "total": 2500,
      "total_with_tax": 3050,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "license_type": "enterprise",
        "seats": "50"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    }
  ],
  "note": "Thank you for your business!",
  "total": 8500,
  "total_with_tax": 10370,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "base": 8500,
      "rate": 22,
      "amount": 1870,
      "reverse_charge": false
    }
  ],
  "date_year": 2025,
  "metadata": {
    "project_id": "PROJ-2025-001",
    "contract_id": "CTR-2024-789"
  },
  "created_at": "2025-03-15T00:00:00.000Z",
  "updated_at": "2025-03-15T00:00:00.000Z",
  "voided_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "date_due": "2025-04-15T00:00:00.000Z",
  "total_paid": 0,
  "total_due": 10370,
  "paid_in_full": false,
  "furs": null
}

Update an advance invoice

PATCH/advance-invoices/{id}

Update an existing advance invoice.
Creates a version snapshot before applying changes.
Cannot update voided or FURS-fiscalized advance invoices.
If items are provided, they replace all existing items.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstring<resource-id>required

Unique resource identifier

Body parameters

itemsarray of objectsoptional

Line items for the document. If provided, replaces ALL existing items. Triggers recalculation of totals.

datestringoptional

Document date (YYYY-MM-DD or ISO datetime format).

date_duestringoptional

Payment due date (YYYY-MM-DD or ISO datetime format). Set to null to clear.

customer_idstringoptional

Referenced Customer ID. Set to null to remove customer reference.

customerobjectoptional

Customer information. Set to null to remove inline customer data.

metadataobjectoptional

Custom metadata object. Set to null to clear.

Other parameters

issuerobjectoptional

notestringoptional

currency_codestringoptional

change_reasonstringoptional

linked_documentsarray of stringsoptional

curl -X PATCH "https://eu.spaceinvoices.com/advance-invoices/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Prepayment received. Thank you!",
    "change_reason": "Added confirmation note"
  }'

Example:

Response

Returns

idstring

numberstring

itemsarray of objects

datestring<date-time>

Date the advance invoice was created (ISO 8601 datetime at midnight UTC)

date_duestring<date-time>

Date the advance invoice is due (ISO 8601 datetime at midnight UTC)

customer_idstring

customerobject

Customer information

totalnumber

total_with_taxnumber

taxesarray of objects

Applied taxes summary

metadataobject

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

is_draftboolean

issuerobject

notestring

tax_clausestring

currency_codestring

entity_idstring

date_yearinteger

shareable_idstring

voided_atstring<date>

transaction_typestring

exchange_rateobject

total_convertednumber

total_with_tax_convertednumber

rounding_correctionnumber

eslogobject

viesobject

created_atstring<date-time>

updated_atstring<date-time>

total_paidnumber

total_duenumber

paid_in_fullboolean

fursobject

date_servicestring

date_service_tostring

payment_termsstring

json

{
  "id": "adv_6595a27b5d35015c3ef0c402",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "DOC-2025-001",
  "date": "2025-03-15T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "My Company Ltd",
    "address": "123 Business St",
    "city": "San Francisco",
    "state": "CA",
    "post_code": "94102",
    "country": "USA",
    "country_code": "US",
    "tax_number": "12345678"
  },
  "customer_id": "cus_6595a27b5d35015c3ef0c403",
  "customer": {
    "name": "Acme Corporation",
    "address": "456 Client Ave",
    "city": "New York",
    "state": "NY",
    "post_code": "10001",
    "country": "USA",
    "country_code": "US",
    "tax_number": "87654321"
  },
  "items": [
    {
      "id": "adv_item_6595a27b5d35015c3ef0c402",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
      "name": "Professional Services - Consulting",
      "description": "Strategic consulting services for Q1 2025",
      "quantity": 40,
      "price": 150,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "unit": null,
      "total": 6000,
      "total_with_tax": 7320,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "project_code": "PROJ-2025-001",
        "department": "Consulting"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    },
    {
      "id": "adv_item_6595a27b5d35015c3ef0c403",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
      "name": "Software License - Annual",
      "description": "Enterprise software license renewal",
      "quantity": 1,
      "price": 2500,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "unit": null,
      "total": 2500,
      "total_with_tax": 3050,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "license_type": "enterprise",
        "seats": "50"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    }
  ],
  "note": "Thank you for your business!",
  "total": 8500,
  "total_with_tax": 10370,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "base": 8500,
      "rate": 22,
      "amount": 1870,
      "reverse_charge": false
    }
  ],
  "date_year": 2025,
  "metadata": {
    "project_id": "PROJ-2025-001",
    "contract_id": "CTR-2024-789"
  },
  "created_at": "2025-03-15T00:00:00.000Z",
  "updated_at": "2025-03-15T00:00:00.000Z",
  "voided_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "date_due": "2025-04-15T00:00:00.000Z",
  "total_paid": 0,
  "total_due": 10370,
  "paid_in_full": false,
  "furs": null
}

Get advance invoice version history

GET/advance-invoices/{id}/versions

Retrieve the version history for an advance invoice. Each version represents the document state before an update was applied.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl "https://eu.spaceinvoices.com/advance-invoices/{id}/versions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Response

Returns

versionsarray of objects

countinteger

json

{
  "versions": [
    {
      "id": "ver_abc123",
      "document_type": "advance_invoice",
      "document_id": "adv_6595a27b5d35015c3ef0c3fd",
      "version": 2,
      "snapshot": {
        "id": "adv_6595a27b5d35015c3ef0c3fd",
        "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
        "number": "2026-00001",
        "date": "2026-01-01T00:00:00.000Z",
        "currency_code": "USD",
        "issuer": {
          "name": "Test Entity",
          "country": "United States",
          "country_code": "US"
        },
        "customer_id": null,
        "customer": null,
        "items": [
          {
            "id": "adv_item_6595a27b5d35015c3ef0c3fd",
            "advance_invoice_id": "adv_6595a27b5d35015c3ef0c3fd",
            "name": "Professional Services",
            "description": null,
            "quantity": 1,
            "price": 1500,
            "gross_price": null,
            "taxes": [],
            "discounts": [],
            "unit": null,
            "total": 1500,
            "total_with_tax": 1500,
            "total_converted": null,
            "total_with_tax_converted": null,
            "metadata": {},
            "created_at": "2026-01-01T00:00:00.000Z",
            "updated_at": "2026-01-01T00:00:00.000Z"
          }
        ],
        "note": null,
        "total": 1500,
        "total_with_tax": 1500,
        "total_converted": null,
        "total_with_tax_converted": null,
        "shareable_id": null,
        "taxes": [],
        "date_year": 2026,
        "metadata": {},
        "created_at": "2026-01-01T00:00:00.000Z",
        "updated_at": "2026-01-01T00:00:00.000Z",
        "voided_at": null,
        "exchange_rate": null,
        "rounding_correction": null,
        "transaction_type": "domestic",
        "vies": null,
        "tax_clause": null,
        "date_due": "2026-02-01T00:00:00.000Z",
        "total_paid": 0,
        "total_due": 1500,
        "paid_in_full": false,
        "furs": null
      },
      "changed_fields": [
        "note"
      ],
      "user": {
        "id": "usr_123",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "reason": "Added confirmation note",
      "created_at": "2025-01-15T10:30:00.000Z"
    },
    {
      "id": "ver_xyz789",
      "document_type": "advance_invoice",
      "document_id": "adv_6595a27b5d35015c3ef0c3fd",
      "version": 1,
      "snapshot": {
        "id": "adv_6595a27b5d35015c3ef0c3fd",
        "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
        "number": "2026-00001",
        "date": "2026-01-01T00:00:00.000Z",
        "currency_code": "USD",
        "issuer": {
          "name": "Test Entity",
          "country": "United States",
          "country_code": "US"
        },
        "customer_id": null,
        "customer": null,
        "items": [
          {
            "id": "adv_item_6595a27b5d35015c3ef0c3fd",
            "advance_invoice_id": "adv_6595a27b5d35015c3ef0c3fd",
            "name": "Professional Services",
            "description": null,
            "quantity": 1,
            "price": 1500,
            "gross_price": null,
            "taxes": [],
            "discounts": [],
            "unit": null,
            "total": 1500,
            "total_with_tax": 1500,
            "total_converted": null,
            "total_with_tax_converted": null,
            "metadata": {},
            "created_at": "2026-01-01T00:00:00.000Z",
            "updated_at": "2026-01-01T00:00:00.000Z"
          }
        ],
        "note": null,
        "total": 1500,
        "total_with_tax": 1500,
        "total_converted": null,
        "total_with_tax_converted": null,
        "shareable_id": null,
        "taxes": [],
        "date_year": 2026,
        "metadata": {},
        "created_at": "2026-01-01T00:00:00.000Z",
        "updated_at": "2026-01-01T00:00:00.000Z",
        "voided_at": null,
        "exchange_rate": null,
        "rounding_correction": null,
        "transaction_type": "domestic",
        "vies": null,
        "tax_clause": null,
        "date_due": "2026-02-01T00:00:00.000Z",
        "total_paid": 0,
        "total_due": 1500,
        "paid_in_full": false,
        "furs": null
      },
      "changed_fields": [
        "items"
      ],
      "user": {
        "id": "usr_123",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "reason": "Corrected prepayment breakdown",
      "created_at": "2025-01-14T15:00:00.000Z"
    }
  ],
  "count": 2
}

Get specific advance invoice version

GET/advance-invoices/{id}/versions/{version}

Retrieve a specific version snapshot of an advance invoice.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstringrequired

Advance Invoice ID

versionintegerrequired

Version number

curl "https://eu.spaceinvoices.com/advance-invoices/{id}/versions/{version}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Response

Returns

idstring

Version record ID

Other parameters

document_typestring

document_idstring

versioninteger

snapshotobject

changed_fieldsarray of strings

userobject

reasonstring

created_atstring<date-time>

json

{
  "id": "ver_abc123",
  "document_type": "advance_invoice",
  "document_id": "adv_6595a27b5d35015c3ef0c3fd",
  "version": 1,
  "snapshot": {
    "id": "adv_6595a27b5d35015c3ef0c3fd",
    "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
    "number": "2026-00001",
    "date": "2026-01-01T00:00:00.000Z",
    "currency_code": "USD",
    "issuer": {
      "name": "Test Entity",
      "country": "United States",
      "country_code": "US"
    },
    "customer_id": null,
    "customer": null,
    "items": [
      {
        "id": "adv_item_6595a27b5d35015c3ef0c3fd",
        "advance_invoice_id": "adv_6595a27b5d35015c3ef0c3fd",
        "name": "Professional Services",
        "description": null,
        "quantity": 1,
        "price": 1500,
        "gross_price": null,
        "taxes": [],
        "discounts": [],
        "unit": null,
        "total": 1500,
        "total_with_tax": 1500,
        "total_converted": null,
        "total_with_tax_converted": null,
        "metadata": {},
        "created_at": "2026-01-01T00:00:00.000Z",
        "updated_at": "2026-01-01T00:00:00.000Z"
      }
    ],
    "note": null,
    "total": 1500,
    "total_with_tax": 1500,
    "total_converted": null,
    "total_with_tax_converted": null,
    "shareable_id": null,
    "taxes": [],
    "date_year": 2026,
    "metadata": {},
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "voided_at": null,
    "exchange_rate": null,
    "rounding_correction": null,
    "transaction_type": "domestic",
    "vies": null,
    "tax_clause": null,
    "date_due": "2026-02-01T00:00:00.000Z",
    "total_paid": 0,
    "total_due": 1500,
    "paid_in_full": false,
    "furs": null
  },
  "changed_fields": [
    "items"
  ],
  "user": {
    "id": "usr_123",
    "name": "John Doe",
    "email": "john@example.com"
  },
  "reason": "Corrected prepayment breakdown",
  "created_at": "2025-01-14T15:00:00.000Z"
}

Preview next document number

GET/documents/next-number

Preview the next auto-generated document number for the specified type without incrementing the sequence. Useful for showing users what number will be assigned before creating a document.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Query parameters

typestringrequired

Document type

Possible values: "invoice", "estimate", "credit_note", "advance_invoice"

business_premise_namestringoptional

Business premise name (Slovenia FURS). If provided with electronic_device_name, returns fiscalization-format number.

electronic_device_namestringoptional

Electronic device name (Slovenia FURS). Required if business_premise_name is provided.

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

Response

Returns

numberstring

fursobject

json

{
  "number": "2026-00042",
  "furs": null
}

Render advance invoice preview

POST/advance-invoices/render

Render an HTML preview of an advance invoice without saving to the database. Perfect for displaying live previews in advance invoice creation/edit forms. Supports both partial mode (allows incomplete data for drafts) and complete mode (validates all required fields).

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Query parameters

templatestringoptional

Document template design to use

Possible values: "modern", "classic", "minimal", "fashion"

Default: "modern"

localestringoptional

partialstringoptional

Whether to treat the document as partial (allows incomplete data) or complete (validates all required fields)

Possible values: "true", "false"

Default: "true"

curl -X POST "https://eu.spaceinvoices.com/advance-invoices/render" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "name": "Prepayment - Project Setup",
        "quantity": 1,
        "price": 2500
      }
    ],
    "customer": {
      "name": "Acme Corp"
    }
  }'

Example:

Render HTML

GET/documents/{id}/html

Render a saved document by its ID as HTML. The document type is automatically detected from the ID prefix (inv_, est_, cre_, adv_). The output is styled for professional presentation and optimized for display in web applications.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstring<resource-id>required

Unique resource identifier

Query parameters

templatestringoptional

Document template design to use

Possible values: "modern", "classic", "minimal", "fashion"

Default: "modern"

localestringoptional

curl "https://eu.spaceinvoices.com/documents/{id}/html" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Render PDF

GET/documents/{id}/pdf

Render a saved document by its ID as PDF. The document type is automatically detected from the ID prefix (inv_, est_, cre_, adv_). The output is styled for professional presentation and optimized for printing. Ideal for downloads and archival.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstring<resource-id>required

Unique resource identifier

Query parameters

templatestringoptional

Document template design to use

Possible values: "modern", "classic", "minimal", "fashion"

Default: "modern"

localestringoptional

curl "https://eu.spaceinvoices.com/documents/{id}/pdf" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Finalize a draft document

POST/documents/{id}/finalize

Finalize a draft document by assigning a document number and running fiscalization (if applicable). Only draft documents can be finalized. After finalization, the document cannot be deleted.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstringrequired

Document ID

Query parameters

typestringrequired

Document type

Possible values: "invoice", "estimate", "credit_note", "advance_invoice"

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

Response

json

null

Delete a draft document

DELETE/documents/{id}

Delete a draft document. Only draft documents can be deleted. Finalized documents cannot be deleted - use void instead.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstringrequired

Document ID

Query parameters

typestringrequired

Document type

Possible values: "invoice", "estimate", "credit_note", "advance_invoice"

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

Make document shareable

POST/documents/{id}/share

Generate a shareable token for a document. Document type is automatically detected from the ID prefix (inv_, est_, cre_, adv_). If the document is already shared, returns the existing token. Can be used to re-share a document that was previously unshared.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstring<resource-id>required

Unique resource identifier

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

Response

Returns

shareable_idstring

json

{
  "shareable_id": "string"
}

Unshare document

DELETE/documents/{id}/share

Remove the shareable token from a document. The document will no longer be accessible via public link. Document type is automatically detected from the ID prefix (inv_, est_, cre_, adv_).

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl -X DELETE "https://eu.spaceinvoices.com/documents/{id}/share" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Get shareable token

GET/documents/{id}/share

Retrieve the shareable token for a document if one exists. Document type is automatically detected from the ID prefix (inv_, est_, cre_, adv_).

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl "https://eu.spaceinvoices.com/documents/{id}/share" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Response

Returns

shareable_idstring

json

{
  "shareable_id": "string"
}

View shareable advance invoice

GET/advance-invoices/shareable/{shareableId}

Retrieve advance invoice data using a shareable token. No authentication required. Returns full advance invoice data for rendering.

Request

Path parameters

shareableIdstringrequired

Shareable document token

curl "https://eu.spaceinvoices.com/advance-invoices/shareable/{shareableId}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Response

Returns

idstring

numberstring

itemsarray of objects

datestring<date-time>

Date the advance invoice was created (ISO 8601 datetime at midnight UTC)

date_duestring<date-time>

Date the advance invoice is due (ISO 8601 datetime at midnight UTC)

customer_idstring

customerobject

Customer information

totalnumber

total_with_taxnumber

taxesarray of objects

Applied taxes summary

metadataobject

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

is_draftboolean

issuerobject

notestring

tax_clausestring

currency_codestring

entity_idstring

date_yearinteger

shareable_idstring

voided_atstring<date>

transaction_typestring

exchange_rateobject

total_convertednumber

total_with_tax_convertednumber

rounding_correctionnumber

eslogobject

viesobject

created_atstring<date-time>

updated_atstring<date-time>

total_paidnumber

total_duenumber

paid_in_fullboolean

fursobject

date_servicestring

date_service_tostring

payment_termsstring

json

{
  "id": "adv_6595a27b5d35015c3ef0c402",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "DOC-2025-001",
  "date": "2025-03-15T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "My Company Ltd",
    "address": "123 Business St",
    "city": "San Francisco",
    "state": "CA",
    "post_code": "94102",
    "country": "USA",
    "country_code": "US",
    "tax_number": "12345678"
  },
  "customer_id": "cus_6595a27b5d35015c3ef0c403",
  "customer": {
    "name": "Acme Corporation",
    "address": "456 Client Ave",
    "city": "New York",
    "state": "NY",
    "post_code": "10001",
    "country": "USA",
    "country_code": "US",
    "tax_number": "87654321"
  },
  "items": [
    {
      "id": "adv_item_6595a27b5d35015c3ef0c402",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
      "name": "Professional Services - Consulting",
      "description": "Strategic consulting services for Q1 2025",
      "quantity": 40,
      "price": 150,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "unit": null,
      "total": 6000,
      "total_with_tax": 7320,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "project_code": "PROJ-2025-001",
        "department": "Consulting"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    },
    {
      "id": "adv_item_6595a27b5d35015c3ef0c403",
      "advance_invoice_id": "adv_6595a27b5d35015c3ef0c402",
      "name": "Software License - Annual",
      "description": "Enterprise software license renewal",
      "quantity": 1,
      "price": 2500,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "unit": null,
      "total": 2500,
      "total_with_tax": 3050,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "license_type": "enterprise",
        "seats": "50"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    }
  ],
  "note": "Thank you for your business!",
  "total": 8500,
  "total_with_tax": 10370,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "base": 8500,
      "rate": 22,
      "amount": 1870,
      "reverse_charge": false
    }
  ],
  "date_year": 2025,
  "metadata": {
    "project_id": "PROJ-2025-001",
    "contract_id": "CTR-2024-789"
  },
  "created_at": "2025-03-15T00:00:00.000Z",
  "updated_at": "2025-03-15T00:00:00.000Z",
  "voided_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "date_due": "2025-04-15T00:00:00.000Z",
  "total_paid": 0,
  "total_due": 10370,
  "paid_in_full": false,
  "furs": null
}

Get shareable advance invoice as HTML

GET/advance-invoices/shareable/{shareableId}/html

Get advance invoice as HTML preview using a shareable token. No authentication required. Supports multiple languages via locale query parameter.

Request

Path parameters

shareableIdstringrequired

Shareable document token

Query parameters

localestringoptional

Document language for rendering. Defaults to entity locale.

Possible values: "en-US", "de-DE", "es-ES", "fr-FR", "it-IT", "sl-SI"

curl "https://eu.spaceinvoices.com/advance-invoices/shareable/{shareableId}/html" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Download shareable advance invoice as PDF

GET/advance-invoices/shareable/{shareableId}/pdf

Download advance invoice as PDF using a shareable token. No authentication required. Supports multiple languages via locale query parameter.

Request

Path parameters

shareableIdstringrequired

Shareable document token

Query parameters

localestringoptional

Document language for rendering. Defaults to entity locale.

Possible values: "en-US", "de-DE", "es-ES", "fr-FR", "it-IT", "sl-SI"

curl "https://eu.spaceinvoices.com/advance-invoices/shareable/{shareableId}/pdf" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"