Avalara E-Invoicing and Live Reporting

Code Lists
Data Input Fields
Documents
Interop
Mandates
Reports
Subscriptions
Tax Identifiers
Trading Partners

DocumentStatusResponse

Returns the current document ID and status

This model is used in the following APIs:

Parameters
idOptional
string

The unique ID for this document

statusOptional
string

Document status. See the supportedDocumentStatuses field in the GET /mandates response for full status definitions.

businessStatusOptional
string

Represents the document's business lifecycle state based on responses from external actors (Tax Authority, PDP, or ERP), such as acceptance, rejection, or validation.

authorityStatusOptional
string

Captures the tax authority (TA) status.

reportsOptional
array

Array of reports associated with this document. Returns an empty array when no reports are present.

eventsOptional
array
availableMediaTypesOptional
array

Real-time list of the submitted and generated artefacts that are currently available for this business document. Anything listed here is downloadable via GET /documents/{documentId}/$download. Returned only when availableMediaTypes is requested via the $include query parameter.

lastMediaTypeAddedAtOptional
string

The date and time when a new media type/artefact was most recently added to this document, displayed in ISO 8601 format with timezone. Compare against a previously stored value to detect newly available downloadable content without diffing availableMediaTypes yourself.