Get-YnabTransaction

NAME Get-YnabTransaction



SYNOPSIS

List YNAB transactions.





SYNTAX

Get-YnabTransaction [-Budget] <String> [-Type <String>] [-SinceDate <DateTime>] [-NoParse] [-Token] <Object>

[<CommonParameters>]



Get-YnabTransaction [-Budget] <String> [[-Account] <String[]>] [[-Category] <String[]>] [[-Payee] <String[]>]

[-Type <String>] [-SinceDate <DateTime>] [-Token] <Object> [<CommonParameters>]



Get-YnabTransaction [-Budget] <String> -TransactionID <String[]> [-Token] <Object> [<CommonParameters>]





DESCRIPTION

List YNAB transactions.





PARAMETERS

-Budget <String>

The budget to list transactions from.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Account <String[]>

The account or accounts to select transactions from.



Required? false

Position? 2

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Category <String[]>

The category or categories to select transactions from.



Required? false

Position? 3

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Payee <String[]>

The payee or payees to select transactions from.



Required? false

Position? 4

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Type <String>

Only return transactions of a certain type (???????????????uncategorized?????????????????? and ???????????????unapproved?????????????????? are currently supported)



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SinceDate <DateTime>

Only return transactions on or after this date.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TransactionID <String[]>

Return details for a transaction or list of transactions by ID.



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-NoParse [<SwitchParameter>]

Return the raw JSON data from the YNAB API. Only query parameters will be applied.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Token <Object>

YNAB API token.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-YnabTransaction -Budget 'TestBudget'



Lists all transactions for TestBudget.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-YnabTransaction -Budget 'TestBudget' -Type unapproved -SinceDate 2018-04-15



Lists all unapproved transactions for TestBudget since April 4 2018.









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>GetYnabTransaction -Budget 'TestBudget' -Account 'Checking','Cash' -Category 'Dining'



Lists all Dining transactions made from the Checking or Cash accounts for TestBudget.











RELATED LINKS