Avalara · Schema

PingResultModel

PingResultModel schema from Avalara API

Taxes

Properties

Name Type Description
version string AvaTax API version
authenticated boolean Whether the request was authenticated
authenticationType string Type of authentication used
authenticatedUserName string Username of the authenticated user
authenticatedUserId integer User ID of the authenticated user
authenticatedAccountId integer Account ID of the authenticated user
crmid string
View JSON Schema on GitHub

JSON Schema

avatax-rest-ping-result-model-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/avalara/refs/heads/main/json-schema/avatax-rest-ping-result-model-schema.json",
  "title": "PingResultModel",
  "description": "PingResultModel schema from Avalara API",
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "AvaTax API version"
    },
    "authenticated": {
      "type": "boolean",
      "description": "Whether the request was authenticated"
    },
    "authenticationType": {
      "type": "string",
      "enum": [
        "None",
        "UsernamePassword",
        "AccountIdLicenseKey",
        "OpenIdBearerToken"
      ],
      "description": "Type of authentication used"
    },
    "authenticatedUserName": {
      "type": "string",
      "description": "Username of the authenticated user"
    },
    "authenticatedUserId": {
      "type": "integer",
      "description": "User ID of the authenticated user"
    },
    "authenticatedAccountId": {
      "type": "integer",
      "description": "Account ID of the authenticated user"
    },
    "crmid": {
      "type": "string"
    }
  }
}