Skip to content

RGSAHistoryApi.md

Latest commit

 

History

History
193 lines (150 loc) · 9.93 KB

RGSAHistoryApi.md

File metadata and controls

193 lines (150 loc) · 9.93 KB
Raw

RealGreenSaPS.RealGreenSaPS\Api.RGSAHistoryApi

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

Method HTTP request Description
Invoke-RGSAHistorySearchPost POST /History/Search Search for history records for a specic customer.
Invoke-RGSAHistoryTransactionSearchGet GET /History/Transaction/Search Search for history records.
Invoke-RGSAHistoryTransactionSearchPost POST /History/Transaction/Search Search for history records.

Invoke-RGSAHistorySearchPost

Boolean Invoke-RGSAHistorySearchPost
        [-ApiKey]
        [-HistoryItemSearch]

Search for history records for a specic customer.

Example

$ApiKey = "MyApiKey" # String | API Key
$DateTimeRange = Initialize-DateTimeRange -MinValue (Get-Date) -MaxValue (Get-Date)
$HistoryItemSearch = Initialize-HistoryItemSearch -CustomerNumber 0 -DateTimeRange $DateTimeRange -TransactionCodes "MyTransactionCodes" # HistoryItemSearch |  (optional)

# Search for history records for a specic customer.
try {
    $Result = Invoke-RGSAHistorySearchPost -ApiKey $ApiKey -HistoryItemSearch $HistoryItemSearch
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAHistorySearchPost: {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
HistoryItemSearch HistoryItemSearch [optional]

Return type

Boolean

Authorization

No authorization required

HTTP request headers

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

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

Invoke-RGSAHistoryTransactionSearchGet

Boolean Invoke-RGSAHistoryTransactionSearchGet
        [-ApiKey]
        [-CustomerNumbers]
        [-CompanyIDs]
        [-TransactionDateRangeMinValue] <System.Nullable[System.DateTime]>
        [-TransactionDateRangeMaxValue] <System.Nullable[System.DateTime]>
        [-PostedDateRangeMinValue] <System.Nullable[System.DateTime]>
        [-PostedDateRangeMaxValue] <System.Nullable[System.DateTime]>
        [-GeneralLedgerDateRangeMinValue] <System.Nullable[System.DateTime]>
        [-GeneralLedgerDateRangeMaxValue] <System.Nullable[System.DateTime]>
        [-EnteredBy]
        [-AdjustmentCodes]
        [-TransactionCodes]
        [-CreatedDateRangeMinValue] <System.Nullable[System.DateTime]>
        [-CreatedDateRangeMaxValue] <System.Nullable[System.DateTime]>
        [-UpdatedDateRangeMinValue] <System.Nullable[System.DateTime]>
        [-UpdatedDateRangeMaxValue] <System.Nullable[System.DateTime]>
        [-Records] <System.Nullable[Int32]>
        [-Offset] <System.Nullable[Int32]>

Search for history records.

Example

$ApiKey = "MyApiKey" # String | API Key
$CustomerNumbers = "MyCustomerNumbers" # String |  (optional)
$CompanyIDs = "MyCompanyIDs" # String |  (optional)
$TransactionDateRangeMinValue = (Get-Date) # System.DateTime |  (optional)
$TransactionDateRangeMaxValue = (Get-Date) # System.DateTime |  (optional)
$PostedDateRangeMinValue = (Get-Date) # System.DateTime |  (optional)
$PostedDateRangeMaxValue = (Get-Date) # System.DateTime |  (optional)
$GeneralLedgerDateRangeMinValue = (Get-Date) # System.DateTime |  (optional)
$GeneralLedgerDateRangeMaxValue = (Get-Date) # System.DateTime |  (optional)
$EnteredBy = "MyEnteredBy" # String |  (optional)
$AdjustmentCodes = "MyAdjustmentCodes" # String |  (optional)
$TransactionCodes = "MyTransactionCodes" # String |  (optional)
$CreatedDateRangeMinValue = (Get-Date) # System.DateTime |  (optional)
$CreatedDateRangeMaxValue = (Get-Date) # System.DateTime |  (optional)
$UpdatedDateRangeMinValue = (Get-Date) # System.DateTime |  (optional)
$UpdatedDateRangeMaxValue = (Get-Date) # System.DateTime |  (optional)
$Records = 56 # Int32 |  (optional)
$Offset = 56 # Int32 |  (optional)

# Search for history records.
try {
    $Result = Invoke-RGSAHistoryTransactionSearchGet -ApiKey $ApiKey -CustomerNumbers $CustomerNumbers -CompanyIDs $CompanyIDs -TransactionDateRangeMinValue $TransactionDateRangeMinValue -TransactionDateRangeMaxValue $TransactionDateRangeMaxValue -PostedDateRangeMinValue $PostedDateRangeMinValue -PostedDateRangeMaxValue $PostedDateRangeMaxValue -GeneralLedgerDateRangeMinValue $GeneralLedgerDateRangeMinValue -GeneralLedgerDateRangeMaxValue $GeneralLedgerDateRangeMaxValue -EnteredBy $EnteredBy -AdjustmentCodes $AdjustmentCodes -TransactionCodes $TransactionCodes -CreatedDateRangeMinValue $CreatedDateRangeMinValue -CreatedDateRangeMaxValue $CreatedDateRangeMaxValue -UpdatedDateRangeMinValue $UpdatedDateRangeMinValue -UpdatedDateRangeMaxValue $UpdatedDateRangeMaxValue -Records $Records -Offset $Offset
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAHistoryTransactionSearchGet: {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
CustomerNumbers String [optional]
CompanyIDs String [optional]
TransactionDateRangeMinValue System.DateTime [optional]
TransactionDateRangeMaxValue System.DateTime [optional]
PostedDateRangeMinValue System.DateTime [optional]
PostedDateRangeMaxValue System.DateTime [optional]
GeneralLedgerDateRangeMinValue System.DateTime [optional]
GeneralLedgerDateRangeMaxValue System.DateTime [optional]
EnteredBy String [optional]
AdjustmentCodes String [optional]
TransactionCodes String [optional]
CreatedDateRangeMinValue System.DateTime [optional]
CreatedDateRangeMaxValue System.DateTime [optional]
UpdatedDateRangeMinValue System.DateTime [optional]
UpdatedDateRangeMaxValue System.DateTime [optional]
Records Int32 [optional]
Offset Int32 [optional]

Return type

Boolean

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-RGSAHistoryTransactionSearchPost

Boolean Invoke-RGSAHistoryTransactionSearchPost
        [-ApiKey]
        [-HistorySearch]

Search for history records.

Example

$ApiKey = "MyApiKey" # String | API Key
$DateTimeRange = Initialize-DateTimeRange -MinValue (Get-Date) -MaxValue (Get-Date)
$HistorySearch = Initialize-HistorySearch -Records 0 -Offset 0 -CustomerNumbers 0 -CompanyIDs 0 -TransactionDateRange $DateTimeRange -PostedDateRange $DateTimeRange -GeneralLedgerDateRange $DateTimeRange -EnteredBy "MyEnteredBy" -AdjustmentCodes "MyAdjustmentCodes" -TransactionCodes "Adjustment" -CreatedDateRange $DateTimeRange -UpdatedDateRange $DateTimeRange # HistorySearch |  (optional)

# Search for history records.
try {
    $Result = Invoke-RGSAHistoryTransactionSearchPost -ApiKey $ApiKey -HistorySearch $HistorySearch
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAHistoryTransactionSearchPost: {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
HistorySearch HistorySearch [optional]

Return type

Boolean

Authorization

No authorization required

HTTP request headers

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

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