Avalara E-Invoicing and Live Reporting
DocumentSummary
Displays a summary of information about the document
The unique ID for this document
Unique identifier that represents the company within the system.
The date and time when the document was processed, displayed in the format YYYY-MM-DDThh:mm:ss
The Document status
Represents the document's business lifecycle state based on responses from external actors (Tax Authority, PDP, or ERP), such as acceptance, rejection, or validation.
Captures the tax authority (TA) status.
The name of the supplier in the transaction
The name of the customer in the transaction
The document type
The document version
The document number
The document issue date
The document direction, where issued = out and received = in
The two-letter ISO-3166 country code for the country where the document is being submitted
The e-invoicing mandate for the specified country
The interface where the document is sent
The document recipient based on the interface
Array of status events associated with this document. Events are included in each document in the response only when the query parameter $include=events is passed; otherwise the events array is not populated.
The date and time when the document was created in the system, displayed in ISO 8601 format with timezone
The date and time when the document was last updated in the system, displayed in ISO 8601 format with timezone
Array of reports associated with this document. Returns an empty array when no reports are present.
Country-specific document attributes returned alongside the standard document summary. The shape of this object varies by country mandate. Each attribute within this object is individually searchable using $filter with dot notation (for example, $filter=additionalDocAttributes.incarcare eq 'UP1312321').
The date and time when a new media type/artefact was most recently added to this document, displayed in ISO 8601 format with timezone. Unlike lastUpdatedAt, this only changes when a new media type becomes available - not on every document update - making it suitable as a polling cursor to detect new downloadable content.