Avalara E-Invoicing and Live Reporting
Avalara E-Invoicing API Models
| Model | Summary |
|---|---|
| — | |
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 detailed error information for an individual entry in a batch request. Includes the index of the failed item and associated validation errors. | |
Represents a single batch search operation | |
Response schema for listing batch search details. | |
Returns the requested list of code lists | |
Returns a code list definition for a specific country | |
Displays a summary of information about a code list | |
Represents a single code entry in a code list version | |
Represents a versioned definition of a code list for a specific jurisdiction and date range | |
Mandates for which this field is conditional | |
| — | |
The Data Input Field | |
| — | |
| — | |
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. | |
| — | |
| — | |
| — | |
| — | |
| — | |
Returns an optional message with a 'forbidden' response | |
Basic signature utilizing a shared key. | |
| — | |
Common ID format. | |
| — | |
Format and version used when inputting the data | |
Document format version | |
Returns an optional message with a 'InternalServerError' response | |
| — | |
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 | |
| — | |
Returns a pre-signed URL to download the report file. | |
The unique ID for this report as returned in a GET /reports response. This is a UID created by the Avalara E-Invoicing platform. | |
Represents a single report with full details including metadata and associated transaction IDs. | |
Returns the requested list of reports matching the query parameters. | |
| — | |
| — | |
| — | |
Displays when a status event occurred | |
Allows submission of a document. | |
| — | |
| — | |
| — | |
| — | |
| — | |
Represents a document status defined by the mandate. | |
| — | |
Represents a request to validate company’s tax identifier. | |
Represents the response for a tax identifier validation request. | |
Represents a participant in the Avalara directory. | |
Represents a specific validation failure within a request. | |
| — | |
Information about the error encountered | |
| — | |
Workflow ID list |