IClientService1

Operations

NameSignatureDescription
Activatevoid Activate(Uri clientUri)Makes the specified client active, making it available for use by projects.
BulkDeleteClientBulkDeleteResults1 BulkDelete(Uri[] clientUris, Uri clientBulkDeleteOptionUri)Delete many clients
BulkGetClientDetailsClientDetails1[] BulkGetClientDetails(Uri[] clientUris)Get details of for a list of clients
BulkGetClientsClientReference1[] BulkGetClients(Uri[] clientUris)Bulk get client references from their URI. If a URI is not found, it will be omitted from the results.
CreateClientDeleteBatchUri CreateClientDeleteBatch(ClientTargetParameter1[] clients, Uri clientBulkDeleteOptionUri)Create a batch operation for bulk deleting clients by target
CreateClientOrApplyModificationsClientReference1 CreateClientOrApplyModifications(ClientTargetParameter1 target, ClientModificationsParameter1 modifications, String unitOfWorkId)Create new client or apply modifications
CreateEditDraftUri CreateEditDraft(Uri clientUri)Create a draft of an existing client.
CreateNewDraftUri CreateNewDraft()Create a new client draft.
Deletevoid Delete(Uri clientUri)Delete a client
DeleteClientBillingRateScheduleEntryvoid DeleteClientBillingRateScheduleEntry(Uri scheduleEntryUri)Remove a rate schedule entry; the preceeding entry will be extended to cover the specified entry's time period. An UnmodifiableScheduleEntryError1 error will occur when attempting to delete the initial rate entry.
GetAllClientManagersAssignedToClientsClientManagerReference1[] GetAllClientManagersAssignedToClients(ClientManagerSearchParameter1 search)Retrieves the list of client managers that are associated with one or more clients
GetBillableAmountSeriesClientBillableAmountSeries1 GetBillableAmountSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri)Retrieve historical billing data for a client.
GetBillableAmountSummaryClientBillableAmountSummary1 GetBillableAmountSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri)Retrieve actual and estimated billable amounts for a client.
GetBillingByBillingRateSummaryClientBillingByBillingRateSummary1 GetBillingByBillingRateSummary(Uri clientUri)Gets the billing summary for each billing rate that has been used for billing against this client
GetBillingRateFrequenciesAvailableForClientBillingRatesBillingRateFrequencyReference1[] GetBillingRateFrequenciesAvailableForClientBillingRates()Get all enabled Billing rate frequencies for the clientBillingRate.
GetBillingRatesClientBillingRateDetails1[] GetBillingRates(Uri clientUri, Date1 asOfDate)Get all hourly billing rates related to this client
GetBillingRates2ClientBillingRateDetails2[] GetBillingRates2(Uri clientUri, Date1 asOfDate)Get all billing rates related to this client
GetBillingRateSettingForNewClientsClientBillingRateSettingDetails1 GetBillingRateSettingForNewClients()Gets the system-wide client settings
GetBillingRatesWhichCouldBeAllowedByDefaultOnNewProjectsClientBillingRateDetails1[] GetBillingRatesWhichCouldBeAllowedByDefaultOnNewProjects(Uri clientUri, Date1 asOfDate)Gets the billing rates that could be allowed by default on new projects for the specified client, but currently are not
GetChargesByExpenseCodeSummaryClientChargesByExpenseCodeSummary1 GetChargesByExpenseCodeSummary(Uri clientUri)Gets the charge summary for each expense code that have been charged against this client
GetClientBillingRateDetailsClientBillingRateScheduleEntryDetails1 GetClientBillingRateDetails(Uri clientUri, Date1 asOfDate)Get the client billing rate schedule entry for the specified client on the specified date, or today if not specified
GetClientBillingRateScheduleClientBillingRateScheduleDetails1 GetClientBillingRateSchedule(Uri clientUri, Uri billingRateUri, BillingRateFrequencyTargetParameter1 billingRateFrequency)Retrieves the comprehensive rate schedule of the specified billing rate on the specified client
GetClientDeleteBatchResultsClientDeleteBatchResults1 GetClientDeleteBatchResults(Uri clientDeleteBatchUri)Retrieve results of a completed ClientDeleteBatch operation. Returns null if the batch has not completed.
GetClientDetailsClientDetails1 GetClientDetails(Uri clientUri)Get details of a specific client
GetClientNameFormatForNewUsersUri GetClientNameFormatForNewUsers()Get the client name format preference to be used for new users
GetClientNameFormatForUserUri GetClientNameFormatForUser(Uri userUri)Get the current user's client name format preference
GetClientReferenceFromSlugClientReference1 GetClientReferenceFromSlug(String clientSlug)Retrieve a basic client reference from a client slug.
GetClientRepresentativeAssignmentsUserReference1[] GetClientRepresentativeAssignments(Uri clientUri)Retrieves the list of client representatives assigned to the client
GetCostAmountSeriesClientCostAmountSeries1 GetCostAmountSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri)Retrieve historical cost data for a client.
GetCostAmountSummaryClientCostAmountSummary1 GetCostAmountSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri)Retrieve actual and estimated cost amounts for a client.
GetEligibleClientManagersClientManagerReference1[] GetEligibleClientManagers(Uri clientUri)Retrieves the list of users that are eligible to be 'client managers' for this client
GetExpenseCodesClientExpenseCodeDetails1[] GetExpenseCodes(Uri clientUri)Gets the expense codes that could be allowed for the specified client, but currently are not
GetExpenseCodesAllowedByDefaultOnNewProjectsClientExpenseCodeDetails1[] GetExpenseCodesAllowedByDefaultOnNewProjects(Uri clientUri)Retrieves the list of expense codes which will be allowed by default on any new project created for a client.
GetExpenseCodesWhichCouldBeAllowedByDefaultOnNewProjectsClientExpenseCodeDetails1[] GetExpenseCodesWhichCouldBeAllowedByDefaultOnNewProjects(Uri clientUri)Gets the expense codes that could be allowed for the specified client, but currently are not
GetExplicitSharingAssignmentsClientSharingAssignmentDetails1[] GetExplicitSharingAssignments(Uri clientUri)Retrieves the list of who the client is shared with
GetNumberOfResourcesLoggingTimeSeriesNumberOfResourcesLoggingTimeSeries1 GetNumberOfResourcesLoggingTimeSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri)Retrieve historical numbers of resources who have entered time for this client.
GetResourceAssignmentSummaryResourceAssignmentSummary1 GetResourceAssignmentSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri)Retrieve the number of resource assignments for a client.
GetTimeEnteredSeriesClientTimeEnteredSeries1 GetTimeEnteredSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri)Retrieve historical hours data for a client.
GetTimeEnteredSummaryClientTimeEnteredSummary1 GetTimeEnteredSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri)Retrieve actual and estimated hours for a client.
GetUriFromSlugUri GetUriFromSlug(String clientSlug)Retrieve a client URI from a client slug.
Inactivatevoid Inactivate(Uri clientUri)Makes the specified client inactive, making it unavailable for use by projects.
InsertBillingRateIntoClientBillingRateSchedulevoid InsertBillingRateIntoClientBillingRateSchedule(Uri clientUri, Uri billingRateUri, BillingRateFrequencyTargetParameter1 billingRateFrequency, Date1 effectiveDate, MoneyParameter1 rate)Update the hourly rate of the specified billing rate on the specified client for the specified time period setting the end date to one less than the start of the next rate
PublishDraftClientReference1 PublishDraft(Uri draftUri)Publish the client draft into a persisted client.
PutBillingRatesAllowedByDefaultOnNewProjectsvoid PutBillingRatesAllowedByDefaultOnNewProjects(Uri clientUri, Uri[] billingRateUris)Specifies the set of billing rates that are the defaults allowed on a project using this client
PutClientClientReference1 PutClient(ClientParameter1 client)Put the entire client details. If ClientParameter1.target.name is specified and not found, it will create that client
PutClientBillingRateSchedulevoid PutClientBillingRateSchedule(Uri clientUri, Uri billingRateUri, MoneyParameter1 initialRate, RateScheduleEntryParameter1[] scheduleEntries, BillingRateFrequencyTargetParameter1 billingRateFrequency)Put the entire billing rate schedule for the specified client
PutClientRepresentativeAssignmentsvoid PutClientRepresentativeAssignments(Uri clientUri, Uri[] clientRepresentativeUris)Put the entire list of client representatives assigned to the client
PutExpenseCodesAllowedByDefaultOnNewProjectsvoid PutExpenseCodesAllowedByDefaultOnNewProjects(Uri clientUri, Uri[] expenseCodeUris)Sets the entire list of expense codes which are allowed by default on any new project created for a client.
PutExplicitSharingAssignmentsvoid PutExplicitSharingAssignments(Uri clientUri, Uri[] sharedUris)Put the entire list of who the client is shared with
UpdateBillingAddressvoid UpdateBillingAddress(Uri clientUri, ClientAddressParameter1 billingAddress)Update the billing address for a client.
UpdateBillingContactvoid UpdateBillingContact(Uri clientUri, String billingContact)Modify the billing contact for a client.
UpdateBillingRateIsAllowedByDefaultOnNewProjectsvoid UpdateBillingRateIsAllowedByDefaultOnNewProjects(Uri clientUri, Uri billingRateUri, Boolean isAllowedByDefaultOnNewProjects)Updates whether or not the specific billing rate that will be assigned to a project when this client is applied to a project
UpdateBillingRateSettingForNewClientsvoid UpdateBillingRateSettingForNewClients(ClientBillingRateSettingParameter1 clientBillingRateSetting)Update the system-wide setting for adding all the available billing rates on client creation automatically
UpdateClientAddressvoid UpdateClientAddress(Uri clientUri, ClientAddressParameter1 clientAddress)Update the address for a client.
UpdateClientBillingRateScheduleEntryEffectiveDatevoid UpdateClientBillingRateScheduleEntryEffectiveDate(Uri scheduleEntryUri, Date1 date)Modify the effective date of a specific rate schedule entry. An UnmodifiableScheduleEntryError1 error will occur when attempting to modify the date of the initial rate.
UpdateClientBillingRateScheduleEntryRateValuevoid UpdateClientBillingRateScheduleEntryRateValue(Uri scheduleEntryUri, MoneyParameter1 rate)Modify the rate value of a specific historical rate entry. The scheduleEntryUri should be a Uri from the GetClientBillingRateSchedule service.
UpdateClientBillingRateScheduleOverDateRangevoid UpdateClientBillingRateScheduleOverDateRange(Uri clientUri, Uri billingRateUri, DateRangeParameter1 dateRange, MoneyParameter1 rate, BillingRateFrequencyTargetParameter1 billingRateFrequency)Specifies the rate to use for the specified billing rate on the specified client. If the endDate is not specified, that rate will be used from the effectiveDate onwards.
UpdateClientManagervoid UpdateClientManager(Uri clientUri, Uri clientManagerUri)Update the client manager for a single client by URI.
UpdateClientNameFormatForNewUsersvoid UpdateClientNameFormatForNewUsers(Uri clientNameFormatUri)Change the client name format preference to be used for new users
UpdateClientNameFormatForUservoid UpdateClientNameFormatForUser(Uri userUri, Uri clientNameFormatUri)Change the current user's client name format preference
UpdateCodevoid UpdateCode(Uri clientUri, String code)Modify the code of a client or client draft.
UpdateCommentvoid UpdateComment(Uri clientUri, String comment)Modify the comment of a client or client draft.
UpdateDefaultBillingCurrencyvoid UpdateDefaultBillingCurrency(Uri clientUri, CurrencyTargetParameter1 currency)Update the default billing currency for a single client by URI.
UpdateExpenseCodeIsAllowedByDefaultOnNewProjectsvoid UpdateExpenseCodeIsAllowedByDefaultOnNewProjects(Uri clientUri, Uri expenseCodeUri, Boolean isAllowedByDefaultOnNewProjects)Sets an expense code as allowed (or disallowed) by default on any new project created for a client.
UpdateNamevoid UpdateName(Uri clientUri, String name)Modify the name of a client or client draft.
ValidateValidationResultsSummary1 Validate(Uri clientUri)Validate a client