Name | Signature | Description |
---|
Activate | void Activate(Uri clientUri) | Makes the specified client active, making it available for use by projects. |
BulkDelete | ClientBulkDeleteResults1 BulkDelete(Uri[] clientUris, Uri clientBulkDeleteOptionUri) | Delete many clients |
BulkGetClientDetails | ClientDetails1[] BulkGetClientDetails(Uri[] clientUris) | Get details of for a list of clients |
BulkGetClients | ClientReference1[] BulkGetClients(Uri[] clientUris) | Bulk get client references from their URI. If a URI is not found, it will be omitted from the results. |
BulkGetExplicitSharingAssignments | BulkGetExplicitClientSharingAssignmentsResult1[] BulkGetExplicitSharingAssignments(Uri[] clientUris) | Bulk retrieve sharing assignments for each client |
CreateClientDeleteBatch | Uri CreateClientDeleteBatch(ClientTargetParameter1[] clients, Uri clientBulkDeleteOptionUri) | Create a batch operation for bulk deleting clients by target |
CreateClientOrApplyModifications | ClientReference1 CreateClientOrApplyModifications(ClientTargetParameter1 target, ClientModificationsParameter1 modifications, Uri clientModificationOptionUri, String unitOfWorkId) | Create new client or apply modifications |
CreateEditDraft | Uri CreateEditDraft(Uri clientUri) | Create a draft of an existing client. |
CreateNewDraft | Uri CreateNewDraft() | Create a new client draft. |
Delete | void Delete(Uri clientUri) | Delete a client |
DeleteClientBillingRateScheduleEntry | void 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. |
GetAllClientManagersAssignedToClients | ClientManagerReference1[] GetAllClientManagersAssignedToClients(ClientManagerSearchParameter1 search) | Retrieves the list of client managers that are associated with one or more clients |
GetBillableAmountSeries | ClientBillableAmountSeries1 GetBillableAmountSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri) | Retrieve historical billing data for a client. |
GetBillableAmountSummary | ClientBillableAmountSummary1 GetBillableAmountSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri) | Retrieve actual and estimated billable amounts for a client. |
GetBillingByBillingRateSummary | ClientBillingByBillingRateSummary1 GetBillingByBillingRateSummary(Uri clientUri) | Gets the billing summary for each billing rate that has been used for billing against this client |
GetBillingRateFrequenciesAvailableForClientBillingRates | BillingRateFrequencyReference1[] GetBillingRateFrequenciesAvailableForClientBillingRates() | Get all enabled Billing rate frequencies for the clientBillingRate. |
GetBillingRates | ClientBillingRateDetails1[] GetBillingRates(Uri clientUri, Date1 asOfDate) | Get all hourly billing rates related to this client |
GetBillingRates2 | ClientBillingRateDetails2[] GetBillingRates2(Uri clientUri, Date1 asOfDate) | Get all billing rates related to this client |
GetBillingRateSettingForNewClients | ClientBillingRateSettingDetails1 GetBillingRateSettingForNewClients() | Gets the system-wide client settings |
GetBillingRatesWhichCouldBeAllowedByDefaultOnNewProjects | ClientBillingRateDetails1[] 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 |
GetChargesByExpenseCodeSummary | ClientChargesByExpenseCodeSummary1 GetChargesByExpenseCodeSummary(Uri clientUri) | Gets the charge summary for each expense code that have been charged against this client |
GetClientBillingRateDetails | ClientBillingRateScheduleEntryDetails1 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 |
GetClientBillingRateSchedule | ClientBillingRateScheduleDetails1 GetClientBillingRateSchedule(Uri clientUri, Uri billingRateUri, BillingRateFrequencyTargetParameter1 billingRateFrequency) | Retrieves the comprehensive rate schedule of the specified billing rate on the specified client |
GetClientDeleteBatchResults | ClientDeleteBatchResults1 GetClientDeleteBatchResults(Uri clientDeleteBatchUri) | Retrieve results of a completed ClientDeleteBatch operation. Returns null if the batch has not completed. |
GetClientDetails | ClientDetails1 GetClientDetails(Uri clientUri) | Get details of a specific client |
GetClientNameAndCodeUniquenessRequirements | Uri GetClientNameAndCodeUniquenessRequirements() | Get the system-wide setting for name and code uniqueness |
GetClientNameFormatForNewUsers | Uri GetClientNameFormatForNewUsers() | Get the client name format preference to be used for new users |
GetClientNameFormatForUser | Uri GetClientNameFormatForUser(Uri userUri) | Get the current user's client name format preference |
GetClientReferenceFromSlug | ClientReference1 GetClientReferenceFromSlug(String clientSlug) | Retrieve a basic client reference from a client slug. |
GetClientRepresentativeAssignments | UserReference1[] GetClientRepresentativeAssignments(Uri clientUri) | Retrieves the list of client representatives assigned to the client |
GetCostAmountSeries | ClientCostAmountSeries1 GetCostAmountSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri) | Retrieve historical cost data for a client. |
GetCostAmountSummary | ClientCostAmountSummary1 GetCostAmountSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri) | Retrieve actual and estimated cost amounts for a client. |
GetEligibleClientManagers | ClientManagerReference1[] GetEligibleClientManagers(Uri clientUri) | Retrieves the list of users that are eligible to be 'client managers' for this client |
GetExpenseCodes | ClientExpenseCodeDetails1[] GetExpenseCodes(Uri clientUri) | Gets the expense codes that could be allowed for the specified client, but currently are not |
GetExpenseCodesAllowedByDefaultOnNewProjects | ClientExpenseCodeDetails1[] GetExpenseCodesAllowedByDefaultOnNewProjects(Uri clientUri) | Retrieves the list of expense codes which will be allowed by default on any new project created for a client. |
GetExpenseCodesWhichCouldBeAllowedByDefaultOnNewProjects | ClientExpenseCodeDetails1[] GetExpenseCodesWhichCouldBeAllowedByDefaultOnNewProjects(Uri clientUri) | Gets the expense codes that could be allowed for the specified client, but currently are not |
GetExplicitSharingAssignments | ClientSharingAssignmentDetails1[] GetExplicitSharingAssignments(Uri clientUri) | Retrieves the list of who the client is shared with |
GetNumberOfResourcesLoggingTimeSeries | NumberOfResourcesLoggingTimeSeries1 GetNumberOfResourcesLoggingTimeSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri) | Retrieve historical numbers of resources who have entered time for this client. |
GetPageOfAvailableTaxProfilesByTextSearch | TaxProfileReference1[] GetPageOfAvailableTaxProfilesByTextSearch(Int32 page, Int32 pageSize, String textSearch) | Get paged available tax profiles data |
GetResourceAssignmentSummary | ResourceAssignmentSummary1 GetResourceAssignmentSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri) | Retrieve the number of resource assignments for a client. |
GetRevenueAmountSeries | ClientRevenueAmountSeries1 GetRevenueAmountSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri) | Retrieve historical revenue data for a client. |
GetRevenueAmountSummary | ClientRevenueAmountSummary1 GetRevenueAmountSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri) | Retrieve actual revenue amount for a client. |
GetTaxRatesForTaxProfile | TaxRateScheduleEntryDetails[] GetTaxRatesForTaxProfile(TaxProfileTargetParameter1 taxProfile, Date1 asOfDate) | Get the tax rate schedule for the specified tax profile on the specified date, or today if not specified |
GetTimeEnteredSeries | ClientTimeEnteredSeries1 GetTimeEnteredSeries(Uri clientUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri clientSeriesDataFilterOptionUri) | Retrieve historical hours data for a client. |
GetTimeEnteredSummary | ClientTimeEnteredSummary1 GetTimeEnteredSummary(Uri clientUri, Uri clientSummaryDataFilterOptionUri) | Retrieve actual and estimated hours for a client. |
GetTotalActualCostAmountSeries | ClientActualCostAmountSeries1 GetTotalActualCostAmountSeries(Uri[] clientUris, DateRangeParameter1 dateRange, Uri periodResolutionUri) | Retrieve total historical cost data for a set of clients. |
GetTotalActualRevenueAmountSeries | ClientActualRevenueAmountSeries1 GetTotalActualRevenueAmountSeries(Uri[] clientUris, DateRangeParameter1 dateRange, Uri periodResolutionUri) | Retrieve total historical revenue data for a set of clients. |
GetUriFromSlug | Uri GetUriFromSlug(String clientSlug) | Retrieve a client URI from a client slug. |
Inactivate | void Inactivate(Uri clientUri) | Makes the specified client inactive, making it unavailable for use by projects. |
InsertBillingRateIntoClientBillingRateSchedule | void 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 |
PublishDraft | ClientReference1 PublishDraft(Uri draftUri) | Publish the client draft into a persisted client. |
PutBillingRatesAllowedByDefaultOnNewProjects | void PutBillingRatesAllowedByDefaultOnNewProjects(Uri clientUri, Uri[] billingRateUris) | Specifies the set of billing rates that are the defaults allowed on a project using this client |
PutClient | ClientReference1 PutClient(ClientParameter1 client) | Put the entire client details. If ClientParameter1.target.name is specified and not found, it will create that client |
PutClientBillingRateSchedule | void PutClientBillingRateSchedule(Uri clientUri, Uri billingRateUri, MoneyParameter1 initialRate, RateScheduleEntryParameter1[] scheduleEntries, BillingRateFrequencyTargetParameter1 billingRateFrequency) | Put the entire billing rate schedule for the specified client |
PutClientRepresentativeAssignments | void PutClientRepresentativeAssignments(Uri clientUri, Uri[] clientRepresentativeUris) | Put the entire list of client representatives assigned to the client |
PutExpenseCodesAllowedByDefaultOnNewProjects | void 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. |
PutExplicitSharingAssignments | void PutExplicitSharingAssignments(Uri clientUri, Uri[] sharedUris) | Put the entire list of who the client is shared with |
UpdateBillingAddress | void UpdateBillingAddress(Uri clientUri, ClientAddressParameter1 billingAddress) | Update the billing address for a client. |
UpdateBillingContact | void UpdateBillingContact(Uri clientUri, String billingContact) | Modify the billing contact for a client. |
UpdateBillingRateIsAllowedByDefaultOnNewProjects | void 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 |
UpdateBillingRateSettingForNewClients | void UpdateBillingRateSettingForNewClients(ClientBillingRateSettingParameter1 clientBillingRateSetting) | Update the system-wide setting for adding all the available billing rates on client creation automatically |
UpdateBillingSettings | void UpdateBillingSettings(Uri clientUri, KeyValue1[] keyValues) | Update the billing settings for a client. |
UpdateClientAddress | void UpdateClientAddress(Uri clientUri, ClientAddressParameter1 clientAddress) | Update the address for a client. |
UpdateClientBillingRateScheduleEntryEffectiveDate | void 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. |
UpdateClientBillingRateScheduleEntryRateValue | void 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. |
UpdateClientBillingRateScheduleOverDateRange | void 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. |
UpdateClientManager | void UpdateClientManager(Uri clientUri, Uri clientManagerUri) | Update the client manager for a single client by URI. |
UpdateClientNameAndCodeUniquenessRequirements | void UpdateClientNameAndCodeUniquenessRequirements(Uri requirements) | Update the system-wide setting for name and code uniqueness |
UpdateClientNameFormatForNewUsers | void UpdateClientNameFormatForNewUsers(Uri clientNameFormatUri) | Change the client name format preference to be used for new users |
UpdateClientNameFormatForUser | void UpdateClientNameFormatForUser(Uri userUri, Uri clientNameFormatUri) | Change the current user's client name format preference |
UpdateCode | void UpdateCode(Uri clientUri, String code) | Modify the code of a client or client draft. |
UpdateComment | void UpdateComment(Uri clientUri, String comment) | Modify the comment of a client or client draft. |
UpdateDefaultBillingCurrency | void UpdateDefaultBillingCurrency(Uri clientUri, CurrencyTargetParameter1 currency) | Update the default billing currency for a single client by URI. |
UpdateDefaultInvoicePaymentTerm | void UpdateDefaultInvoicePaymentTerm(Uri clientUri, Int32 defaultInvoicePaymentTerm) | Update default payment term for a client. |
UpdateExpenseCodeIsAllowedByDefaultOnNewProjects | void 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. |
UpdateExpenseEntryTypeForClientExpenseCode | void UpdateExpenseEntryTypeForClientExpenseCode(Uri clientUri, Uri expenseCodeUri, Uri expenseEntryTypeUri) | Update the expense entry type for expense code against this client. |
UpdateInvoiceTemplate | void UpdateInvoiceTemplate(Uri clientUri, InvoiceTemplateTargetParameter1 invoiceTemplate) | Update invoice template for a client. |
UpdateName | void UpdateName(Uri clientUri, String name) | Modify the name of a client or client draft. |
UpdateTaxProfile | void UpdateTaxProfile(Uri clientUri, TaxProfileTargetParameter1 taxProfile) | Update tax profile for a client. |
Validate | ValidationResultsSummary1 Validate(Uri clientUri) | Validate a client |