CreditNotes
CreditNotes
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 CreditNote object
Attributes
Date the credit note was created (ISO 8601 datetime at midnight UTC)
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",
"issuer": {
"name": "My Company",
"address": "123 Main St",
"city": "City",
"country": "Slovenia"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"currency_code": "EUR",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 100,
"paid_in_full": false,
"furs": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Refund for service",
"description": null,
"quantity": 1,
"price": 100,
"gross_price": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"discounts": [],
"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. Optional - defaults to the first created entity if not provided.
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": "Refund for service",
"quantity": 1,
"price": 100
}
]
}'Returns
{
"id": "cre_abc123",
"number": "CN-2025-0001",
"date": "2025-01-15T00:00:00.000Z",
"issuer": {
"name": "My Company",
"address": "123 Main St",
"city": "City",
"country": "Slovenia"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"currency_code": "EUR",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 100,
"paid_in_full": false,
"furs": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Refund for service",
"description": null,
"quantity": 1,
"price": 100,
"gross_price": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"discounts": [],
"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. Optional - defaults to the first created entity if not provided.
Query parameters
Number of results per request.
Default: 10
Cursor to fetch the next page of results. Use the value from pagination.next_cursor in the previous response.
Cursor to fetch the previous page of results. 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.
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
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. Allowed: payments
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",
"issuer": {
"name": "My Company",
"address": "123 Main St",
"city": "City",
"country": "Slovenia"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"currency_code": "EUR",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 100,
"paid_in_full": false,
"furs": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Refund for service",
"description": null,
"quantity": 1,
"price": 100,
"gross_price": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"discounts": [],
"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. Optional - defaults to the first created entity if not provided.
Path parameters
Unique resource identifier
Query parameters
Comma-separated list of relations to include in the response. Allowed: payments
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",
"issuer": {
"name": "My Company",
"address": "123 Main St",
"city": "City",
"country": "Slovenia"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"currency_code": "EUR",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 100,
"paid_in_full": false,
"furs": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Refund for service",
"description": null,
"quantity": 1,
"price": 100,
"gross_price": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"discounts": [],
"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. Optional - defaults to the first created entity if not provided.
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. Thank you!",
"change_reason": "Added confirmation note after refund"
}'Returns
{
"id": "cre_jkl012",
"number": "CN-2025-0004",
"date": "2025-01-15T00:00:00.000Z",
"issuer": {
"name": "My Company",
"address": "123 Main St",
"city": "City",
"country": "Slovenia"
},
"customer_id": null,
"customer": {
"name": "Acme Corporation",
"address": "123 Business St",
"city": "New York",
"state": "NY",
"post_code": "10001",
"country": "USA",
"tax_number": "12-3456789"
},
"note": "Credit note for returned items and service adjustment.",
"total": 376.5,
"total_with_tax": 459.33,
"taxes": [
{
"rate": 22,
"total": 82.83
}
],
"currency_code": "EUR",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 459.33,
"paid_in_full": false,
"furs": null,
"payment_terms": null,
"items": [
{
"id": "item_jkl012_1",
"name": "Product return",
"description": "Returned damaged goods",
"quantity": 3,
"price": 75.5,
"gross_price": null,
"total": 226.5,
"total_with_tax": 276.33,
"taxes": [
{
"rate": 22,
"tax_id": "tax_abc123"
}
],
"discounts": [],
"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": "Service adjustment",
"description": null,
"quantity": 1,
"price": 150,
"gross_price": null,
"total": 150,
"total_with_tax": 183,
"taxes": [
{
"rate": 22,
"tax_id": "tax_abc123"
}
],
"discounts": [],
"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"
}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. Optional - defaults to the first created entity if not provided.
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",
"issuer": {
"name": "My Company",
"address": "123 Main St",
"city": "City",
"country": "Slovenia"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"currency_code": "EUR",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 100,
"paid_in_full": false,
"furs": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Refund for service",
"description": null,
"quantity": 1,
"price": 100,
"gross_price": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"discounts": [],
"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",
"issuer": {
"name": "My Company",
"address": "123 Main St",
"city": "City",
"country": "Slovenia"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"currency_code": "EUR",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 100,
"paid_in_full": false,
"furs": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Refund for service",
"description": null,
"quantity": 1,
"price": 100,
"gross_price": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"discounts": [],
"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. Optional - defaults to the first created entity if not provided.
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",
"issuer": {
"name": "My Company",
"address": "123 Main St",
"city": "City",
"country": "Slovenia"
},
"customer_id": null,
"customer": null,
"note": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"currency_code": "EUR",
"entity_id": "ent_abc123",
"date_year": 2025,
"shareable_id": null,
"voided_at": null,
"metadata": {},
"exchange_rate": null,
"total_converted": null,
"total_with_tax_converted": null,
"total_paid": 0,
"total_due": 100,
"paid_in_full": false,
"furs": null,
"payment_terms": null,
"items": [
{
"id": "item_abc123",
"name": "Refund for service",
"description": null,
"quantity": 1,
"price": 100,
"gross_price": null,
"total": 100,
"total_with_tax": 100,
"taxes": [],
"discounts": [],
"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. Optional - defaults to the first created entity if not provided.
Query parameters
Document type
Possible values: "invoice", "estimate", "credit_note", "advance_invoice"
Business premise name (Slovenia FURS). If provided with electronic_device_name, returns fiscalization-format number.
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"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. Optional - defaults to the first created entity if not provided.
Query parameters
Document template design to use
Possible values: "modern", "classic", "minimal", "fashion"
Default: "modern"
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/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"
}
}'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. Optional - defaults to the first created entity if not provided.
Path parameters
Unique resource identifier
Query parameters
Document template design to use
Possible values: "modern", "classic", "minimal", "fashion"
Default: "modern"
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. Optional - defaults to the first created entity if not provided.
Path parameters
Unique resource identifier
Query parameters
Document template design to use
Possible values: "modern", "classic", "minimal", "fashion"
Default: "modern"
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. Optional - defaults to the first created entity if not provided.
Path parameters
Document ID
Query parameters
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"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. Optional - defaults to the first created entity if not provided.
Path parameters
Document ID
Query parameters
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"