Get-PFinancialAidDisbursements

NAME Get-PFinancialAidDisbursements



SYNOPSIS

Returns all disbursements (whether original, to source, or to student) for a particular aid year (see

getFinancialAidYears).





SYNTAX

Get-PFinancialAidDisbursements [-PopuliUri] <String> [-PopuliAuthkey] <String> [-AidYearId] <Int32> [-Type]

<String> [[-AwardTypeId] <Int32>] [[-TermId] <Int32>] [[-PersonId] <Int32>] [<CommonParameters>]





DESCRIPTION

You must have the Financial Aid, Financial Admin or Student Billing role to call this task.





PARAMETERS

-PopuliUri <String>

Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).

This parameter is required.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PopuliAuthkey <String>

The authentication key with necessary permissions for the data you are requesting.

You must have the Registrar or Academic Admin role to call this task.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AidYearId <Int32>

The numeric ID of an aid year (see Get-PFinancialAidYears)

This parameter is required.



Required? true

Position? 3

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Type <String>

Possible values: DISBURSEMENT, REFUND_TO_SOURCE, REFUND_TO_STUDENT.

This parameter is required.



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AwardTypeId <Int32>

The numeric ID of an award type (see Get-PFinancialAidAwardTypes).



Required? false

Position? 5

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-TermId <Int32>

The numeric ID of an academic term.



Required? false

Position? 6

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-PersonId <Int32>

The numeric ID of a student.



Required? false

Position? 7

Default value 0

Accept pipeline input? false

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

Returns PowerShell objects:

DisbursementId

AwardId

Type

Amount

ScheduledDate

StatusDate

PostedDate

Status

AidApplicationId

AidApplicationStatus

PersonId

LastName

FirstName

PreferredName

StudentId

AwardTypeId

AwardName

Abbrv

TermId

TermName





NOTES





Author: Matthew Rehm

Creation Date: 04/03/2019



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



PS C:\\>#Get Disbursements for an AidAwardYear



Get-PFinancialAidDisbursements -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey

'123456789' -AidYearId 22 -Type DISBURSEMENT









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



PS C:\\># Run for a specific award year an award type.



Get-PFinancialAidDisbursements @PopuliCredencials -AidYearId 22 -Type DISBURSEMENT -AwardTypeId 16923











RELATED LINKS