Skip to content

Update-CWMAgreementAddition.md

Latest commit

 

History

History
174 lines (136 loc) · 3.21 KB

Update-CWMAgreementAddition.md

File metadata and controls

174 lines (136 loc) · 3.21 KB
external help file ConnectWiseManageAPI-help.xml
Module Name ConnectWiseManageAPI
online version
schema 2.0.0

Update-CWMAgreementAddition

SYNOPSIS

This will update an addition to an agreement.

SYNTAX

Update-CWMAgreementAddition -parentId <Int32> -id <Int32> [-Operation] <String> [-Path] <String>
 [-Value] <Object> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

$UpdateParam = @{
    AgreementID = $Agreement.id     
    AdditionID = $Addition.id     
    Operation = 'replace'     
    Path = 'quantity'     
    Value = $Count 
} 
Update-CWMAgreementAddition @UpdateParam

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Operation

What you are doing with the value. add, replace, remove

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: add, replace, remove

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

The value that you want to perform the operation on.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Value

The value of that operation.

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-id

{{ Fill id Description }}

Type: Int32
Parameter Sets: (All)
Aliases: additionId

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-parentId

{{ Fill parentId Description }}

Type: Int32
Parameter Sets: (All)
Aliases: agreementId

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Author: Chris Taylor Date: 10/10/2018

RELATED LINKS

https://developer.connectwise.com/manage/rest?a=Finance&e=AgreementAdditions&o=UPDATE