/** * Generated by orval v8.5.3 🍺 * Do not edit manually. * Space Invoices API * REST API for invoice management, customer management, and accounting operations. Features include cursor-based pagination for efficient data navigation, flexible JSON querying with MongoDB-style operators, full-text search across multiple fields, and comprehensive metadata support for custom tracking. * OpenAPI spec version: 1.0.0 */ import type { CreationSource } from './creationSource'; import type { DeliveryNoteCalculationMode } from './deliveryNoteCalculationMode'; import type { DeliveryNoteItem } from './deliveryNoteItem'; import type { DeliveryNoteMetadata } from './deliveryNoteMetadata'; import type { DeliveryNoteTransactionType } from './deliveryNoteTransactionType'; import type { DocumentCustomer } from './documentCustomer'; import type { DocumentEntity } from './documentEntity'; import type { DocumentRelation } from './documentRelation'; import type { DocumentSummaryTax } from './documentSummaryTax'; import type { EslogData } from './eslogData'; import type { ExchangeRate } from './exchangeRate'; import type { ViesDocumentData } from './viesDocumentData'; /** * Delivery note / packing list document */ export interface DeliveryNote { /** @maxLength 36 */ id: string; /** @maxLength 100 */ number: string; /** Whether this is a draft document. Draft documents have no sequential number assigned, skip fiscalization, and can be deleted. Use POST /{documents}/{id}/finalize to assign a number and finalize. */ is_draft: boolean; /** Date the delivery note was created (ISO 8601 datetime at midnight UTC) */ date: string; issuer: DocumentEntity; /** * @maxLength 36 * @nullable */ customer_id?: string | null; customer?: DocumentCustomer | null; /** * Note for the document. If not provided, defaults to entity's document-type-specific note setting. Pass empty string to explicitly set no note. * @nullable */ note?: string | null; /** * Payment terms for the document. If not provided, defaults to entity's document-type-specific payment terms setting. Pass empty string to explicitly set no terms. * @nullable */ payment_terms?: string | null; /** * Tax clause for the document. Auto-populated based on transaction type if tax_clause_defaults are configured in entity settings. Pass empty string to explicitly set no clause. * @nullable */ tax_clause?: string | null; /** * @maxLength 500 * @nullable */ footer?: string | null; /** * Signature text for the document (e.g. 'John Smith, CEO'). If not provided, defaults to entity's default_document_signature setting. Pass empty string to explicitly set no signature. * @nullable */ signature?: string | null; /** * @minimum -140737488355328 * @maximum 140737488355327 */ total: number; /** * @minimum -140737488355328 * @maximum 140737488355327 */ total_with_tax: number; /** Document discount total stored as a net-equivalent amount for compatibility. In `b2b_standard`, this is the net value of line-item discounts applied before tax. In `b2c_gross_discount`, gross discounts are converted back to their net-equivalent value here. 0 when no discounts applied. */ total_discount: number; creation_source: CreationSource; /** Resolved calculation mode used for this document. Stored on the document so recalculation and rendering remain stable even if entity defaults change later. */ calculation_mode: DeliveryNoteCalculationMode; /** Applied taxes summary */ taxes: DocumentSummaryTax[]; /** @maxLength 3 */ currency_code: string; /** @maxLength 36 */ entity_id: string; /** * @minimum -2147483648 * @maximum 2147483647 */ date_year: number; /** * @maxLength 100 * @nullable */ shareable_id?: string | null; /** @nullable */ voided_at?: string | null; /** * Transaction type for VAT purposes (domestic, intra_eu_b2b, intra_eu_b2c, export). Always determined based on issuer/customer countries. * @nullable */ transaction_type?: DeliveryNoteTransactionType; /** * 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. * @nullable */ metadata?: DeliveryNoteMetadata; exchange_rate?: ExchangeRate | null; /** * @minimum -140737488355328 * @maximum 140737488355327 * @nullable */ total_converted?: number | null; /** * @minimum -140737488355328 * @maximum 140737488355327 * @nullable */ total_with_tax_converted?: number | null; /** * Rounding correction applied to reconcile differences between calculated total_with_tax and expected_total_with_tax. Only present when expected_total_with_tax was provided during creation. * @nullable */ rounding_correction?: number | null; eslog?: EslogData | null; /** * Custom reference for the document (e.g., purchase order number, payment reference). When set, used as the UPN payment reference instead of the auto-generated one. * @nullable */ reference?: string | null; vies?: ViesDocumentData | null; /** * Timestamp when the document was soft-deleted. Null if not deleted. * @nullable */ deleted_at?: string | null; created_at: string; updated_at: string; /** When true, prices and totals are hidden on the document (packing list mode). */ hide_prices: boolean; /** * Document due date in YYYY-MM-DD format * @nullable * @pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?)?$ */ date_due?: string | null; /** * Service date in YYYY-MM-DD format. For invoices and credit notes. * @nullable * @pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?)?$ */ date_service?: string | null; /** * Service period end date in YYYY-MM-DD format. For invoices and credit notes. Use with date_service for date ranges. * @nullable * @pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?)?$ */ date_service_to?: string | null; items: DeliveryNoteItem[]; document_relations?: DocumentRelation[]; } //# sourceMappingURL=deliveryNote.d.ts.map