Avalara E-Invoicing and Live Reporting

Data Input Fields
Documents
Interop
Mandates
Subscriptions
Trading Partners

Avalara E-Invoicing API Models

ModelSummary

Document types for which this field is applicable for

Returns an HTTP status code and message for a 'bad request'

Returns an HTTP status code and message for a 'bad request'

Represents a single batch search operation

Response schema for listing batch search details.

Mandates for which this field is conditional

The Data Input Field

Response model providing a list of input fields required, optional, or conditional for different country mandates.

Response schema for directory search results

An object of the inbound document

The unique ID for this document that was returned in the POST /einvoicing/documents response body. This is a UID created by the Avalara E-Invoicing platform.

Returns the requested list of documents

Returns the current document ID and status

Returns an HTTP status code and message for an 'exception'

Returns the unique ID of a successful document submission

Displays a summary of information about the document

Standard format for API error responses.

Identifies an event type uniquely in the context of webhook notifications.

Encapsulates the data of a single event being sent via webhook, including metadata and the message payload.

Contains the event-specific information delivered in the webhook notification.

Represents a subscription to a specific event, identified by its unique name.

Returns an optional message with a 'forbidden' response

Basic signature utilizing a shared key.

Contains the HMAC algorithm and the resulting signature value used for verifying message integrity.

Common ID format.

Format and version used when inputting the data

Document format version

Returns an optional message with a 'InternalServerError' response

An object representing the country mandate

The Data Input Field

Array of Data Input Fields

Mandate list response schema

No sinature configuration properties are required when the no signature is used.

No properties are required when the no signature is included.

Returns an HTTP error code and message for a 'not found' error

Mandates for which this field is not used

Mandates for which this field is optional

Format and version used when outputting the data

Document format version

Pagination information for the dataset.

Mandates for which this field is required

Defines the signature configuration, specifying whether and how messages are signed for webhook delivery.

Includes the actual signature applied to a webhook message along with the algorithm used.

Displays when a status event occurred

Allows submission of a document.

Basic configuration for a webhook subscription, including description and target notification URL.

Provides complete information about a webhook subscription, including subscribed events, delivery endpoint, and signature configuration.

Response format for listing webhook subscriptions, including pagination and subscription details.

Used when creating a new webhook subscription, specifying the notification endpoint, event list, and optional signature settings.

Indicates a successful outcome of an API operation, including a generated ID and success message.

Details the attempt to deliver one or more events to a subscriber's endpoint, including retry metadata.

Information about the error encountered

Wrapper for errors occurring during webhook subscription or delivery processing.

Workflow ID list