Skip to content

Latest commit

 

History

History
1279 lines (1025 loc) · 21.7 KB

New-CWMAgreement.md

File metadata and controls

1279 lines (1025 loc) · 21.7 KB
external help file Module Name online version schema
ConnectWiseManageAPI-help.xml
ConnectWiseManageAPI
2.0.0

New-CWMAgreement

SYNOPSIS

This function will allow you to search for Manage configurations.

SYNTAX

New-CWMAgreement [[-id] <Int32>] [-name] <String> [[-type] <Hashtable>] [[-company] <Hashtable>]
 [[-contact] <Hashtable>] [[-site] <Hashtable>] [[-subContractCompany] <Hashtable>]
 [[-subContractContact] <Hashtable>] [[-parentAgreement] <Hashtable>] [[-customerPO] <String>]
 [[-location] <Hashtable>] [[-department] <Hashtable>] [[-restrictLocationFlag] <Boolean>]
 [[-restrictDepartmentFlag] <Boolean>] [[-startDate] <String>] [[-endDate] <String>]
 [[-noEndingDateFlag] <Boolean>] [[-opportunity] <Hashtable>] [[-cancelledFlag] <Boolean>]
 [[-dateCancelled] <String>] [[-reasonCancelled] <String>] [[-sla] <Hashtable>] [[-workOrder] <String>]
 [[-internalNotes] <String>] [[-applicationUnits] <String>] [[-applicationLimit] <Double>]
 [[-applicationCycle] <String>] [[-applicationUnlimitedFlag] <Boolean>] [[-oneTimeFlag] <Boolean>]
 [[-coverAgreementTime] <Boolean>] [[-coverAgreementProduct] <Boolean>] [[-coverAgreementExpense] <Boolean>]
 [[-coverSalesTax] <Boolean>] [[-carryOverUnused] <Boolean>] [[-allowOverruns] <Boolean>]
 [[-expiredDays] <Int32>] [[-limit] <Int32>] [[-expireWhenZero] <Boolean>] [[-chargeToFirm] <Boolean>]
 [[-employeeCompRate] <String>] [[-employeeCompNotExceed] <String>] [[-compHourlyRate] <Double>]
 [[-compLimitAmount] <Double>] [[-billingCycle] <Hashtable>] [[-billOneTimeFlag] <Boolean>]
 [[-billingTerms] <Hashtable>] [[-invoicingCycle] <String>] [[-billToCompany] <Hashtable>]
 [[-billToContact] <Hashtable>] [[-billToSite] <Hashtable>] [[-billAmount] <Double>] [[-taxable] <Boolean>]
 [[-prorateFirstBill] <Double>] [[-billStartDate] <String>] [[-taxCode] <Hashtable>]
 [[-restrictDownPayment] <Boolean>] [[-prorateFlag] <Boolean>] [[-invoiceDescription] <String>]
 [[-topComment] <Boolean>] [[-bottomComment] <Boolean>] [[-workRole] <Hashtable>] [[-workType] <Hashtable>]
 [[-projectType] <Hashtable>] [[-invoiceTemplate] <Hashtable>] [[-billTime] <String>]
 [[-billExpenses] <String>] [[-billProducts] <String>] [[-billableTimeInvoice] <Boolean>]
 [[-billableExpenseInvoice] <Boolean>] [[-billableProductInvoice] <Boolean>] [[-currency] <Hashtable>]
 [[-periodType] <String>] [[-autoInvoiceFlag] <Boolean>] [[-nextInvoiceDate] <String>]
 [[-companyLocation] <Hashtable>] [[-agreementStatus] <String>] [[-_info] <Hashtable>]
 [[-customFields] <Array>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-CWTimeSheet -Condition 'member/identifier="ctaylor" and status = "Open"'

This will return all the open time sheets for ctaylor

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

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

Required: False
Position: Named
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: None
Accept pipeline input: False
Accept wildcard characters: False

-_info

{{ Fill _info Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-agreementStatus

{{ Fill agreementStatus Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Active, Cancelled, Expired, Inactive

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

-allowOverruns

{{ Fill allowOverruns Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-applicationCycle

{{ Fill applicationCycle Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Contract2Weeks, Contract4Weeks, ContractYear, CalendarMonth, CalendarQuarter, CalendarWeek, ContractQuarter, CalendarYear

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

-applicationLimit

{{ Fill applicationLimit Description }}

Type: Double
Parameter Sets: (All)
Aliases:

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

-applicationUnits

{{ Fill applicationUnits Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Amount, Hours, Incidents

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

-applicationUnlimitedFlag

{{ Fill applicationUnlimitedFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-autoInvoiceFlag

{{ Fill autoInvoiceFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-billAmount

{{ Fill billAmount Description }}

Type: Double
Parameter Sets: (All)
Aliases:

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

-billExpenses

{{ Fill billExpenses Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Billable, DoNotBill, NoCharge, NoDefault

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

-billOneTimeFlag

{{ Fill billOneTimeFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-billProducts

{{ Fill billProducts Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Billable, DoNotBill, NoCharge, NoDefault

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

-billStartDate

{{ Fill billStartDate Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-billTime

{{ Fill billTime Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Billable, DoNotBill, NoCharge, NoDefault

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

-billToCompany

{{ Fill billToCompany Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-billToContact

{{ Fill billToContact Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-billToSite

{{ Fill billToSite Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-billableExpenseInvoice

{{ Fill billableExpenseInvoice Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-billableProductInvoice

{{ Fill billableProductInvoice Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-billableTimeInvoice

{{ Fill billableTimeInvoice Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-billingCycle

{{ Fill billingCycle Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-billingTerms

{{ Fill billingTerms Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-bottomComment

{{ Fill bottomComment Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-cancelledFlag

{{ Fill cancelledFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-carryOverUnused

{{ Fill carryOverUnused Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-chargeToFirm

{{ Fill chargeToFirm Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-compHourlyRate

{{ Fill compHourlyRate Description }}

Type: Double
Parameter Sets: (All)
Aliases:

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

-compLimitAmount

{{ Fill compLimitAmount Description }}

Type: Double
Parameter Sets: (All)
Aliases:

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

-company

{{ Fill company Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-companyLocation

{{ Fill companyLocation Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-contact

{{ Fill contact Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-coverAgreementExpense

{{ Fill coverAgreementExpense Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-coverAgreementProduct

{{ Fill coverAgreementProduct Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-coverAgreementTime

{{ Fill coverAgreementTime Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-coverSalesTax

{{ Fill coverSalesTax Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-currency

{{ Fill currency Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-customFields

{{ Fill customFields Description }}

Type: Array
Parameter Sets: (All)
Aliases:

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

-customerPO

{{ Fill customerPO Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-dateCancelled

{{ Fill dateCancelled Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-department

{{ Fill department Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-employeeCompNotExceed

{{ Fill employeeCompNotExceed Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Billing, Amount, Percent

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

-employeeCompRate

{{ Fill employeeCompRate Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Actual, Hourly

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

-endDate

{{ Fill endDate Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-expireWhenZero

{{ Fill expireWhenZero Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-expiredDays

{{ Fill expiredDays Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

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

-id

{{ Fill id Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

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

-internalNotes

{{ Fill internalNotes Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-invoiceDescription

{{ Fill invoiceDescription Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-invoiceTemplate

{{ Fill invoiceTemplate Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-invoicingCycle

{{ Fill invoicingCycle Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: ContractYear, CalendarYear

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

-limit

{{ Fill limit Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

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

-location

{{ Fill location Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-name

{{ Fill name Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-nextInvoiceDate

{{ Fill nextInvoiceDate Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-noEndingDateFlag

{{ Fill noEndingDateFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-oneTimeFlag

{{ Fill oneTimeFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-opportunity

{{ Fill opportunity Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-parentAgreement

{{ Fill parentAgreement Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-periodType

{{ Fill periodType Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Current, Future, Both, Undefined

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

-projectType

{{ Fill projectType Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-prorateFirstBill

{{ Fill prorateFirstBill Description }}

Type: Double
Parameter Sets: (All)
Aliases:

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

-prorateFlag

{{ Fill prorateFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-reasonCancelled

{{ Fill reasonCancelled Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-restrictDepartmentFlag

{{ Fill restrictDepartmentFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-restrictDownPayment

{{ Fill restrictDownPayment Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-restrictLocationFlag

{{ Fill restrictLocationFlag Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-site

{{ Fill site Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-sla

{{ Fill sla Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-startDate

{{ Fill startDate Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-subContractCompany

{{ Fill subContractCompany Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-subContractContact

{{ Fill subContractContact Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-taxCode

{{ Fill taxCode Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-taxable

{{ Fill taxable Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-topComment

{{ Fill topComment Description }}

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-type

{{ Fill type Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-workOrder

{{ Fill workOrder Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-workRole

{{ Fill workRole Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-workType

{{ Fill workType Description }}

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 61
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

None

OUTPUTS

System.Object

NOTES

Author: Chris Taylor Date: 1/7/2019

RELATED LINKS