PurchaseRecurringAgreementRead

object

Reads a PurchaseRecurringAgreements

Return a PurchaseRecurringAgreements with the specified ID.

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 to which this document belongs
`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. Assigned automatically on creation
`date`	`DateTime`	Issue date of the document. Must follow sequential numbering rules per AT regulations
`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 identifier when document uses a foreign currency
`currencyExchangeExchange`	`Float`	Exchange rate value applied when document uses a foreign currency
`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. Nullified documents remain for audit but have no fiscal effect
`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 identifier 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 (e.g., purchase order number)
`ourReference`	`String`	Internal reference for this document (e.g., contract number, project code)
`lastModified`	`DateTime`	Date and time of the last modification
`downloads`	`Int`	Number of times the document PDF has been downloaded
`terminalId`	`Int`
`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`
`events`	`[EventRead!]`	Scheduled recurring events associated with this document
`grossValue`	`Float`	Gross value of the document before taxes and discounts (calculated)
`globalDiscount`	`Float`	Global discount percentage applied to the entire document
`globalDiscountValue`	`Float`	Monetary value of the global discount applied to the document (calculated)
`commercialDiscountValue`	`Float`	Monetary value of the commercial discount applied to the document (calculated)
`totalDiscountValue`	`Float`	Total discount monetary value across all discount types (calculated)
`taxesValue`	`Float`	Total tax amount applied to the document (calculated from product lines)
`expirationDate`	`Date`	Due date for the document, typically derived from the maturity date
`maturityDate`	`MaturityDateRead`	Maturity date preset identifier, used to calculate the expiration date
`maturityDateDays`	`Int`	Number of days for the maturity period (resolved from maturityDateId)
`maturityDateName`	`String`	Name of the maturity date preset (resolved from maturityDateId)
`timezone`	`TimezoneRead`	Timezone identifier for the document issue date
`supplier`	`SupplierRead`	Supplier to whom this document is issued
`alternateAddress`	`AlternateAddressRead`	Alternate delivery/billing address for the entity
`salesperson`	`SalespersonRead`	Salesperson assigned to this document for commission tracking
`salespersonCommission`	`Float`	Commission percentage for the salesperson on this document
`economicActivityClassificationCodeId`	`Int`	Economic activity classification code (CAE) identifier, per AT SAF-T requirements
`economicActivityClassificationCode`	`EconomicActivityClassificationCodeRead`
`relatedIn`	`[RelatedDocumentRead]`	Documents originated from this document (e.g., receipts created from this invoice)
`relatedWith`	`[RelatedDocumentRead]`	Source documents that originated this document (e.g., invoice referenced by a credit note)
`notesRelatedDocs`	`String`	Notes regarding related documents
`products`	`[DocumentProductRead!]`	Line items (products/services) included in this document
`notes`	`String`	Free-text observations or notes for this document
`retentionsValue`	`Float`	Withholding tax value applied to this document
`taxes`	`[DocumentTaxRead!]!`
`ocrJobId`	`String`
`ocrJob`	`OcrJobRead`

Deprecated fields (16)

Name	Type	Description
`deletable`	`Boolean`	Whether this document can be deleted Use deletionBlockers instead
`event`	`EventRead`	Single recurring event. Deprecated in favor of events array Use events instead
`deliveryMethod`	`DeliveryMethodRead`	Delivery/shipping method identifier This document should not have transportation data
`deliveryMethodName`	`String`	Delivery/shipping method name (resolved from deliveryMethodId) This document should not have transportation data
`vehicle`	`VehicleRead`	Vehicle identifier used for goods transportation This document should not have transportation data
`deliveryVehicleName`	`String`	Name/description of the transportation vehicle (resolved from vehicleId) This document should not have transportation data
`deliveryVehicleLicensePlate`	`String`	License plate of the transportation vehicle (resolved from vehicleId) This document should not have transportation data
`deliveryLoadDate`	`DateTime`	Date and time when goods are loaded for transport. Required for AT transport documents This document should not have transportation data
`deliveryLoadAddress`	`String`	Loading address for goods transport. Required by AT for transport documents in Portugal This document should not have transportation data
`deliveryLoadCity`	`String`	Loading city for goods transport This document should not have transportation data
`deliveryLoadZipCode`	`String`	Loading postal code for goods transport This document should not have transportation data
`deliveryLoadCountry`	`CountryRead`	Loading country for goods transport This document should not have transportation data
`deliveryUnloadAddress`	`String`	Unloading/delivery address for goods transport. Required by AT for transport documents in Portugal This document should not have transportation data
`deliveryUnloadCity`	`String`	Unloading/delivery city for goods transport This document should not have transportation data
`deliveryUnloadZipCode`	`String`	Unloading/delivery postal code for goods transport This document should not have transportation data
`deliveryUnloadCountry`	`CountryRead`	Unloading/delivery country for goods transport This document should not have transportation data

Implements

DocumentReadItemWithLogsDocumentWithTaxesDocumentWithOcr