Credit Notes
Credit Notes
Credit note management operations.
Create, retrieve, and list credit notes with flexible querying.
Credit notes are issued by Entities to Customers and contain line items with optional taxes.
Unlike invoices, credit notes do not have a due date.
The Credit Note object
Attributes
Date the credit note was created (ISO 8601 datetime at midnight UTC)
Note for the document. If not provided, defaults to entity's document-type-specific note setting. Pass empty string to explicitly set no note.
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.
{
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"date_service": null,
"date_service_to": null,
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 850,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Thermal Shielding Panel - Defective return",
"description": null,
"quantity": 1,
"price": 850,
"gross_price": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_abc123",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}Create a new credit note
/credit-notesCreate a new credit note with line items.
Customer is optional - can be omitted for retail/convenience store sales where customer information isn't needed, or added inline without referencing a customer_id.
The credit note number is auto-generated based on the entity's number format settings.
Taxes are calculated automatically based on the tax rates provided.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Body parameters
curl -X POST "https://eu.spaceinvoices.com/credit-notes" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"items": [
{
"name": "Thermal Shielding Panel - Defective return",
"quantity": 1,
"price": 850
}
]
}'Returns
{
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"date_service": null,
"date_service_to": null,
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 850,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Thermal Shielding Panel - Defective return",
"description": null,
"quantity": 1,
"price": 850,
"gross_price": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_abc123",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}Create credit note with pre-calculated totals
/credit-notes/customCreate a credit note with pre-calculated totals from an external system.
The caller provides total, total_with_tax, total_discount, and taxes at the document level, and total/total_with_tax on each line item.
When calculation_mode is omitted, Space Invoices preserves pass-through behavior and accepts the supplied totals as-is.
When calculation_mode is provided, Space Invoices validates the supplied totals against that calculation mode before creating the document.
All other logic (numbering, fiscalization, customer handling, payments, lifecycle hooks) is identical to the standard create endpoint.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Body parameters
Pre-calculated document total (before tax).
Pre-calculated document total (after tax).
curl -X POST "https://eu.spaceinvoices.com/credit-notes/custom" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"total": 850,
"total_with_tax": 1037,
"taxes": [
{
"rate": 22,
"base": 850,
"amount": 187
}
],
"items": [
{
"name": "Thermal Shielding Panel - Defective return",
"quantity": 1,
"price": 850,
"total": 850,
"total_with_tax": 1037,
"taxes": [
{
"rate": 22
}
]
}
]
}'Returns
{
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"date_service": null,
"date_service_to": null,
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 850,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Thermal Shielding Panel - Defective return",
"description": null,
"quantity": 1,
"price": 850,
"gross_price": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_abc123",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}List all credit notes
/credit-notesRetrieve a paginated list of credit notes with optional filtering and sorting.
Supports cursor-based pagination, flexible JSON querying with MongoDB-style operators, full-text search, and sorting.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Query parameters
Number of results per request.
Default: 10
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.
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.
Whether to include the total count of items in pagination.total.
Default is true.
When false, pagination.total returns -1 for better performance.
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.
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, document_relations.relation_type, document_relations.target_type, metadata, created_at, updated_at, paid_in_full, voided_at, total_paid
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
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.
Comma-separated list of relations to include in the response.
Available relations:
- payments - Payment records linked to this credit note
- document_relations - Linked documents (invoices, advance invoices, etc.)
Usage:?include=payments?include=payments,document_relations
When true, returns only soft-deleted (trashed) items. Default false excludes deleted items.
curl "https://eu.spaceinvoices.com/credit-notes" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Returns
{
"data": [
{
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"date_service": null,
"date_service_to": null,
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 850,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Thermal Shielding Panel - Defective return",
"description": null,
"quantity": 1,
"price": 850,
"gross_price": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_abc123",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"pagination": {
"total": 1,
"next_cursor": null,
"prev_cursor": null,
"has_more": false
}
}Get credit note by ID
/credit-notes/{id}Retrieve a single credit note by its unique identifier. Returns the complete credit note details including all line items, customer information, and calculated totals.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
Query parameters
Comma-separated list of relations to include in the response.
Available relations:
- payments - Payment records linked to this credit note
- document_relations - Linked documents (invoices, advance invoices, etc.)
Usage:?include=payments?include=payments,document_relations
curl "https://eu.spaceinvoices.com/credit-notes/{id}" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Returns
{
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"date_service": null,
"date_service_to": null,
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 850,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Thermal Shielding Panel - Defective return",
"description": null,
"quantity": 1,
"price": 850,
"gross_price": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_abc123",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}Update a credit note
/credit-notes/{id}Update an existing credit note.
Creates a version snapshot before applying changes.
Cannot update voided or FURS-fiscalized credit notes.
If items are provided, they replace all existing items.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
Body parameters
curl -X PATCH "https://eu.spaceinvoices.com/credit-notes/{id}" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"note": "Refund processed. Equipment returned to inventory.",
"change_reason": "Added confirmation note after refund"
}'Returns
{
"id": "cre_jkl012",
"number": "CN-2025-0004",
"date": "2025-01-15T00:00:00.000Z",
"date_service": "2025-01-01",
"date_service_to": "2025-01-15",
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": {
"name": "Horizon Launch Systems Inc.",
"address": "100 Rocket Row",
"city": "Houston",
"state": "TX",
"post_code": "77058",
"country": "USA",
"tax_number": "74-1234567"
},
"note": "Credit note for defective thermal panels and returned EVA toolkit.",
"total": 3900,
"total_with_tax": 4758,
"taxes": [
{
"rate": 22,
"total": 858
}
],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 4758,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_jkl012_1",
"name": "Thermal Shielding Panel - Manufacturing defect",
"description": "Panels failed thermal cycling test at 1400C",
"quantity": 2,
"price": 850,
"gross_price": null,
"total": 1700,
"total_with_tax": 2074,
"taxes": [
{
"rate": 22,
"tax_id": "tax_abc123"
}
],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_jkl012",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
},
{
"id": "item_jkl012_2",
"name": "EVA Toolkit - Standard return",
"description": null,
"quantity": 1,
"price": 2200,
"gross_price": null,
"total": 2200,
"total_with_tax": 2684,
"taxes": [
{
"rate": 22,
"tax_id": "tax_abc123"
}
],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_jkl012",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}Void a credit note
/credit-notes/{id}/voidVoid a credit note for technical reasons (duplicate, error, etc.). For FURS-fiscalized credit notes, automatically submits technical cancellation to FURS. All linked payments are soft-deleted, reversing their effect on invoice totals.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
Body parameters
curl -X POST "https://eu.spaceinvoices.com/credit-notes/{id}/void" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"reason": "Duplicate credit note created by mistake"
}'Returns
{
"id": "cn_abc123",
"voided_at": "2026-01-20T12:00:00.000Z"
}Get credit note version history
/credit-notes/{id}/versionsRetrieve the version history for a credit note. Each version represents the document state before an update was applied.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
curl "https://eu.spaceinvoices.com/credit-notes/{id}/versions" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Returns
{
"versions": [
{
"id": "ver_abc123",
"document_type": "credit_note",
"document_id": "cre_6595a27b5d35015c3ef0c3fd",
"version": 2,
"snapshot": {
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"date_service": null,
"date_service_to": null,
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 850,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Thermal Shielding Panel - Defective return",
"description": null,
"quantity": 1,
"price": 850,
"gross_price": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_abc123",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
},
"changed_fields": [
"note"
],
"user": {
"id": "usr_123",
"name": "John Doe",
"email": "john@example.com"
},
"reason": "Added confirmation note after refund",
"created_at": "2025-01-15T10:30:00.000Z"
},
{
"id": "ver_xyz789",
"document_type": "credit_note",
"document_id": "cre_6595a27b5d35015c3ef0c3fd",
"version": 1,
"snapshot": {
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"date_service": null,
"date_service_to": null,
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 850,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Thermal Shielding Panel - Defective return",
"description": null,
"quantity": 1,
"price": 850,
"gross_price": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_abc123",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
},
"changed_fields": [
"items"
],
"user": {
"id": "usr_123",
"name": "John Doe",
"email": "john@example.com"
},
"reason": "Corrected refund amounts",
"created_at": "2025-01-14T15:00:00.000Z"
}
],
"count": 2
}Get specific credit note version
/credit-notes/{id}/versions/{version}Retrieve a specific version snapshot of a credit note.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Credit Note ID
Version number
curl "https://eu.spaceinvoices.com/credit-notes/{id}/versions/{version}" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Returns
Version record ID
{
"id": "ver_abc123",
"document_type": "credit_note",
"document_id": "cre_6595a27b5d35015c3ef0c3fd",
"version": 1,
"snapshot": {
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"date_service": null,
"date_service_to": null,
"issuer": {
"name": "Starward Equipment Co.",
"address": "1 Launchpad Way",
"city": "Cape Canaveral",
"country": "United States"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"currency_code": "USD",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"deleted_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 850,
"paid_in_full": false,
"furs": null,
"fina": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Thermal Shielding Panel - Defective return",
"description": null,
"quantity": 1,
"price": 850,
"gross_price": null,
"total": 850,
"total_with_tax": 850,
"taxes": [],
"discounts": [],
"type": null,
"unit": null,
"credit_note_id": "cre_abc123",
"total_converted": null,
"total_with_tax_converted": null,
"metadata": {},
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
}
],
"created_at": "2025-01-15T00:00:00.000Z",
"updated_at": "2025-01-15T00:00:00.000Z"
},
"changed_fields": [
"items"
],
"user": {
"id": "usr_123",
"name": "John Doe",
"email": "john@example.com"
},
"reason": "Corrected refund amounts",
"created_at": "2025-01-14T15:00:00.000Z"
}Preview next document number
/documents/next-numberPreview 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.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Query parameters
Document type
Possible values: "invoice", "estimate", "credit_note", "advance_invoice", "delivery_note"
Business premise name (FURS or FINA). If provided with electronic_device_name, returns fiscalization-format number.
Electronic device name (FURS or FINA). Required if business_premise_name is provided. When provided, returns fiscalization-format number.
curl "https://eu.spaceinvoices.com/documents/next-number" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Returns
{
"number": "2026-00042",
"furs": null
}Render credit note preview
/credit-notes/renderRender an HTML preview of a credit note without saving to the database. Perfect for displaying live previews in credit note creation/edit forms. Supports both partial mode (allows incomplete data for drafts) and complete mode (validates all required fields).
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Query parameters
Document template design to use. When not specified, uses the entity's configured template.
Possible values: "modern", "classic", "condensed", "minimal", "fashion"
Locale for number and date formatting (decimal separators, date order). When not specified, uses the entity's configured locale. For example, 'sl-SI' formats decimals with commas (5,5%) and dates as DD. MM. YYYY.
Language for document labels and translations (e.g., 'Invoice', 'Tax', 'Total'). When not specified, uses the same value as locale. Use this to get entity-locale formatting with different-language labels — for example, a Slovenian entity (sl-SI formatting with commas) but English labels.
Whether to treat the document as partial (allows incomplete data) or complete (validates all required fields)
Possible values: "true", "false"
Default: "true"
Override UPN QR enabled setting for preview
Possible values: "true", "false"
Override UPN QR display mode for preview
Possible values: "qr_only", "full_slip"
Override EPC QR enabled setting for preview
Possible values: "true", "false"
Body parameters
curl -X POST "https://eu.spaceinvoices.com/credit-notes/render" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"items": [
{
"name": "Refund - Consulting Services",
"quantity": 1,
"price": 150
}
],
"customer": {
"name": "Acme Corp"
}
}'Preview document calculation
/documents/calculateCalculate document totals, taxes, and transaction type without creating the document. Useful for showing live totals in forms or validating data before submission.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Query parameters
Document type
Possible values: "invoice", "estimate", "credit_note", "advance_invoice", "delivery_note"
Body parameters
curl -X POST "https://eu.spaceinvoices.com/documents/calculate" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"items": [
{
"name": "Web Development",
"quantity": 10,
"price": 100,
"taxes": [
{
"rate": 22
}
]
}
]
}'Returns
{
"items": [
{
"name": "Web Development",
"description": null,
"type": null,
"price": 100,
"gross_price": null,
"quantity": 10,
"unit": null,
"taxes": [
{
"name": "VAT",
"rate": 22,
"base": 1000,
"amount": 220
}
],
"discounts": [],
"total": 1000,
"total_with_tax": 1220,
"total_converted": null,
"total_with_tax_converted": null
}
],
"total": 1000,
"total_with_tax": 1220,
"total_discount": 0,
"taxes": [
{
"name": "VAT",
"rate": 22,
"base": 1000,
"amount": 220,
"reverse_charge": false
}
],
"transaction_type": "domestic",
"currency_code": "EUR",
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"rounding_correction": null,
"vies": null
}Render HTML
/documents/{id}/htmlRender 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.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
Query parameters
Document template design to use. When not specified, uses the entity's configured template.
Possible values: "modern", "classic", "condensed", "minimal", "fashion"
Locale for number and date formatting (decimal separators, date order). When not specified, uses the entity's configured locale. For example, 'sl-SI' formats decimals with commas (5,5%) and dates as DD. MM. YYYY.
Language for document labels and translations (e.g., 'Invoice', 'Tax', 'Total'). When not specified, uses the same value as locale. Use this to get entity-locale formatting with different-language labels — for example, a Slovenian entity (sl-SI formatting with commas) but English labels.
curl "https://eu.spaceinvoices.com/documents/{id}/html" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Render PDF
/documents/{id}/pdfRender 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.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
Query parameters
Document template design to use. When not specified, uses the entity's configured template.
Possible values: "modern", "classic", "condensed", "minimal", "fashion"
Locale for number and date formatting (decimal separators, date order). When not specified, uses the entity's configured locale. For example, 'sl-SI' formats decimals with commas (5,5%) and dates as DD. MM. YYYY.
Language for document labels and translations (e.g., 'Invoice', 'Tax', 'Total'). When not specified, uses the same value as locale. Use this to get entity-locale formatting with different-language labels — for example, a Slovenian entity (sl-SI formatting with commas) but English labels.
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
/documents/{id}/finalizeFinalize 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.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Document ID
Query parameters
Document type. Optional — automatically inferred from the document ID prefix.
Possible values: "invoice", "estimate", "credit_note", "advance_invoice", "delivery_note"
Body parameters
curl -X POST "https://eu.spaceinvoices.com/documents/{id}/finalize" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"fina": {
"business_premise_name": "PP1",
"electronic_device_name": "1",
"payment_type": "card"
}
}'nullDelete a draft document
/documents/{id}Delete a draft document. Only draft documents can be deleted. Finalized documents cannot be deleted - use void instead.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Document ID
Query parameters
Document type. Optional — automatically inferred from the document ID prefix.
Possible values: "invoice", "estimate", "credit_note", "advance_invoice", "delivery_note"
curl -X DELETE "https://eu.spaceinvoices.com/documents/{id}" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Permanently delete a document
/documents/{id}/permanentPermanently delete a soft-deleted document. Only documents in the trash can be permanently deleted. Only draft documents and estimates can be permanently deleted.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Document ID
Query parameters
Document type. Optional — automatically inferred from the document ID prefix.
Possible values: "invoice", "estimate", "credit_note", "advance_invoice", "delivery_note"
curl -X DELETE "https://eu.spaceinvoices.com/documents/{id}/permanent" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Retry document fiscalization
/documents/{id}/fiscalizeManually retry fiscalization for a document that has a failed fiscalization status. Only documents with failed FURS or FINA fiscalization can be retried.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Document ID
Query parameters
Document type. Optional — automatically inferred from the document ID prefix.
Possible values: "invoice", "estimate", "credit_note", "advance_invoice", "delivery_note"
curl -X POST "https://eu.spaceinvoices.com/documents/{id}/fiscalize" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"nullRestore a deleted document
/documents/{id}/restoreRestore a soft-deleted document from the trash. The document will be returned to its original state.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Document ID
Query parameters
Document type. Optional — automatically inferred from the document ID prefix.
Possible values: "invoice", "estimate", "credit_note", "advance_invoice", "delivery_note"
curl -X POST "https://eu.spaceinvoices.com/documents/{id}/restore" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"null