Delivery Notes

Delivery note management operations.
Create, retrieve, and list delivery notes with flexible querying.
Delivery notes are shipping/packing documents issued by Entities to Customers and contain line items.
Supports hide_prices mode for packing list output.

The Delivery Note object

object

Attributes

idstring

Other attributes

numberstring

is_draftboolean

datestring<date-time>

issuerobject

customer_idstring

customerobject

notestring

payment_termsstring

tax_clausestring

footerstring

signaturestring

totalnumber

total_with_taxnumber

total_discountnumber

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

referencestring

viesobject

deleted_atstring<date-time>

created_atstring<date-time>

updated_atstring<date-time>

hide_pricesboolean

date_duestring

date_servicestring

date_service_tostring

itemsarray of objects

document_relationsarray of objects

Examplejson

{
  "id": "dn_6595a27b5d35015c3ef0c402",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "DOC-2025-001",
  "date": "2025-03-15T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "Starward Equipment Co.",
    "address": "1 Launchpad Way",
    "city": "Cape Canaveral",
    "state": "FL",
    "post_code": "32920",
    "country": "USA",
    "country_code": "US",
    "tax_number": "59-8765432"
  },
  "customer_id": "cus_6595a27b5d35015c3ef0c403",
  "customer": {
    "name": "Horizon Launch Systems Inc.",
    "address": "100 Rocket Row",
    "city": "Houston",
    "state": "TX",
    "post_code": "77058",
    "country": "USA",
    "country_code": "US",
    "tax_number": "74-1234567"
  },
  "items": [
    {
      "id": "dn_item_6595a27b5d35015c3ef0c402",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
      "item_id": null,
      "name": "Ground Station Antenna Array",
      "description": "Deep space tracking antenna with 12m dish",
      "quantity": 2,
      "price": 12500,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "type": null,
      "unit": null,
      "total": 25000,
      "total_with_tax": 30500,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "project_code": "MSN-2025-001",
        "department": "Ground Operations"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    },
    {
      "id": "dn_item_6595a27b5d35015c3ef0c403",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
      "item_id": null,
      "name": "Orbital Navigation License",
      "description": "Annual software license for orbital trajectory planning",
      "quantity": 1,
      "price": 5000,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "type": null,
      "unit": null,
      "total": 5000,
      "total_with_tax": 6100,
      "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 order. Equipment ships within 5 business days.",
  "reference": "PO-2025-001",
  "total": 30000,
  "total_with_tax": 36600,
  "total_discount": 0,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "base": 30000,
      "rate": 22,
      "amount": 6600,
      "reverse_charge": false,
      "tax_id": null
    }
  ],
  "date_year": 2025,
  "metadata": {
    "project_id": "MSN-2025-001",
    "contract_id": "ORB-2024-789"
  },
  "created_at": "2025-03-15T00:00:00.000Z",
  "updated_at": "2025-03-15T00:00:00.000Z",
  "voided_at": null,
  "deleted_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "signature": "{entity_name}",
  "payment_terms": null,
  "hide_prices": false
}

Create a new delivery note

POST/delivery-notes

Create a new delivery note with line items.
Customer is optional - can be omitted or added inline without referencing a customer_id.
The delivery note number is auto-generated based on the entity's number format settings.
Taxes are calculated automatically based on the tax rates provided.
Set hide_prices=true to create a packing list without prices.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Body parameters

itemsarray of objectsrequired

Line items for the delivery note. At least one item is required.

Other parameters

is_draftbooleanoptional

datestringoptional

issuerobjectoptional

customer_idstringoptional

customerobjectoptional

notestringoptional

payment_termsstringoptional

tax_clausestringoptional

footerstringoptional

signaturestringoptional

currency_codestringoptional

metadataobjectoptional

referencestringoptional

hide_pricesbooleanoptional

date_duestringoptional

date_servicestringoptional

date_service_tostringoptional

eslogobjectoptional

linked_documentsarray of stringsoptional

expected_total_with_taxnumberoptional

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

Example:

Response

Returns

idstring

Other parameters

numberstring

is_draftboolean

datestring<date-time>

issuerobject

customer_idstring

customerobject

notestring

payment_termsstring

tax_clausestring

footerstring

signaturestring

totalnumber

total_with_taxnumber

total_discountnumber

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

referencestring

viesobject

deleted_atstring<date-time>

created_atstring<date-time>

updated_atstring<date-time>

hide_pricesboolean

date_duestring

date_servicestring

date_service_tostring

itemsarray of objects

document_relationsarray of objects

json

{
  "id": "dn_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "2026-00001",
  "date": "2026-01-01T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "Starward Equipment Co.",
    "country": "United States",
    "country_code": "US"
  },
  "customer_id": null,
  "customer": null,
  "items": [
    {
      "id": "dn_item_6595a27b5d35015c3ef0c3fd",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c3fd",
      "item_id": null,
      "name": "Satellite Communication Module",
      "description": null,
      "quantity": 1,
      "price": 1500,
      "gross_price": null,
      "taxes": [],
      "discounts": [],
      "type": null,
      "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,
  "reference": null,
  "total": 1500,
  "total_with_tax": 1500,
  "total_discount": 0,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "rate": null,
      "tax_id": null,
      "base": 1500,
      "amount": 0,
      "reverse_charge": false
    }
  ],
  "date_year": 2026,
  "metadata": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "voided_at": null,
  "deleted_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "signature": "{entity_name}",
  "payment_terms": null,
  "hide_prices": false
}

Example:

Create delivery note with pre-calculated totals

POST/delivery-notes/custom

Create a delivery note with pre-calculated totals from an external system.
The caller provides total, total_with_tax, and taxes at the document level, and total/total_with_tax on each line item.
All other logic (numbering, customer handling, lifecycle hooks) is identical to the standard create endpoint.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Body parameters

totalnumberrequired

Pre-calculated document total (before tax).

total_with_taxnumberrequired

Pre-calculated document total (after tax).

itemsarray of objectsrequired

Line items with pre-calculated totals. At least one item is required.

Other parameters

is_draftbooleanoptional

datestringoptional

issuerobjectoptional

customer_idstringoptional

customerobjectoptional

notestringoptional

payment_termsstringoptional

tax_clausestringoptional

footerstringoptional

signaturestringoptional

total_discountnumberoptional

taxesarray of objectsoptional

currency_codestringoptional

metadataobjectoptional

referencestringoptional

hide_pricesbooleanoptional

date_duestringoptional

date_servicestringoptional

date_service_tostringoptional

linked_documentsarray of stringsoptional

eslogobjectoptional

curl -X POST "https://eu.spaceinvoices.com/delivery-notes/custom" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "total": 5000,
    "total_with_tax": 6100,
    "taxes": [
      {
        "rate": 22,
        "base": 5000,
        "amount": 1100
      }
    ],
    "items": [
      {
        "name": "Website Redesign",
        "quantity": 1,
        "price": 5000,
        "total": 5000,
        "total_with_tax": 6100,
        "taxes": [
          {
            "rate": 22
          }
        ]
      }
    ]
  }'

Response

Returns

idstring

Other parameters

numberstring

is_draftboolean

datestring<date-time>

issuerobject

customer_idstring

customerobject

notestring

payment_termsstring

tax_clausestring

footerstring

signaturestring

totalnumber

total_with_taxnumber

total_discountnumber

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

referencestring

viesobject

deleted_atstring<date-time>

created_atstring<date-time>

updated_atstring<date-time>

hide_pricesboolean

date_duestring

date_servicestring

date_service_tostring

itemsarray of objects

document_relationsarray of objects

json

{
  "id": "dn_6595a27b5d35015c3ef0c3fd",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "2026-00001",
  "date": "2026-01-01T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "Starward Equipment Co.",
    "country": "United States",
    "country_code": "US"
  },
  "customer_id": null,
  "customer": null,
  "items": [
    {
      "id": "dn_item_6595a27b5d35015c3ef0c3fd",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c3fd",
      "item_id": null,
      "name": "Satellite Communication Module",
      "description": null,
      "quantity": 1,
      "price": 1500,
      "gross_price": null,
      "taxes": [],
      "discounts": [],
      "type": null,
      "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,
  "reference": null,
  "total": 1500,
  "total_with_tax": 1500,
  "total_discount": 0,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "rate": null,
      "tax_id": null,
      "base": 1500,
      "amount": 0,
      "reverse_charge": false
    }
  ],
  "date_year": 2026,
  "metadata": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "voided_at": null,
  "deleted_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "signature": "{entity_name}",
  "payment_terms": null,
  "hide_prices": false
}

Example:

List all delivery notes

GET/delivery-notes

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

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

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, document_relations.relation_type, document_relations.target_type, 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

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.

Available relations:
- document_relations - Linked documents (invoices, etc.)

Usage:
?include=document_relations

deletedbooleanoptional

When true, returns only soft-deleted (trashed) items. Default false excludes deleted items.

curl "https://eu.spaceinvoices.com/delivery-notes" \
  -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": "dn_6595a27b5d35015c3ef0c402",
      "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
      "number": "DOC-2025-001",
      "date": "2025-03-15T00:00:00.000Z",
      "currency_code": "USD",
      "issuer": {
        "name": "Starward Equipment Co.",
        "address": "1 Launchpad Way",
        "city": "Cape Canaveral",
        "state": "FL",
        "post_code": "32920",
        "country": "USA",
        "country_code": "US",
        "tax_number": "59-8765432"
      },
      "customer_id": "cus_6595a27b5d35015c3ef0c403",
      "customer": {
        "name": "Horizon Launch Systems Inc.",
        "address": "100 Rocket Row",
        "city": "Houston",
        "state": "TX",
        "post_code": "77058",
        "country": "USA",
        "country_code": "US",
        "tax_number": "74-1234567"
      },
      "items": [
        {
          "id": "dn_item_6595a27b5d35015c3ef0c402",
          "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
          "item_id": null,
          "name": "Ground Station Antenna Array",
          "description": "Deep space tracking antenna with 12m dish",
          "quantity": 2,
          "price": 12500,
          "gross_price": null,
          "taxes": [
            {
              "rate": 22,
              "tax_id": "tax_6595a27b5d35015c3ef0c402"
            }
          ],
          "discounts": [],
          "type": null,
          "unit": null,
          "total": 25000,
          "total_with_tax": 30500,
          "total_converted": null,
          "total_with_tax_converted": null,
          "metadata": {
            "project_code": "MSN-2025-001",
            "department": "Ground Operations"
          },
          "created_at": "2025-03-15T00:00:00.000Z",
          "updated_at": "2025-03-15T00:00:00.000Z"
        },
        {
          "id": "dn_item_6595a27b5d35015c3ef0c403",
          "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
          "item_id": null,
          "name": "Orbital Navigation License",
          "description": "Annual software license for orbital trajectory planning",
          "quantity": 1,
          "price": 5000,
          "gross_price": null,
          "taxes": [
            {
              "rate": 22,
              "tax_id": "tax_6595a27b5d35015c3ef0c402"
            }
          ],
          "discounts": [],
          "type": null,
          "unit": null,
          "total": 5000,
          "total_with_tax": 6100,
          "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 order. Equipment ships within 5 business days.",
      "reference": "PO-2025-001",
      "total": 30000,
      "total_with_tax": 36600,
      "total_discount": 0,
      "total_converted": null,
      "total_with_tax_converted": null,
      "shareable_id": null,
      "taxes": [
        {
          "base": 30000,
          "rate": 22,
          "amount": 6600,
          "reverse_charge": false,
          "tax_id": null
        }
      ],
      "date_year": 2025,
      "metadata": {
        "project_id": "MSN-2025-001",
        "contract_id": "ORB-2024-789"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z",
      "voided_at": null,
      "deleted_at": null,
      "exchange_rate": null,
      "rounding_correction": null,
      "transaction_type": "domestic",
      "vies": null,
      "tax_clause": null,
      "signature": "{entity_name}",
      "payment_terms": null,
      "hide_prices": false
    }
  ],
  "pagination": {
    "total": 1,
    "next_cursor": null,
    "prev_cursor": null,
    "has_more": false
  }
}

Get delivery note by ID

GET/delivery-notes/{id}

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

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

Query parameters

includestringoptional

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

Available relations:
- document_relations - Linked documents (invoices, etc.)

Usage:
?include=document_relations

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

Response

Returns

idstring

Other parameters

numberstring

is_draftboolean

datestring<date-time>

issuerobject

customer_idstring

customerobject

notestring

payment_termsstring

tax_clausestring

footerstring

signaturestring

totalnumber

total_with_taxnumber

total_discountnumber

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

referencestring

viesobject

deleted_atstring<date-time>

created_atstring<date-time>

updated_atstring<date-time>

hide_pricesboolean

date_duestring

date_servicestring

date_service_tostring

itemsarray of objects

document_relationsarray of objects

json

{
  "id": "dn_6595a27b5d35015c3ef0c402",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "DOC-2025-001",
  "date": "2025-03-15T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "Starward Equipment Co.",
    "address": "1 Launchpad Way",
    "city": "Cape Canaveral",
    "state": "FL",
    "post_code": "32920",
    "country": "USA",
    "country_code": "US",
    "tax_number": "59-8765432"
  },
  "customer_id": "cus_6595a27b5d35015c3ef0c403",
  "customer": {
    "name": "Horizon Launch Systems Inc.",
    "address": "100 Rocket Row",
    "city": "Houston",
    "state": "TX",
    "post_code": "77058",
    "country": "USA",
    "country_code": "US",
    "tax_number": "74-1234567"
  },
  "items": [
    {
      "id": "dn_item_6595a27b5d35015c3ef0c402",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
      "item_id": null,
      "name": "Ground Station Antenna Array",
      "description": "Deep space tracking antenna with 12m dish",
      "quantity": 2,
      "price": 12500,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "type": null,
      "unit": null,
      "total": 25000,
      "total_with_tax": 30500,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "project_code": "MSN-2025-001",
        "department": "Ground Operations"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    },
    {
      "id": "dn_item_6595a27b5d35015c3ef0c403",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
      "item_id": null,
      "name": "Orbital Navigation License",
      "description": "Annual software license for orbital trajectory planning",
      "quantity": 1,
      "price": 5000,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "type": null,
      "unit": null,
      "total": 5000,
      "total_with_tax": 6100,
      "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 order. Equipment ships within 5 business days.",
  "reference": "PO-2025-001",
  "total": 30000,
  "total_with_tax": 36600,
  "total_discount": 0,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "base": 30000,
      "rate": 22,
      "amount": 6600,
      "reverse_charge": false,
      "tax_id": null
    }
  ],
  "date_year": 2025,
  "metadata": {
    "project_id": "MSN-2025-001",
    "contract_id": "ORB-2024-789"
  },
  "created_at": "2025-03-15T00:00:00.000Z",
  "updated_at": "2025-03-15T00:00:00.000Z",
  "voided_at": null,
  "deleted_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "signature": "{entity_name}",
  "payment_terms": null,
  "hide_prices": false
}

Update a delivery note

PATCH/delivery-notes/{id}

Update an existing delivery note.
Creates a version snapshot before applying changes.
Cannot update voided delivery notes.
If items are provided, they replace all existing items.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

Body parameters

datestringoptional

issuerobjectoptional

customer_idstringoptional

customerobjectoptional

itemsarray of objectsoptional

notestringoptional

payment_termsstringoptional

signaturestringoptional

currency_codestringoptional

referencestringoptional

metadataobjectoptional

change_reasonstringoptional

hide_pricesbooleanoptional

linked_documentsarray of stringsoptional

curl -X PATCH "https://eu.spaceinvoices.com/delivery-notes/{id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Updated delivery instructions",
    "change_reason": "Added delivery note"
  }'

Example:

Response

Returns

idstring

Other parameters

numberstring

is_draftboolean

datestring<date-time>

issuerobject

customer_idstring

customerobject

notestring

payment_termsstring

tax_clausestring

footerstring

signaturestring

totalnumber

total_with_taxnumber

total_discountnumber

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

referencestring

viesobject

deleted_atstring<date-time>

created_atstring<date-time>

updated_atstring<date-time>

hide_pricesboolean

date_duestring

date_servicestring

date_service_tostring

itemsarray of objects

document_relationsarray of objects

json

{
  "id": "dn_6595a27b5d35015c3ef0c402",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "DOC-2025-001",
  "date": "2025-03-15T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "Starward Equipment Co.",
    "address": "1 Launchpad Way",
    "city": "Cape Canaveral",
    "state": "FL",
    "post_code": "32920",
    "country": "USA",
    "country_code": "US",
    "tax_number": "59-8765432"
  },
  "customer_id": "cus_6595a27b5d35015c3ef0c403",
  "customer": {
    "name": "Horizon Launch Systems Inc.",
    "address": "100 Rocket Row",
    "city": "Houston",
    "state": "TX",
    "post_code": "77058",
    "country": "USA",
    "country_code": "US",
    "tax_number": "74-1234567"
  },
  "items": [
    {
      "id": "dn_item_6595a27b5d35015c3ef0c402",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
      "item_id": null,
      "name": "Ground Station Antenna Array",
      "description": "Deep space tracking antenna with 12m dish",
      "quantity": 2,
      "price": 12500,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "type": null,
      "unit": null,
      "total": 25000,
      "total_with_tax": 30500,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "project_code": "MSN-2025-001",
        "department": "Ground Operations"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    },
    {
      "id": "dn_item_6595a27b5d35015c3ef0c403",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
      "item_id": null,
      "name": "Orbital Navigation License",
      "description": "Annual software license for orbital trajectory planning",
      "quantity": 1,
      "price": 5000,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "type": null,
      "unit": null,
      "total": 5000,
      "total_with_tax": 6100,
      "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 order. Equipment ships within 5 business days.",
  "reference": "PO-2025-001",
  "total": 30000,
  "total_with_tax": 36600,
  "total_discount": 0,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "base": 30000,
      "rate": 22,
      "amount": 6600,
      "reverse_charge": false,
      "tax_id": null
    }
  ],
  "date_year": 2025,
  "metadata": {
    "project_id": "MSN-2025-001",
    "contract_id": "ORB-2024-789"
  },
  "created_at": "2025-03-15T00:00:00.000Z",
  "updated_at": "2025-03-15T00:00:00.000Z",
  "voided_at": null,
  "deleted_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "signature": "{entity_name}",
  "payment_terms": null,
  "hide_prices": false
}

Void a delivery note

POST/delivery-notes/{id}/void

Void a delivery note for technical reasons (duplicate, error, etc.). Voiding marks the delivery note as invalid and prevents further modifications.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

Body parameters

reasonstringoptional

curl -X POST "https://eu.spaceinvoices.com/delivery-notes/{id}/void" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "Duplicate delivery note created by mistake"
  }'

Response

Returns

idstring

Other parameters

numberstring

is_draftboolean

datestring<date-time>

issuerobject

customer_idstring

customerobject

notestring

payment_termsstring

tax_clausestring

footerstring

signaturestring

totalnumber

total_with_taxnumber

total_discountnumber

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

referencestring

viesobject

deleted_atstring<date-time>

created_atstring<date-time>

updated_atstring<date-time>

hide_pricesboolean

date_duestring

date_servicestring

date_service_tostring

itemsarray of objects

document_relationsarray of objects

json

{
  "id": "del_abc123",
  "voided_at": "2026-03-08T18:46:36.667Z"
}

Get delivery note version history

GET/delivery-notes/{id}/versions

Retrieve the version history for a delivery note. Each version represents the document state before an update was applied.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstring<resource-id>required

Unique resource identifier

curl "https://eu.spaceinvoices.com/delivery-notes/{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": "delivery_note",
      "document_id": "del_6595a27b5d35015c3ef0c3fd",
      "version": 2,
      "snapshot": {
        "id": "dn_6595a27b5d35015c3ef0c3fd",
        "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
        "number": "2026-00001",
        "date": "2026-01-01T00:00:00.000Z",
        "currency_code": "USD",
        "issuer": {
          "name": "Starward Equipment Co.",
          "country": "United States",
          "country_code": "US"
        },
        "customer_id": null,
        "customer": null,
        "items": [
          {
            "id": "dn_item_6595a27b5d35015c3ef0c3fd",
            "delivery_note_id": "dn_6595a27b5d35015c3ef0c3fd",
            "item_id": null,
            "name": "Satellite Communication Module",
            "description": null,
            "quantity": 1,
            "price": 1500,
            "gross_price": null,
            "taxes": [],
            "discounts": [],
            "type": null,
            "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,
        "reference": null,
        "total": 1500,
        "total_with_tax": 1500,
        "total_discount": 0,
        "total_converted": null,
        "total_with_tax_converted": null,
        "shareable_id": null,
        "taxes": [
          {
            "rate": null,
            "tax_id": null,
            "base": 1500,
            "amount": 0,
            "reverse_charge": false
          }
        ],
        "date_year": 2026,
        "metadata": {},
        "created_at": "2026-01-01T00:00:00.000Z",
        "updated_at": "2026-01-01T00:00:00.000Z",
        "voided_at": null,
        "deleted_at": null,
        "exchange_rate": null,
        "rounding_correction": null,
        "transaction_type": "domestic",
        "vies": null,
        "tax_clause": null,
        "signature": "{entity_name}",
        "payment_terms": null,
        "hide_prices": false
      },
      "changed_fields": [
        "note"
      ],
      "user": {
        "id": "usr_123",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "reason": "Updated delivery instructions",
      "created_at": "2025-01-15T10:30:00.000Z"
    },
    {
      "id": "ver_xyz789",
      "document_type": "delivery_note",
      "document_id": "del_6595a27b5d35015c3ef0c3fd",
      "version": 1,
      "snapshot": {
        "id": "dn_6595a27b5d35015c3ef0c3fd",
        "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
        "number": "2026-00001",
        "date": "2026-01-01T00:00:00.000Z",
        "currency_code": "USD",
        "issuer": {
          "name": "Starward Equipment Co.",
          "country": "United States",
          "country_code": "US"
        },
        "customer_id": null,
        "customer": null,
        "items": [
          {
            "id": "dn_item_6595a27b5d35015c3ef0c3fd",
            "delivery_note_id": "dn_6595a27b5d35015c3ef0c3fd",
            "item_id": null,
            "name": "Satellite Communication Module",
            "description": null,
            "quantity": 1,
            "price": 1500,
            "gross_price": null,
            "taxes": [],
            "discounts": [],
            "type": null,
            "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,
        "reference": null,
        "total": 1500,
        "total_with_tax": 1500,
        "total_discount": 0,
        "total_converted": null,
        "total_with_tax_converted": null,
        "shareable_id": null,
        "taxes": [
          {
            "rate": null,
            "tax_id": null,
            "base": 1500,
            "amount": 0,
            "reverse_charge": false
          }
        ],
        "date_year": 2026,
        "metadata": {},
        "created_at": "2026-01-01T00:00:00.000Z",
        "updated_at": "2026-01-01T00:00:00.000Z",
        "voided_at": null,
        "deleted_at": null,
        "exchange_rate": null,
        "rounding_correction": null,
        "transaction_type": "domestic",
        "vies": null,
        "tax_clause": null,
        "signature": "{entity_name}",
        "payment_terms": null,
        "hide_prices": false
      },
      "changed_fields": [
        "items"
      ],
      "user": {
        "id": "usr_123",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "reason": "Revised item list",
      "created_at": "2025-01-14T15:00:00.000Z"
    }
  ],
  "count": 2
}

Get specific delivery note version

GET/delivery-notes/{id}/versions/{version}

Retrieve a specific version snapshot of a delivery note.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstringrequired

Delivery Note ID

versionintegerrequired

Version number

curl "https://eu.spaceinvoices.com/delivery-notes/{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": "delivery_note",
  "document_id": "del_6595a27b5d35015c3ef0c3fd",
  "version": 1,
  "snapshot": {
    "id": "dn_6595a27b5d35015c3ef0c3fd",
    "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
    "number": "2026-00001",
    "date": "2026-01-01T00:00:00.000Z",
    "currency_code": "USD",
    "issuer": {
      "name": "Starward Equipment Co.",
      "country": "United States",
      "country_code": "US"
    },
    "customer_id": null,
    "customer": null,
    "items": [
      {
        "id": "dn_item_6595a27b5d35015c3ef0c3fd",
        "delivery_note_id": "dn_6595a27b5d35015c3ef0c3fd",
        "item_id": null,
        "name": "Satellite Communication Module",
        "description": null,
        "quantity": 1,
        "price": 1500,
        "gross_price": null,
        "taxes": [],
        "discounts": [],
        "type": null,
        "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,
    "reference": null,
    "total": 1500,
    "total_with_tax": 1500,
    "total_discount": 0,
    "total_converted": null,
    "total_with_tax_converted": null,
    "shareable_id": null,
    "taxes": [
      {
        "rate": null,
        "tax_id": null,
        "base": 1500,
        "amount": 0,
        "reverse_charge": false
      }
    ],
    "date_year": 2026,
    "metadata": {},
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "voided_at": null,
    "deleted_at": null,
    "exchange_rate": null,
    "rounding_correction": null,
    "transaction_type": "domestic",
    "vies": null,
    "tax_clause": null,
    "signature": "{entity_name}",
    "payment_terms": null,
    "hide_prices": false
  },
  "changed_fields": [
    "items"
  ],
  "user": {
    "id": "usr_123",
    "name": "John Doe",
    "email": "john@example.com"
  },
  "reason": "Revised item list",
  "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. Auto-selected when only one entity exists, required when multiple entities exist.

Query parameters

typestringrequired

Document type

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

business_premise_namestringoptional

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

electronic_device_namestringoptional

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"

Response

Returns

numberstring

fursobject

finaobject

json

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

Render delivery note preview

POST/delivery-notes/render

Render an HTML preview of a delivery note without saving to the database. Perfect for displaying live previews in delivery note 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. Auto-selected when only one entity exists, required when multiple entities exist.

Query parameters

templatestringoptional

Document template design to use. When not specified, uses the entity's configured template.

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

localestringoptional

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.

languagestringoptional

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.

partialstringoptional

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

Possible values: "true", "false"

Default: "true"

upn_qr_enabledstringoptional

Override UPN QR enabled setting for preview

Possible values: "true", "false"

upn_qr_display_modestringoptional

Override UPN QR display mode for preview

Possible values: "qr_only", "full_slip"

epc_qr_enabledstringoptional

Override EPC QR enabled setting for preview

Possible values: "true", "false"

Body parameters

itemsarray of objectsrequired

Other parameters

is_draftbooleanoptional

datestringoptional

issuerobjectoptional

customer_idstringoptional

customerobjectoptional

notestringoptional

payment_termsstringoptional

tax_clausestringoptional

footerstringoptional

signaturestringoptional

currency_codestringoptional

metadataobjectoptional

referencestringoptional

hide_pricesbooleanoptional

date_duestringoptional

date_servicestringoptional

date_service_tostringoptional

linked_documentsarray of stringsoptional

expected_total_with_taxnumberoptional

curl -X POST "https://eu.spaceinvoices.com/delivery-notes/render" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "name": "Product Sample Kit",
        "quantity": 1,
        "price": 5000
      }
    ],
    "customer": {
      "name": "Acme Corp"
    }
  }'

Example:

Preview document calculation

POST/documents/calculate

Calculate document totals, taxes, and transaction type without creating the document. Useful for showing live totals in forms or validating data before submission.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Query parameters

typestringrequired

Document type

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

Body parameters

itemsarray of objectsrequired

Document line items to calculate. At least one item is required.

Other parameters

customerobjectoptional

customer_idstringoptional

currency_codestringoptional

datestringoptional

expected_total_with_taxnumberoptional

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
          }
        ]
      }
    ]
  }'

Response

Returns

itemsarray of objects

totalnumber

total_with_taxnumber

total_discountnumber

taxesarray of objects

transaction_typestring

currency_codestring

exchange_rateobject

total_convertednumber

total_with_tax_convertednumber

rounding_correctionnumber

viesobject

json

{
  "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
}

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. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstringrequired

Document ID

Query parameters

typestringoptional

Document type. Optional — automatically inferred from the document ID prefix.

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

Body parameters

fursobjectoptional

finaobjectoptional

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"
    }
  }'

Example:

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. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstringrequired

Document ID

Query parameters

typestringoptional

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

DELETE/documents/{id}/permanent

Permanently delete a soft-deleted document. Only documents in the trash can be permanently deleted. Only draft documents and estimates can be permanently deleted.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstringrequired

Document ID

Query parameters

typestringoptional

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"

View shareable delivery note

GET/delivery-notes/shareable/{shareableId}

Retrieve delivery note data using a shareable token. No authentication required. Returns full delivery note data for rendering.

Request

Path parameters

shareableIdstringrequired

Shareable document token

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

Response

Returns

idstring

Other parameters

numberstring

is_draftboolean

datestring<date-time>

issuerobject

customer_idstring

customerobject

notestring

payment_termsstring

tax_clausestring

footerstring

signaturestring

totalnumber

total_with_taxnumber

total_discountnumber

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

referencestring

viesobject

deleted_atstring<date-time>

created_atstring<date-time>

updated_atstring<date-time>

hide_pricesboolean

date_duestring

date_servicestring

date_service_tostring

itemsarray of objects

document_relationsarray of objects

json

{
  "id": "dn_6595a27b5d35015c3ef0c402",
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "number": "DOC-2025-001",
  "date": "2025-03-15T00:00:00.000Z",
  "currency_code": "USD",
  "issuer": {
    "name": "Starward Equipment Co.",
    "address": "1 Launchpad Way",
    "city": "Cape Canaveral",
    "state": "FL",
    "post_code": "32920",
    "country": "USA",
    "country_code": "US",
    "tax_number": "59-8765432"
  },
  "customer_id": "cus_6595a27b5d35015c3ef0c403",
  "customer": {
    "name": "Horizon Launch Systems Inc.",
    "address": "100 Rocket Row",
    "city": "Houston",
    "state": "TX",
    "post_code": "77058",
    "country": "USA",
    "country_code": "US",
    "tax_number": "74-1234567"
  },
  "items": [
    {
      "id": "dn_item_6595a27b5d35015c3ef0c402",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
      "item_id": null,
      "name": "Ground Station Antenna Array",
      "description": "Deep space tracking antenna with 12m dish",
      "quantity": 2,
      "price": 12500,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "type": null,
      "unit": null,
      "total": 25000,
      "total_with_tax": 30500,
      "total_converted": null,
      "total_with_tax_converted": null,
      "metadata": {
        "project_code": "MSN-2025-001",
        "department": "Ground Operations"
      },
      "created_at": "2025-03-15T00:00:00.000Z",
      "updated_at": "2025-03-15T00:00:00.000Z"
    },
    {
      "id": "dn_item_6595a27b5d35015c3ef0c403",
      "delivery_note_id": "dn_6595a27b5d35015c3ef0c402",
      "item_id": null,
      "name": "Orbital Navigation License",
      "description": "Annual software license for orbital trajectory planning",
      "quantity": 1,
      "price": 5000,
      "gross_price": null,
      "taxes": [
        {
          "rate": 22,
          "tax_id": "tax_6595a27b5d35015c3ef0c402"
        }
      ],
      "discounts": [],
      "type": null,
      "unit": null,
      "total": 5000,
      "total_with_tax": 6100,
      "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 order. Equipment ships within 5 business days.",
  "reference": "PO-2025-001",
  "total": 30000,
  "total_with_tax": 36600,
  "total_discount": 0,
  "total_converted": null,
  "total_with_tax_converted": null,
  "shareable_id": null,
  "taxes": [
    {
      "base": 30000,
      "rate": 22,
      "amount": 6600,
      "reverse_charge": false,
      "tax_id": null
    }
  ],
  "date_year": 2025,
  "metadata": {
    "project_id": "MSN-2025-001",
    "contract_id": "ORB-2024-789"
  },
  "created_at": "2025-03-15T00:00:00.000Z",
  "updated_at": "2025-03-15T00:00:00.000Z",
  "voided_at": null,
  "deleted_at": null,
  "exchange_rate": null,
  "rounding_correction": null,
  "transaction_type": "domestic",
  "vies": null,
  "tax_clause": null,
  "signature": "{entity_name}",
  "payment_terms": null,
  "hide_prices": false
}

Get shareable delivery note as HTML

GET/delivery-notes/shareable/{shareableId}/html

Get delivery note 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

Locale for number and date formatting (decimal separators, date order). Defaults to entity locale.

Possible values: "en-US", "de-DE", "it-IT", "fr-FR", "es-ES", "sl-SI", "pt-PT", "nl-NL", "pl-PL", "hr-HR", "sv-SE", "fi-FI", "et-EE", "bg-BG", "cs-CZ", "sk-SK", "nb-NO", "is-IS"

languagestringoptional

Language for document labels/translations. Defaults to locale value.

Possible values: "en-US", "de-DE", "it-IT", "fr-FR", "es-ES", "sl-SI", "pt-PT", "nl-NL", "pl-PL", "hr-HR", "sv-SE", "fi-FI", "et-EE", "bg-BG", "cs-CZ", "sk-SK", "nb-NO", "is-IS"

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

Download shareable delivery note as PDF

GET/delivery-notes/shareable/{shareableId}/pdf

Download delivery note 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

Locale for number and date formatting (decimal separators, date order). Defaults to entity locale.

Possible values: "en-US", "de-DE", "it-IT", "fr-FR", "es-ES", "sl-SI", "pt-PT", "nl-NL", "pl-PL", "hr-HR", "sv-SE", "fi-FI", "et-EE", "bg-BG", "cs-CZ", "sk-SK", "nb-NO", "is-IS"

languagestringoptional

Language for document labels/translations. Defaults to locale value.

Possible values: "en-US", "de-DE", "it-IT", "fr-FR", "es-ES", "sl-SI", "pt-PT", "nl-NL", "pl-PL", "hr-HR", "sv-SE", "fi-FI", "et-EE", "bg-BG", "cs-CZ", "sk-SK", "nb-NO", "is-IS"

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

Restore a deleted document

POST/documents/{id}/restore

Restore a soft-deleted document from the trash. The document will be returned to its original state.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Path parameters

idstringrequired

Document ID

Query parameters

typestringoptional

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"

Response

json

null