Skip to content

RGSAPrepayCodeApi.md

Latest commit

 

History

History
445 lines (301 loc) · 14.2 KB

RGSAPrepayCodeApi.md

File metadata and controls

445 lines (301 loc) · 14.2 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAPrepayCodeApi

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

Method HTTP request Description
Invoke-RGSAPrepayCodesAllProgramsAllprogGet GET /PrepayCodes/AllPrograms/{allprog}
Invoke-RGSAPrepayCodesAllSpecialsAllspecGet GET /PrepayCodes/AllSpecials/{allspec}
Invoke-RGSAPrepayCodesAnybranchAnybranchGet GET /PrepayCodes/Anybranch/{anybranch}
Invoke-RGSAPrepayCodesAvailableAvailableGet GET /PrepayCodes/Available/{available}
Invoke-RGSAPrepayCodesEligibilityPost POST /PrepayCodes/Eligibility
Invoke-RGSAPrepayCodesGet GET /PrepayCodes
Invoke-RGSAPrepayCodesHandheldHandheldGet GET /PrepayCodes/Handheld/{handheld}
Invoke-RGSAPrepayCodesIdGet GET /PrepayCodes/{id}
Invoke-RGSAPrepayCodesInstallmentInstallmntGet GET /PrepayCodes/Installment/{installmnt}
Invoke-RGSAPrepayCodesPercentPercentGet GET /PrepayCodes/Percent/{percent}

Invoke-RGSAPrepayCodesAllProgramsAllprogGet

void Invoke-RGSAPrepayCodesAllProgramsAllprogGet
        [-Allprog]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAPrepayCodesAllProgramsAllprogGet -Allprog $Allprog -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPrepayCodesAllProgramsAllprogGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Allprog Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAPrepayCodesAllSpecialsAllspecGet

void Invoke-RGSAPrepayCodesAllSpecialsAllspecGet
        [-Allspec]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAPrepayCodesAllSpecialsAllspecGet -Allspec $Allspec -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPrepayCodesAllSpecialsAllspecGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Allspec Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAPrepayCodesAnybranchAnybranchGet

void Invoke-RGSAPrepayCodesAnybranchAnybranchGet
        [-Anybranch]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAPrepayCodesAnybranchAnybranchGet -Anybranch $Anybranch -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPrepayCodesAnybranchAnybranchGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Anybranch Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAPrepayCodesAvailableAvailableGet

void Invoke-RGSAPrepayCodesAvailableAvailableGet
        [-Available]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAPrepayCodesAvailableAvailableGet -Available $Available -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPrepayCodesAvailableAvailableGet: {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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAPrepayCodesEligibilityPost

void Invoke-RGSAPrepayCodesEligibilityPost
        [-ApiKey]
        [-PrepayCodeLookup]

Example

$ApiKey = "MyApiKey" # String | API Key
$PrepayCodeLookup = Initialize-PrepayCodeLookup -CompanyID 0 -ProgramDefinitionIDs 0 # PrepayCodeLookup |  (optional)

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

Invoke-RGSAPrepayCodesGet

void Invoke-RGSAPrepayCodesGet
        [-ApiKey]

Example

$ApiKey = "MyApiKey" # String | API Key

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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAPrepayCodesHandheldHandheldGet

void Invoke-RGSAPrepayCodesHandheldHandheldGet
        [-Handheld]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAPrepayCodesHandheldHandheldGet -Handheld $Handheld -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPrepayCodesHandheldHandheldGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Handheld Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAPrepayCodesIdGet

void Invoke-RGSAPrepayCodesIdGet
        [-Id]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAPrepayCodesIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPrepayCodesIdGet: {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

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAPrepayCodesInstallmentInstallmntGet

void Invoke-RGSAPrepayCodesInstallmentInstallmntGet
        [-Installmnt]
        [-ApiKey]

Example

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

try {
    $Result = Invoke-RGSAPrepayCodesInstallmentInstallmntGet -Installmnt $Installmnt -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPrepayCodesInstallmentInstallmntGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Installmnt Boolean
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Invoke-RGSAPrepayCodesPercentPercentGet

void Invoke-RGSAPrepayCodesPercentPercentGet
        [-Percent]
        [-ApiKey]

Example

$Percent = 1.2 # Double | 
$ApiKey = "MyApiKey" # String | API Key

try {
    $Result = Invoke-RGSAPrepayCodesPercentPercentGet -Percent $Percent -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAPrepayCodesPercentPercentGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Percent Double
ApiKey String API Key

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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