Skip to content

RGSAUtilitiesApi.md

Latest commit

 

History

History
52 lines (34 loc) · 1.95 KB

RGSAUtilitiesApi.md

File metadata and controls

52 lines (34 loc) · 1.95 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAUtilitiesApi

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

Method HTTP request Description
Invoke-RGSAUtilitiesYearEndPriceIncreasePost POST /Utilities/YearEnd/PriceIncrease

Invoke-RGSAUtilitiesYearEndPriceIncreasePost

void Invoke-RGSAUtilitiesYearEndPriceIncreasePost
        [-ApiKey]
        [-PriceIncreaseCriteria]

Example

$ApiKey = "MyApiKey" # String | API Key
$PriceIncreaseCriteria = Initialize-PriceIncreaseCriteria -ProgramIDs 0 -IncreaseAmount 0 -IsPercentIncrease $false -OnlyIncreaseRenewalPrice $false # PriceIncreaseCriteria |  (optional)

try {
    $Result = Invoke-RGSAUtilitiesYearEndPriceIncreasePost -ApiKey $ApiKey -PriceIncreaseCriteria $PriceIncreaseCriteria
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAUtilitiesYearEndPriceIncreasePost: {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
PriceIncreaseCriteria PriceIncreaseCriteria [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: Not defined

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