API Methods

The SDK provides methods for all Space Invoices API endpoints, organized by resource.

Invoices

Method	Description
`invoices.list(options?)`	List invoices with filtering, pagination, and entity context
`invoices.get(id, params?, options?)`	Get invoice by ID
`invoices.create(body, options?)`	Create an invoice
`invoices.update(id, body, options?)`	Update an invoice
`invoices.void(id, body?, options?)`	Void an issued invoice
`invoices.renderPdf(id, params?, options?)`	Render an invoice as PDF
`documents.finalizeDocument(id, body?, options?)`	Finalize a draft document
`documents.delete(id, params?, options?)`	Move a draft document to trash
`email.sendEmail(body, options?)`	Send a document by email

Invoice Methodstypescript

// List invoices
const _invoices = await sdk.invoices.list({
  entity_id: "ent_123",
  limit: 20,
});

// Get single invoice
const _invoice = await sdk.invoices.get("inv_123", undefined, { entity_id: "ent_123" });

// Create invoice
const _newInvoice = await sdk.invoices.create({
  date: "2024-01-15",
  items: [{ name: "Service", price: 100 }],
}, { entity_id: "ent_123" });

// Update invoice
await sdk.invoices.update("inv_123", { date_due: "2024-02-15" }, { entity_id: "ent_123" });

// Delete invoice
await sdk.documents.delete("inv_123", undefined, { entity_id: "ent_123" });

Customers

Method	Description
`customers.list(options?)`	List customers
`customers.get(id, options?)`	Get customer by ID
`customers.create(body, options?)`	Create customer
`customers.update(id, body, options?)`	Update customer
`customers.delete(id, options?)`	Move customer to trash

Customer Methodstypescript

// List customers
const _customers = await sdk.customers.list({
  entity_id: "ent_123",
});

// Get customer
const _customer = await sdk.customers.get("cus_123", { entity_id: "ent_123" });

// Create customer
const _newCustomer = await sdk.customers.create({
  name: "Acme Corp",
  email: "billing@acme.com",
  address: "123 Business St",
  city: "New York",
  country: "United States",
}, { entity_id: "ent_123" });

// Update customer
await sdk.customers.update("cus_123", { email: "new-email@acme.com" }, { entity_id: "ent_123" });

Items

Method	Description
`items.list(options?)`	List items/products
`items.create(body, options?)`	Create item
`items.update(id, body, options?)`	Update item
`items.delete(id, options?)`	Move item to trash

Item Methodstypescript

// List items
const _items = await sdk.items.list({
  entity_id: "ent_123",
});

// Create item
const _item = await sdk.items.create({
  name: "Consulting Hour",
  unit: "hour",
  price: 150,
  tax_ids: ["tax_123"],
}, { entity_id: "ent_123" });

// Update item
await sdk.items.update("item_123", { price: 175 }, { entity_id: "ent_123" });

Business Units

Method	Description
`businessUnits.list(params?)`	List business units
`businessUnits.get(id, params?)`	Get business unit by ID
`businessUnits.create(body)`	Create business unit
`businessUnits.update(id, body)`	Update business unit
`businessUnits.delete(id)`	Archive business unit

Financial Categories

Method	Description
`financialCategories.list(params?)`	List financial categories
`financialCategories.create(body)`	Create financial category
`financialCategories.update(id, body)`	Update financial category
`financialCategories.delete(id)`	Archive financial category
`financialCategories.getRevenueByFinancialCategory(params)`	Get revenue summary grouped by category
`financialCategories.updateDocumentItemFinancialCategory(id, body)`	Update a saved document line category
`financialCategories.updateDocumentItemFinancialCategories(body)`	Batch update saved document line categories

Exports & Reporting

Method	Description
`exports.exportDocuments(params)`	Export documents to CSV or XLSX
`exports.exportSalesPerItem(params)`	Export sales per item for a period
`exports.exportRevenueByCategory(params)`	Export accrued revenue by category for a period
`exports.startPdfExport(body)`	Start async bulk PDF export
`exports.downloadPdfExport(jobId)`	Download completed PDF export archive
`exports.startEslogExport(body)`	Start async bulk e-SLOG export
`exports.downloadEslogExport(jobId)`	Download completed e-SLOG export archive
`ujp.download(id)`	Download a UJP provider/B2B ZIP package for a supported Slovenian invoice or credit note

Payments

Method	Description
`payments.list(options?)`	List payments
`payments.get(id, options?)`	Get payment by ID
`payments.create(body, options?)`	Record payment; use `document_id` in the body
`payments.delete(id, options?)`	Move payment to trash

Payment Methodstypescript

// List payments for a document
const _payments = await sdk.payments.list({
  query: JSON.stringify({ invoice_id: "inv_123" }),
  entity_id: "ent_123",
});

// Record a payment
const _payment = await sdk.payments.create({
  document_id: "inv_123",
  amount: 500,
  date: "2024-01-20",
  type: "bank_transfer",
}, { entity_id: "ent_123" });

// Delete payment
await sdk.payments.delete("pay_123", { entity_id: "ent_123" });

Entities

Method	Description
`entities.list(options?)`	List entities
`entities.get(id, options?)`	Get entity by ID
`entities.create(body, options?)`	Create entity
`entities.update(id, body, options?)`	Update entity

Entity Methodstypescript

// List entities
const _entities = await sdk.entities.list();

// Get entity
const _entity = await sdk.entities.get("ent_123");

// Create entity (for multi-tenant platforms)
const _newEntity = await sdk.entities.create({
  name: "New Business",
  email: "contact@business.com",
  country: "United States",
  country_code: "US",
});

// Update entity
await sdk.entities.update("ent_123", { name: "Updated Business Name" });

Taxes

Method	Description
`taxes.list(options?)`	List tax rates
`taxes.create(body, options?)`	Create tax rate
`taxes.update(id, body, options?)`	Update tax rate
`taxes.delete(id, options?)`	Move tax rate to trash

Pagination

All list methods support cursor-based pagination:

Paginationtypescript

// First page
const page1 = await sdk.invoices.list({
  entity_id: "ent_123",
  limit: 20,
});

// Next page using cursor
if (page1.pagination.next_cursor) {
  const _page2 = await sdk.invoices.list({
    entity_id: "ent_123",
    limit: 20,
    next_cursor: page1.pagination.next_cursor,
  });
}

Filtering

Filter results using query parameters:

Filteringtypescript

// Filter by date range
const _invoices = await sdk.invoices.list({
  entity_id: "ent_123",
  query: JSON.stringify({ date: { between: ["2024-01-01", "2024-01-31"] } }),
});

// Filter by status
const _unpaid = await sdk.invoices.list({
  entity_id: "ent_123",
  query: JSON.stringify({ paid_in_full: false }),
});

// Filter customers by search
const _customers = await sdk.customers.list({
  entity_id: "ent_123",
  search: "acme",
});

Error Handling

The SDK throws errors for failed requests:

Error Handlingtypescript

try {
  const _invoice = await sdk.invoices.get("invalid_id");
} catch(error) {
  if (error.status === 404) {
  } else if (error.status === 401) {
  } else {
  }
}

Next Steps

Zod Schemas — Form validation with Zod
API Reference — Full API documentation