DocumentRead

interface

Fields

Name	Type	Description
`documentId`	`Int!`	Unique identifier of the document
`fiscalZone`	`String`	Fiscal zone code for tax calculation purposes
`documentTypeId`	`Int!`	Document type identifier (e.g., invoice, credit note, receipt)
`documentType`	`DocumentTypeRead!`	Document type details
`documentSet`	`DocumentSetRead`	Document set this document belongs to
`company`	`CompanyRead!`	Company that owns this document
`companyId`	`Int!`	Company identifier
`documentSetName`	`String!`	Name of the document set
`documentSetId`	`Int`	Document set identifier
`number`	`Int`	Sequential document number within its document set
`date`	`DateTime`	Issue date of the document
`geographicZoneId`	`Int`	Geographic zone identifier for regional tax rules
`geographicZone`	`GeographicZoneRead`	Geographic zone details for regional tax rules
`year`	`Int`	Fiscal year of the document
`totalValue`	`Float!`	Total monetary value of the document including taxes
`documentTotal`	`Float`	Calculated total of the document based on line items
`totalRelatedAppliedValue`	`Float`	Total value applied from related documents
`reconciledValue`	`Float`	Value already reconciled/settled against this document
`remainingReconciledValue`	`Float`	Remaining value to be reconciled
`reconciliationPercentage`	`Float`	Percentage of the document value that has been reconciled
`currencyExchangeTotalValue`	`Float`	Total value converted to the foreign currency
`currencyExchange`	`CurrencyExchangeRead`	Currency exchange rate details
`currencyExchangeExchange`	`Float`	Exchange rate applied to the document
`documentCalculationsMode`	`Int`	Calculation mode used for the document (e.g., tax-inclusive or tax-exclusive)
`status`	`Int`	Document status: 0 = draft, 1 = closed/finalized
`suspended`	`Boolean`	Whether the document is suspended (temporarily on hold)
`nullified`	`Boolean`	Whether the document has been voided/cancelled
`pdfExport`	`String`	Path to the PDF file at mediaAPI: `null` = PDF generation not requested empty string = PDF pending generation
`deletionBlockers`	`[DeletionBlocker!]!`	Reasons why this document can't be deleted. Empty array means the document is deletable
`nullifiable`	`Boolean`	Whether this document can be nullified
`entityVat`	`String`	Tax identification number (VAT) of the entity, copied at document creation
`entityName`	`String`	Name of the entity (customer/supplier), copied at document creation
`entityNumber`	`String`	Internal reference number of the entity, copied at document creation
`entityAddress`	`String`	Address of the entity, copied at document creation
`entityZipCode`	`String`	Postal code of the entity, copied at document creation
`entityCity`	`String`	City of the entity, copied at document creation
`entityCountryName`	`String`	Country name of the entity, copied at document creation
`countryId`	`Int`	Country identifier of the entity
`country`	`CountryRead`	Country details of the entity
`lastOperations`	`LastOperationsRead`	Last operations performed on this document (created, closed, nullified)
`emailsCount`	`Int`	Number of emails sent for this document
`hash`	`String`	SAF-T hash signature for document integrity validation
`hashControl`	`String`	Hash control character used in the hash chain
`yourReference`	`String`	Customer's own reference for this document
`ourReference`	`String`	Internal reference for this document
`lastModified`	`DateTime`	Date and time of the last modification
`downloads`	`Int`	Number of times the document PDF has been downloaded
`createdAt`	`DateTime!`	Timestamp when the document was created
`updatedAt`	`DateTime!`	Timestamp when the document was last updated
`importStatus`	`ImportStatus`	Import status for migrated documents
`source`	`DocumentSource`	Origin of the document (where it was created from)
`created`	`LogInfo`
`updated`	`LogInfo`

Deprecated fields (1)

Name	Type	Description
`deletable`	`Boolean`	Whether this document can be deleted Use deletionBlockers instead

Implements

ItemWithLogs

DocumentRead

Fields

Possible types

Implements