Avalara Request Data

A standard Avalara request contains the following data points:

date
code
commit
currencyCode
customerCode
companyCode
lines
  number
  entityUseCode
  businessIdentificationNo
  description
  itemCode
  taxCode
  amount
  quantity
  addresses
    shipFrom
      line1
      line2
      city
      region
      postalCode
      country
    shipTo
      line1
      line2
      city
      region
      postalCode
      country
  taxOverride
    type
    reason
    taxDate
referenceCode
type

 


Example Charge Request

{
  "date": "2020-06-17",
  "code": "8543",
  "commit": false,
  "currencyCode": "USD",
  "customerCode": "nj@example.com",
  "companyCode": "1755225992709362408",
  "lines": [
    {
      "number": 0,
      "businessIdentificationNo": "",
      "description": "Cherry",
      "itemCode": null,
      "taxCode": null,
      "amount": 100,
      "quantity": 1,
      "addresses": {
        "shipFrom": {
          "line1": "24 Grosvenor Square",
          "line2": "",
          "city": "London",
          "region": "london",
          "postalCode": "W1K 6AH",
          "country": "GB"
        },
        "shipTo": {
          "line1": "123 Hollywood Blvd.",
          "line2": "",
          "city": "Beverly Hills",
          "region": "CA",
          "postalCode": "90210",
          "country": "US"
        }
      }
    },
    {
      "number": 1,
      "businessIdentificationNo": "",
      "description": "Pie",
      "itemCode": null,
      "taxCode": null,
      "amount": 30,
      "quantity": 3,
      "addresses": {
        "shipFrom": {
          "line1": "24 Grosvenor Square",
          "line2": "",
          "city": "London",
          "region": "london",
          "postalCode": "W1K 6AH",
          "country": "GB"
        },
        "shipTo": {
          "line1": "123 Hollywood Blvd.",
          "line2": "",
          "city": "Beverly Hills",
          "region": "CA",
          "postalCode": "90210",
          "country": "US"
        }
      }
    },
    {
      "number": 2,
      "businessIdentificationNo": "",
      "description": "Shipping: Standard Shipping",
      "itemCode": null,
      "taxCode": null,
      "amount": 10,
      "quantity": 1,
      "addresses": {
        "shipFrom": {
          "line1": "24 Grosvenor Square",
          "line2": "",
          "city": "London",
          "region": "london",
          "postalCode": "W1K 6AH",
          "country": "GB"
        },
        "shipTo": {
          "line1": "123 Hollywood Blvd.",
          "line2": "",
          "city": "Beverly Hills",
          "region": "CA",
          "postalCode": "90210",
          "country": "US"
        }
      }
    }
  ],
  "type": "SalesInvoice"
}


Example Refund Request

{
  "date": "2020-06-18",
  "code": "8544",
  "commit": false,
  "currencyCode": "USD",
  "customerCode": "nj@example.com",
  "companyCode": "1755225992709362408",
  "lines": [
    {
      "number": 0,
      "businessIdentificationNo": "",
      "description": "Cherry",
      "itemCode": null,
      "taxCode": null,
      "amount": -100,
      "quantity": 1,
      "addresses": {
        "shipFrom": {
          "line1": "24 Grosvenor Square",
          "line2": "",
          "city": "London",
          "region": "london",
          "postalCode": "W1K 6AH",
          "country": "GB"
        },
        "shipTo": {
          "line1": "123 Hollywood Blvd.",
          "line2": "",
          "city": "Beverly Hills",
          "region": "CA",
          "postalCode": "90210",
          "country": "US"
        }
      },
      "taxOverride": {
        "type": "TaxDate",
        "reason": "Refund",
        "taxDate": "2020-06-17"
      }
    },
    {
      "number": 1,
      "businessIdentificationNo": "",
      "description": "Pie",
      "itemCode": null,
      "taxCode": null,
      "amount": -30,
      "quantity": 3,
      "addresses": {
        "shipFrom": {
          "line1": "24 Grosvenor Square",
          "line2": "",
          "city": "London",
          "region": "london",
          "postalCode": "W1K 6AH",
          "country": "GB"
        },
        "shipTo": {
          "line1": "123 Hollywood Blvd.",
          "line2": "",
          "city": "Beverly Hills",
          "region": "CA",
          "postalCode": "90210",
          "country": "US"
        }
      },
      "taxOverride": {
        "type": "TaxDate",
        "reason": "Refund",
        "taxDate": "2020-06-17"
      }
    },
    {
      "number": 2,
      "businessIdentificationNo": "",
      "description": "Shipping: Standard Shipping",
      "itemCode": null,
      "taxCode": null,
      "amount": -10,
      "quantity": 1,
      "addresses": {
        "shipFrom": {
          "line1": "24 Grosvenor Square",
          "line2": "",
          "city": "London",
          "region": "london",
          "postalCode": "W1K 6AH",
          "country": "GB"
        },
        "shipTo": {
          "line1": "123 Hollywood Blvd.",
          "line2": "",
          "city": "Beverly Hills",
          "region": "CA",
          "postalCode": "90210",
          "country": "US"
        }
      },
      "taxOverride": {
        "type": "TaxDate",
        "reason": "Refund",
        "taxDate": "2020-06-17"
      }
    }
  ],
  "referenceCode": "8543",
  "type": "ReturnInvoice"
}


Example Exempt Account Request

{
  "date": "2020-06-18",
  "code": "8545",
  "commit": false,
  "currencyCode": "USD",
  "customerCode": "nj@example.com",
  "companyCode": "1755225992709362408",
  "lines": [
    {
      "number": 0,
      "entityUseCode": "E",
      "businessIdentificationNo": "",
      "description": "Charge",
      "itemCode": "",
      "taxCode": "DA030000",
      "amount": 100,
      "quantity": 1,
      "addresses": {
        "shipFrom": {
          "line1": "24 Grosvenor Square",
          "line2": "",
          "city": "London",
          "region": "london",
          "postalCode": "W1K 6AH",
          "country": "GB"
        },
        "shipTo": {
          "line1": "123 Hollywood Blvd.",
          "line2": "",
          "city": "Beverly Hills",
          "region": "CA",
          "postalCode": "90210",
          "country": "US"
        }
      }
    }
  ],
  "type": "SalesInvoice"
}

Comments

0 comments

Please sign in to leave a comment.