Skip to content

RGSATaxApi.md

Latest commit

 

History

History
140 lines (97 loc) · 4.53 KB

RGSATaxApi.md

File metadata and controls

140 lines (97 loc) · 4.53 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSATaxApi

All URIs are relative to https://saapi.realgreen.com

Method HTTP request Description
Invoke-RGSATaxAvailableAvailableGet GET /Tax/Available/{available} Returns a list of tax parameters that are/are not available based on the provided available value.
Invoke-RGSATaxGet GET /Tax Returns all tax codes in the database.
Invoke-RGSATaxIdGet GET /Tax/{id} Returns a single tax record that corresponds to the provided ID.

Invoke-RGSATaxAvailableAvailableGet

Tax[] Invoke-RGSATaxAvailableAvailableGet
        [-Available]
        [-ApiKey]

Returns a list of tax parameters that are/are not available based on the provided available value.

Example

$Available = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of tax parameters that are/are not available based on the provided available value.
try {
    $Result = Invoke-RGSATaxAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSATaxAvailableAvailableGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Available Boolean
ApiKey String API Key

Return type

Tax[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSATaxGet

Tax[] Invoke-RGSATaxGet
        [-ApiKey]

Returns all tax codes in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

# Returns all tax codes in the database.
try {
    $Result = Invoke-RGSATaxGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSATaxGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

Tax[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Invoke-RGSATaxIdGet

Tax Invoke-RGSATaxIdGet
        [-Id]
        [-ApiKey]

Returns a single tax record that corresponds to the provided ID.

Example

$Id = "MyId" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single tax record that corresponds to the provided ID.
try {
    $Result = Invoke-RGSATaxIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSATaxIdGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Id String
ApiKey String API Key

Return type

Tax (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]