Cmdlets for Avalara

Build 24.0.9062

接続の確立

CData Cmdlets ユーザーは、データモジュールをインストールし、接続プロパティを設定してスクリプトを開始できます。このセクションでは、CSV インポートおよびエクスポートcmdlet などのネイティブPowerShell cmdlet でAvalara Cmdlets を使用する例を示します。

インストールおよび接続

PSGet がある場合は、PowerShell Gallery から次のコマンドを使ってcmdlet をインストールできます。CData サイトからセットアップを取得することもできます。

Install-Module AvalaraCmdlets

プロファイルに以下を追加すると、次のセッションでcmdlet がロードされます。

Import-Module AvalaraCmdlets;

Connect-Avalara cmdlet を使って、別のcmdlet に渡すことができる接続オブジェクトを作成します。

$conn = Connect-Avalara -User "MYUser" -Password "myPassword"

Connecting to Avalara

By default, the 本製品 connects to a production environment. Set UseSandbox to true to configure the 本製品 to connect to a Avalara sandbox environment.

Authenticating to Avalara

There are two authentication methods available for connecting to the Avalara data source: Basic and LicenseKey.

Login Credentials

To use login credentials for authentication, set the following:

  • AuthScheme: Set this to Basic.
  • User: Set this to your Avalara username.
  • Password: Set this to your Avalara password.

Account Number and License Key

Alternatively, you can authenticate using your account number and license key. Connect to the data source using the following:

  • AuthScheme: Set this to LicenseKey.
  • AccountId: Set this to your Avalara Account Id. The Account Id is listed in the upper right-hand corner of the Avalara admin console.
  • LicenseKey: Set this to your Avalara license key. You can generate a license key by logging into Avalara as an account adminstrator and navigating to Settings > Reset License Key.

データの取得

Select-Avalara cmdlet はデータを取得するためのネイティブなPowerShell インターフェースを提供します。

$results = Select-Avalara -Connection $conn -Table "Transactions" -Columns @("Id, TotalTax") -Where "Code='051349'"
Invoke-Avalara cmdlet はSQL インターフェースを提供します。このcmdlet を使うと、Query パラメータを介してSQL クエリを実行できます。

cmdlet 出力のパイプ処理

cmdlet は行オブジェクトをパイプラインに一度に一行ずつ返します。以下は、結果をCSV ファイルにエクスポートします。

Select-Avalara -Connection $conn -Table Transactions -Where "Code = '051349'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myTransactionsData.csv -NoTypeInformation

Select-Avalara からの結果をSelect-Object cmdlet にパイプして、Export-CSV cmdlet にパイプする前にいくつかのプロパティを実行していることがわかるでしょう。これをする理由は、CData Cmdlets は接続、テーブル、およびカラムの情報を結果セットの各行オブジェクトに追加しますが、必ずしもその情報がCSV ファイルに必要ではないからです。

ただし、これによってcmdlet の出力を別のcmdlet にパイプすることが容易になります。以下に、結果セットをJSON に変換する例を示します。

 
PS C:\> $conn  = Connect-Avalara -User "MYUser" -Password "myPassword"
PS C:\> $row = Select-Avalara -Connection $conn -Table "Transactions" -Columns (Id, TotalTax) -Where "Code = '051349'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Transactions",
  "Columns":  [

  ],
  "Id":  "MyId",
  "TotalTax":  "MyTotalTax"
} 

データの削除

以下は、抽出条件に合うあらゆるレコードを削除します。

Select-Avalara -Connection $conn -Table Transactions -Where "Code = '051349'" | Remove-Avalara

データの変更

cmdlet はデータクレンジング同様、データの変換を容易にします。次の例は、レコードがすでに存在するかどうか、挿入する前に更新が必要かどうかをチェックしてから、CSV ファイルのデータをAvalara にロードします。

Import-Csv -Path C:\MyTransactionsUpdates.csv | %{
  $record = Select-Avalara -Connection $conn -Table Transactions -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Avalara -Connection $conn -Table Transactions -Columns @("Id","TotalTax") -Values @($_.Id, $_.TotalTax) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Avalara -Connection $conn -Table Transactions -Columns @("Id","TotalTax") -Values @($_.Id, $_.TotalTax)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062