A

Get the details of an account type by id.

Usage:

tq get AccountTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all account types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all account types.

Get details of a specific credit card account

Usage:

tq get Accounts

{"AccountID":"string"}

[{"AccountID":"string"}]

AccountID
"""string"""

Flags:

• --All
  Get details of all the credit card, direct debit, and SEPA accounts for the specified constituent id and all its visible affiliates' accounts as well. To exclude accounts of the visible affiliates pass includeAffiliations=false.

{"AccountTypeID":"string", "ConstituentID":"string", "IncludeAffiliates":"string", "IncludeInactive":"string"}

[{"AccountTypeID":"string","ConstituentID":"string","IncludeAffiliates":"string","IncludeInactive":"string"}]

AccountTypeID,ConstituentID,IncludeAffiliates,IncludeInactive
"""string""","""string""","""string""","""string"""

Get the details of an action type by id.

Usage:

tq get ActionTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all action types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all action types.

Get details of an issue action.

Usage:

tq get Actions

{"IssueActionID":"string"}

[{"IssueActionID":"string"}]

IssueActionID
"""string"""

Flags:

• --All
  Get details of all the actions for the given constituent or issue.

{"ConstituentID":"string", "IssueID":"string"}

[{"ConstituentID":"string","IssueID":"string"}]

ConstituentID,IssueID
"""string""","""string"""

Get the details of an activity category by id.

Usage:

tq get ActivityCategories

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all activity categories. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all activity categories.

Get the details of an activity type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ActivityTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all activity types. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all activity types.

Get the details of an address type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get AddressTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all address types. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all address types.

Get details of an address using addressId as a URL query parameter. Returns 404 Not Found if an address with the specified Id is not found.

Usage:

tq get Addresses

{"AddressID":"string"}

[{"AddressID":"string"}]

AddressID
"""string"""

Flags:

• --All
  Get details of all the addresses for the specified constituent id and all its visible affiliation's addresses as well. To exclude addresses of the visible affiliations pass includeAffiliations=false. To get only the primary addresses, pass primaryOnly=true.

{"ConstituentID":"string", "IncludeAffiliations":"string", "IncludeFromAffiliations":"string", "PrimaryOnly":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string","IncludeFromAffiliations":"string","PrimaryOnly":"string"}]

ConstituentID,IncludeAffiliations,IncludeFromAffiliations,PrimaryOnly
"""string""","""string""","""string""","""string"""

Get the details of an affiliation type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get AffiliationTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All

{"ConstituentTypeID":"string", "Filter":"string", "MaintenanceMode":"string"}

[{"ConstituentTypeID":"string","Filter":"string","MaintenanceMode":"string"}]

ConstituentTypeID,Filter,MaintenanceMode
"""string""","""string""","""string"""

• --Summaries
  Get a summary representation of all affiliation types.

Get details of an affiliation.

Usage:

tq get Affiliations

{"AffiliationID":"string"}

[{"AffiliationID":"string"}]

AffiliationID
"""string"""

Flags:

• --All
  Get details of all the affiliation of the specified individual constituent id or get all the affiliations of the specified group constituent id. If both individual constituent id and group constituent id are specified get all the affiliations between them. To filter the affiliations that are active within certain date then pass values for start date and end date.To fetch primary affiliations alone pass primaryOnly=true. To limit the associations returned to those that are primary or that are marked as showWithGroup, pass showWithGroup=true.

{"EndActiveDate":"string", "GroupConstituentID":"string", "IndividualConstituentID":"string", "PrimaryOnly":"string", "ShowWithGroup":"string", "StartActiveDate":"string"}

[{"EndActiveDate":"string","GroupConstituentID":"string","IndividualConstituentID":"string","PrimaryOnly":"string","ShowWithGroup":"string","StartActiveDate":"string"}]

EndActiveDate,GroupConstituentID,IndividualConstituentID,PrimaryOnly,ShowWithGroup,StartActiveDate
"""string""","""string""","""string""","""string""","""string""","""string"""

Get the details of an alias type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get AliasTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all alias types. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all alias types.

Get details of an alias.

Usage:

tq get Aliases

{"AliasID":"string"}

[{"AliasID":"string"}]

AliasID
"""string"""

Flags:

• --All
  Get details of all the aliases for the specified constituent id and all its visible affiliation's aliases as well. To exclude aliases of the visible affiliations pass includeAffiliations=false.

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

Get the details of an analytics cube.

Usage:

tq get AnalyticsCubes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all analytics cubes. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

Get a single SSRS Report for display in Analytics.

Usage:

tq get AnalyticsReports

{"AnalyticsReportID":"string"}

[{"AnalyticsReportID":"string"}]

AnalyticsReportID
"""string"""

Flags:

• --All
  Get all SSRS Reports for display in Analytics.

Get the details of an App Screen Text by id. To get the resource in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get AppScreenTexts

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get details of all App Screen Texts. To get them in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all App Screen Texts.

Get the details of an appeal category by id.

Usage:

tq get AppealCategories

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all appeal categories. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all appeal categories.

Get details of an Appeal.

Usage:

tq get Appeals

{"AppealID":"string"}

[{"AppealID":"string"}]

AppealID
"""string"""

Flags:

• --Summaries
  Get summary of all Appeals.

{"ActiveOnly":"string"}

[{"ActiveOnly":"string"}]

ActiveOnly
"""string"""

Get all application objects valid for the context usergroup.

Usage:

tq get ApplicationObjects

Get details of an existing artist.

Usage:

tq get Artists

{"ArtistID":"string"}

[{"ArtistID":"string"}]

ArtistID
"""string"""

Flags:

• --All
  Get details of all artists.

Get the details of an asset type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get AssetTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all asset types. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all asset types.

Get details of an asset.

Usage:

tq get Assets

{"AssetID":"string"}

[{"AssetID":"string"}]

AssetID
"""string"""

Flags:

• --All
  Get details of all the assets for the specified constituent id and all its visible affiliations' assets as well. To exclude assets of the visible affiliations pass includeAffiliations=false.

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

Get the details of an association type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get AssociationTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all association types. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all association types.

Get details of an association.

Usage:

tq get Associations

{"AssociationID":"string"}

[{"AssociationID":"string"}]

AssociationID
"""string"""

Flags:

• --All
  Get details of all the association of the specified constituent id or get all the associations of the specified associated constituent id. If both constituent id and associated constituent id are specified get all the associations between them. To filter the associations that are active within certain date then pass values for start date and end date.

{"AssociatedConstituentID":"string", "ConstituentID":"string", "EndActiveDate":"string", "StartActiveDate":"string"}

[{"AssociatedConstituentID":"string","ConstituentID":"string","EndActiveDate":"string","StartActiveDate":"string"}]

AssociatedConstituentID,ConstituentID,EndActiveDate,StartActiveDate
"""string""","""string""","""string""","""string"""

Attendance History for a selected constituent optionally including primary affiliates. Does not return history based on recipient for the selected constituent(s).

Usage:

tq get AttendanceHistory

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

Get details of an attribute.

Usage:

tq get Attributes

{"AttributeID":"string"}

[{"AttributeID":"string"}]

AttributeID
"""string"""

Flags:

• --All
  Get details of all the attributes for the specified constituent id and all its visible affiliation's attributes as well. To exclude attributes of the visible affiliations pass includeAffiliations=false.

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

Get details of a audit log.

Usage:

tq get AuditLogs

{"AuditLog":"string"}

[{"AuditLog":"string"}]

AuditLog
"""string"""

Flags:

• --All
  Get all audit logs. The audit log response is paginated with default pageIndex = 1 and pageSize = 100. To get the audit log between a specific time interval specify auditStartTime and auditEndTime. If only auditStartTime is specified then all audit entries after that time would be returned. If only auditEndTime is specified then all audit entries before that time would be returned.

{"Action":"string", "AuditEndTime":"string", "AuditStartTime":"string", "EntityIds":"string", "IncludeSubEntities":"string", "PageIndex":"string", "PageSize":"string", "Table":"string"}

[{"Action":"string","AuditEndTime":"string","AuditStartTime":"string","EntityIds":"string","IncludeSubEntities":"string","PageIndex":"string","PageSize":"string","Table":"string"}]

Action,AuditEndTime,AuditStartTime,EntityIds,IncludeSubEntities,PageIndex,PageSize,Table
"""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string"""

• --Details
  Get audit log details.

{"Action":"string", "AuditEndTime":"string", "AuditStartTime":"string", "EntityIds":"string", "IncludeSubEntities":"string", "PageIndex":"string", "PageSize":"string", "Table":"string"}

[{"Action":"string","AuditEndTime":"string","AuditStartTime":"string","EntityIds":"string","IncludeSubEntities":"string","PageIndex":"string","PageSize":"string","Table":"string"}]

Action,AuditEndTime,AuditStartTime,EntityIds,IncludeSubEntities,PageIndex,PageSize,Table
"""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string"""

This is a no-op operation for windows authentication diagnostics.

Usage:

tq get Authenticate

B

Get a single Batch

Usage:

tq get BatchMaintenance

{"BatchID":"string"}

[{"BatchID":"string"}]

BatchID
"""string"""

Flags:

• --Active
  Returns all open or held batches owned by the service user. Optionally filters out controlled batches

{"IncludeControlled":"string"}

[{"IncludeControlled":"string"}]

IncludeControlled
"""string"""

Get the details of a batch type group by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get BatchTypeGroups

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all batch type groups. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all batch type groups.

Get all batch type/user group mappings.

Usage:

tq get BatchTypeUserGroup

{"UserGroup":"string"}

[{"UserGroup":"string"}]

UserGroup
"""string"""

Get the details of a batch type by id.

Usage:

tq get BatchTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all batch types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all batch types.

Get the details of a Billing Schedule. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resource in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get BillingSchedules

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all Billing Schedules. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all Billing Schedules.

Get the details of a Billing Type by id. To get the resource in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get BillingTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get details of all Billing Types. To get them in maintenance mode (which ignores Control Groups), pass maintenanceMode="true".

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all Billing Types.

Get the details of a Booking Category by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get BookingCategories

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all Booking Categories. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all Booking Categories.

Get a Booking Template by ID

Usage:

tq get BookingTemplates

{"BookingTemplateID":"string"}

[{"BookingTemplateID":"string"}]

BookingTemplateID
"""string"""

Flags:

• --Summaries
  Get summary of all Booking Templates, filtered optionally by category.

{"CategoryID":"string"}

[{"CategoryID":"string"}]

CategoryID
"""string"""

Get a Booking by id

Usage:

tq get Bookings

{"BookingID":"string"}

[{"BookingID":"string"}]

BookingID
"""string"""

Flags:

• --AllDocumentSummaries
  Get summary of all the documents associated with the booking. (Excluding the file contents)

{"BookingID":"string"}

[{"BookingID":"string"}]

BookingID
"""string"""

• --AllDocuments
  Get all the documents associated with the booking (Including the file contents).

{"BookingID":"string"}

[{"BookingID":"string"}]

BookingID
"""string"""

• --Document
  Get the document associated with the documentId (Including the file contents).

{"BookingID":"string", "DocumentID":"string"}

[{"BookingID":"string","DocumentID":"string"}]

BookingID,DocumentID
"""string""","""string"""

• --Summary
  Get a summary for a single Booking.

{"BookingID":"string"}

[{"BookingID":"string"}]

BookingID
"""string"""

Get a bulk copy set by Id.

Usage:

tq get BulkCopySets

{"BulkCopySetID":"string"}

[{"BulkCopySetID":"string"}]

BulkCopySetID
"""string"""

Flags:

• --All
  Get all bulk copy sets.
• --DayForCopy
  Returns the packages and performances that will be copied for the daily bulk copy set

{"BulkCopySetID":"string"}

[{"BulkCopySetID":"string"}]

BulkCopySetID
"""string"""

• --Summaries
  Get a summary of all bulk copy sets.

Get a bulk daily copy exclusion by id.

Usage:

tq get BulkDailyCopyExclusions

{"BulkDailyCopyExclusionID":"string"}

[{"BulkDailyCopyExclusionID":"string"}]

BulkDailyCopyExclusionID
"""string"""

Flags:

• --All
  Get all bulk daily copy exclusions for a given bulk copy set.

{"BulkCopySetID":"string"}

[{"BulkCopySetID":"string"}]

BulkCopySetID
"""string"""

Get the details of a business unit by id.

Usage:

tq get BusinessUnits

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all business units. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all business units.

C

Usage:

tq get Cache

Get a single Designation associated to a Campaign.

Usage:

tq get CampaignDesignations

{"CampaignDesignationID":"string"}

[{"CampaignDesignationID":"string"}]

CampaignDesignationID
"""string"""

Flags:

• --All
  Get all Designations associated to a Campaign.

{"CampaignID":"string"}

[{"CampaignID":"string"}]

CampaignID
"""string"""

Get a single Fund associated to a Campaign.

Usage:

tq get CampaignFunds

{"CampaignFundID":"string"}

[{"CampaignFundID":"string"}]

CampaignFundID
"""string"""

Flags:

• --All
  Get all Funds associated to a Campaign.

{"AsOfDateTime":"string", "CampaignID":"string"}

[{"AsOfDateTime":"string","CampaignID":"string"}]

AsOfDateTime,CampaignID
"""string""","""string"""

Get summary of a specific campaign.

Usage:

tq get Campaigns

{"CampaignID":"string"}

[{"CampaignID":"string"}]

CampaignID
"""string"""

Flags:

• --Summaries
  Return a collection of all campaigns in summary, optionally excluding inactive campaigns.

{"ActiveOnly":"string"}

[{"ActiveOnly":"string"}]

ActiveOnly
"""string"""

Get the details of a Card Reader Type by id. To get the resource in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get CardReaderTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get details of all Card Reader Types. To get them in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all Card Reader Types.

Gets the cart details

Usage:

tq get Cart

{"MessageTypes":"string", "SavedCart":"string", "SessionKey":"string"}

[{"MessageTypes":"string","SavedCart":"string","SessionKey":"string"}]

MessageTypes,SavedCart,SessionKey
"""string""","""string""","""string"""

Flags:

• --CartProperties
  Returns cart properties

{"SessionKey":"string"}

[{"SessionKey":"string"}]

SessionKey
"""string"""

• --Messages
  Gets the pricing rule messages for the current cart. Both Message Only and Rule messages are returned.

{"MessageTypes":"string", "SavedCart":"string", "SessionKey":"string"}

[{"MessageTypes":"string","SavedCart":"string","SessionKey":"string"}]

MessageTypes,SavedCart,SessionKey
"""string""","""string""","""string"""

• --ReceiptString
  Returns a formatted receipt for a cart

{"ReceiptSettingsID":"string", "SessionKey":"string", "TargetFormat":"string"}

[{"ReceiptSettingsID":"string","SessionKey":"string","TargetFormat":"string"}]

ReceiptSettingsID,SessionKey,TargetFormat
"""string""","""string""","""string"""

• --Summary
  Gets the cart summary Used by TRBO. Returns the cart with product lines summarized by price type, zone and price.

{"MessageTypes":"string", "SavedCart":"string", "SessionKey":"string"}

[{"MessageTypes":"string","SavedCart":"string","SessionKey":"string"}]

MessageTypes,SavedCart,SessionKey
"""string""","""string""","""string"""

Get the details of a color by id.

Usage:

tq get Colors

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all colors. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all colors.

Get the details of a composer by id.

Usage:

tq get Composers

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all composers. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all composers.

Get details of constituency.

Usage:

tq get Constituencies

{"ConstituencyID":"string"}

[{"ConstituencyID":"string"}]

ConstituencyID
"""string"""

Flags:

• --All
  Get details of all the constituencies for the specified constituent id and all its visible affiliation's constituencies as well. To exclude constituencies of the visible affiliations pass includeAffiliations=false.

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

Get the details of a constituency type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ConstituencyTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all constituency types. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all constituency types.

Get contributions for a constituent.

Usage:

tq get ConstituentContributions

{"CampaignIds":"string", "ConstituentID":"string", "EndDate":"string", "FundIds":"string", "IncludeAffiliations":"string", "StartDate":"string"}

[{"CampaignIds":"string","ConstituentID":"string","EndDate":"string","FundIds":"string","IncludeAffiliations":"string","StartDate":"string"}]

CampaignIds,ConstituentID,EndDate,FundIds,IncludeAffiliations,StartDate
"""string""","""string""","""string""","""string""","""string""","""string"""

Get the details of a document for a constituent.

Usage:

tq get ConstituentDocuments

{"DocumentID":"string"}

[{"DocumentID":"string"}]

DocumentID
"""string"""

Flags:

• --All
  Get all the documents for a particular constituent including file contents.

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

• --AllSummary
  Get summary of all the documents for the constituent. Only a summary of file information is returned.

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

Get the details of a constituent group by id.

Usage:

tq get ConstituentGroups

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all constituent groups. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all constituent groups.

Get the details of a constituent inactive by id.

Usage:

tq get ConstituentInactives

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all constituent inactives. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all constituent inactives.

Get the details of a constituent protection type by id.

Usage:

tq get ConstituentProtectionTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all constituent protection types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all constituent protection types.

Get the details of a constituent type affiliate by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ConstituentTypeAffiliates

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all constituent type affiliates. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all constituent type affiliates.

Get the details of a constituent type by id.

Usage:

tq get ConstituentTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all constituent types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all constituent types.

Get the details of a Constituent using id.

Usage:

tq get Constituents

{"ConstituentID":"string"}

[{"ConstituentID":"string"}]

ConstituentID
"""string"""

Flags:

• --Constituent
  Get constituent details with addresses, electronicAddresses, salutations and phones. To exclude information about visible affiliations pass includeAffiliations="false"

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

• --ConstituentDevelopmentInfo
  Get constituent information for fundraising.

{"ConstituentID":"string"}

[{"ConstituentID":"string"}]

ConstituentID
"""string"""

• --ConstituentSnapshot
  Get constituent details along with primary address, primary salutation, primary electronic address, phones and affiliates information.

{"ConstituentID":"string"}

[{"ConstituentID":"string"}]

ConstituentID
"""string"""

• --Constituents
  Get multiple Constituents given a set of constituentIds.

{"ConstituentIds":"string"}

[{"ConstituentIds":"string"}]

ConstituentIds
"""string"""

• --DefaultHeader
  Return the default header for the constituent, including configured flexible header names and values.

{"ConstituentID":"string"}

[{"ConstituentID":"string"}]

ConstituentID
"""string"""

• --FlexHeader
  Get the details of a flex header for a constituent

{"ConstituentID":"string", "HeaderID":"string"}

[{"ConstituentID":"string","HeaderID":"string"}]

ConstituentID,HeaderID
"""string""","""string"""

• --Header
  Return constituent header details, including configured flexible header names and values.

{"ConstituentID":"string", "HeaderID":"string"}

[{"ConstituentID":"string","HeaderID":"string"}]

ConstituentID,HeaderID
"""string""","""string"""

• --PrimaryHousehold
  Get primary household constituent details for a provided constituentId.

{"ConstituentID":"string"}

[{"ConstituentID":"string"}]

ConstituentID
"""string"""

• --Search
  Search for constituents using one of four possible search modes. Querystring parameters are valid based on the "type" parameter value. Single Line (type=fluent) Sample: CRM/Constituents/Search?type=fluent&q=Huff Single Line search type (or fluent) is the default search if not provided in querystring. Single line search works on string patterns in the passed search value ("q" param). Patterns are as follows: Value contains only alpha characters - interpreted as a last name search. To search with first name, pass comma then additional search value ("last, first"). Text enclosed in quotes is interpreted as a search for name ("ACE 123 Corporation"). value containing an @ symbol is interpreted as an email address. Value starting with # is interpreted as a phone number search. Value containing alpha and numeric characters is interpreted as a postal code. UK and other countries should omit spaces for postal code search values. Basic search type permits parameters constituentId, ln, fn, street, and post. Sample URL: CRM/Constituents/Search?type=basic&ln=Huff&fn=Frank&post=20746 Advanced search type permits parameters atype, op, and value. Sample URL: CRM/Constituents/Search?type=advanced&atype=Email&op=Like&value=%25@gmail.com Attribute search type permits parameters key, op, value. Sample URL: CRM/Constituents/Search?type=attribute&key=Board+Affiliation&op=Equals&value=Association+Member

{"Atype":"string", "ConstituencyIds":"string", "ConstituentGroups":"string", "ConstituentID":"string", "Dup":"string", "Fn":"string", "IncludeAffiliates":"string", "Key":"string", "ListID":"string", "Ln":"string", "Op":"string", "Page":"string", "PageSize":"string", "Post":"string", "Q":"string", "Street":"string", "Type":"string", "Value":"string"}

[{"Atype":"string","ConstituencyIds":"string","ConstituentGroups":"string","ConstituentID":"string","Dup":"string","Fn":"string","IncludeAffiliates":"string","Key":"string","ListID":"string","Ln":"string","Op":"string","Page":"string","PageSize":"string","Post":"string","Q":"string","Street":"string","Type":"string","Value":"string"}]

Atype,ConstituencyIds,ConstituentGroups,ConstituentID,Dup,Fn,IncludeAffiliates,Key,ListID,Ln,Op,Page,PageSize,Post,Q,Street,Type,Value
"""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string"""

Get the details of a contact permission category. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resource in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ContactPermissionCategories

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all contact permission categories. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all contact permission categories.

Get the details of a contact permission type. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resource in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ContactPermissionTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all contact permission types. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --ForProductionSeasons
  Get all contact permission types assigned to a set of production seasons.

{"ProductionSeasonIds":"string"}

[{"ProductionSeasonIds":"string"}]

ProductionSeasonIds
"""string"""

• --Summaries
  Get a summary representation of all contact permission types.

Get details of a contact permission

Usage:

tq get ContactPermissions

{"ContactPermissionID":"string"}

[{"ContactPermissionID":"string"}]

ContactPermissionID
"""string"""

Flags:

• --All
  Get all the contact permissions for the specified constituent and its affiliations if requested

{"ActiveOnly":"string", "ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ActiveOnly":"string","ConstituentID":"string","IncludeAffiliations":"string"}]

ActiveOnly,ConstituentID,IncludeAffiliations
"""string""","""string""","""string"""

Get the details of a contact point category by id.

Usage:

tq get ContactPointCategories

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all contact point categories. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all contact point categories.

Get the details of a contact point category purpose by id.

Usage:

tq get ContactPointCategoryPurposes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all contact point category purposes. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all contact point category purposes.

Get the details of a contact point purpose category by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ContactPointPurposeCategories

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all contact point purpose categories. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all contact point purpose categories.

Get details of a contact point purpose.

Usage:

tq get ContactPointPurposeMaps

{"ContactPointPurposeMapID":"string"}

[{"ContactPointPurposeMapID":"string"}]

ContactPointPurposeMapID
"""string"""

Flags:

• --All
  Get details of all the contact point purposes for the specified constituent (constituentId) and all its visible affiliation's contact point purposes as well. To exclude contact point purposes of the visible affiliations pass includeAffiliations=false. To get contact point purposes for a contact point pass contactPointId.

{"ConstituentID":"string", "ContactPointCategoryID":"string", "ContactPointID":"string", "IncludeAffiliations":"string", "PurposeID":"string"}

[{"ConstituentID":"string","ContactPointCategoryID":"string","ContactPointID":"string","IncludeAffiliations":"string","PurposeID":"string"}]

ConstituentID,ContactPointCategoryID,ContactPointID,IncludeAffiliations,PurposeID
"""string""","""string""","""string""","""string""","""string"""

Get the details of a contact point purpose by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ContactPointPurposes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all contact point purposes. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all contact point purposes.

Get all the delivery points for the specified constituent (constituentId) and all its visible affiliation's delivery point purposes as well. To exclude delivery point purposes of the visible affiliations pass includeAffiliations=false.

Usage:

tq get ContactPoints

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

Get the details of a contact type by id.

Usage:

tq get ContactTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all contact types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all contact types.

Get a commonly used set of default values for the user and usergroup in the current security context.

Usage:

tq get ContextInformation

Get the details of a contribution designation by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ContributionDesignations

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all contribution designations. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all contribution designations.

Get the details of a contributionImportSet by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ContributionImportSets

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all contributionImportSets. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups if this is a secured resource), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all contributionImportSets.

Get the details of a control group/user group mapping by id.

Usage:

tq get ControlGroupUserGroups

{"ID":"string"}

[{"ID":"string"}]

ID
"""string"""

Flags:

• --All
  Get all control group/user group mappings.
• --Summaries
  Get a summary representation of all control group/user group mappings.

Get the details of a control group by id.

Usage:

tq get ControlGroups

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all control groups. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all control groups.

Usage:

tq get CoreIdentity

Get the details of a country by id.

Usage:

tq get Countries

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all countries. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all countries.

Get the details of a crediteeType by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get CrediteeTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all crediteeTypes. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups if this is a secured resource), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all crediteeTypes.

Returns all credits for the requested production element, and all credits from above it in the production hierarchy.

Usage:

tq get Credits

{"ProductionElementIds":"string"}

[{"ProductionElementIds":"string"}]

ProductionElementIds
"""string"""

Get the details of a criterion operator by id.

Usage:

tq get CriterionOperators

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all criterion operators. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all criterion operators.

Get details of an cumulativeGivingReceipt.

Usage:

tq get CumulativeGivingReceipts

{"CumulativeGivingReceiptID":"string"}

[{"CumulativeGivingReceiptID":"string"}]

CumulativeGivingReceiptID
"""string"""

Flags:

• --All
  Get Cumulative Giving Receipts for the specified constituent id and affiliation Cumulative Giving Receipts as well. To exclude receipts of the visible affiliations pass includeAffiliations=false.

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

• --ForSession
  To retrieve a specific receipt for a session, pass sessionId and constituentId.

{"ConstituentID":"string", "SessionID":"string"}

[{"ConstituentID":"string","SessionID":"string"}]

ConstituentID,SessionID
"""string""","""string"""

Get the details of a currency type by id.

Usage:

tq get CurrencyTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all currency types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all currency types.

Get the metadata information of a custom table as defined by TR_DATASERVICE_TABLES and TR_DATASERVICE_COLUMNS.

Usage:

tq get Custom

Get the details of a custom default category by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get CustomDefaultCategories

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all custom default categories. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all custom default categories.

Get the details of a custom default by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get CustomDefaults

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all custom defaults. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all custom defaults.

D

Get the details of a delivery method by id.

Usage:

tq get DeliveryMethods

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all delivery methods. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all delivery methods.

Get the details of a designation code by id.

Usage:

tq get DesignationCodes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all designation codes. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all designation codes.

Get the details of a design by id.

Usage:

tq get Designs

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all designs. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all designs.

Validates Encryption Key Dates.

Usage:

tq get Diagnostics

Flags:

• --SeatServerStatus
  Returns status of the seat server connection.
• --Status
  Returns status of the application connection to database and service version information.
• --StatusReport
  Returns status of the application connection to database and service version information as an html page.

Get the details of a direct debit account type by id.

Usage:

tq get DirectDebitAccountTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all direct debit currency types.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all direct debit account types.

Get the details of a discount type by id.

Usage:

tq get DiscountTypes

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all discount types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all discount types.

Get the control group/division mappings for the specified division.

Usage:

tq get Divisions

Flags:

• --ForDivision
  Get the control group/division mappings for the specified division.

{"DivisionID":"string"}

[{"DivisionID":"string"}]

DivisionID
"""string"""

Get the details of a documentCategory by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get DocumentCategories

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all documentCategories. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all documentCategories.

Get the details of a document.

Usage:

tq get Documents

{"DocumentID":"string"}

[{"DocumentID":"string"}]

DocumentID
"""string"""

Flags:

• --All
  Get all the documents for a particular resource including file contents. Only documents associated with steps may be returned at this time.

{"StepID":"string"}

[{"StepID":"string"}]

StepID
"""string"""

• --AllSummary
  Get summary of all the documents for the step. Only a summary of file information is returned.

{"StepID":"string"}

[{"StepID":"string"}]

StepID
"""string"""

• --Settings
  Get configuration settings for uploading documents.

Get the details of a donation level by id.

Usage:

tq get DonationLevels

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all donation levels. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all donation levels.

E

Retrieve information on all lanes associated with merchant

Usage:

tq get EMV

{"Cert":"string", "Merchant":"string"}

[{"Cert":"string","Merchant":"string"}]

Cert,Merchant
"""string""","""string"""

Flags:

• --ConnectionStatus
  Get connection status for a lane

{"Cert":"string", "LaneID":"string", "Merchant":"string"}

[{"Cert":"string","LaneID":"string","Merchant":"string"}]

Cert,LaneID,Merchant
"""string""","""string""","""string"""

• --ConnectionStatusHistory
  Get connection status history for a lane

{"Cert":"string", "LaneID":"string", "Merchant":"string"}

[{"Cert":"string","LaneID":"string","Merchant":"string"}]

Cert,LaneID,Merchant
"""string""","""string""","""string"""

• --IdleMessage
  Retrieve idle message for a specific lane

{"Cert":"string", "LaneID":"string", "Merchant":"string"}

[{"Cert":"string","LaneID":"string","Merchant":"string"}]

Cert,LaneID,Merchant
"""string""","""string""","""string"""

• --Lane
  Retrieve information for a specific lane

{"Cert":"string", "LaneID":"string", "Merchant":"string"}

[{"Cert":"string","LaneID":"string","Merchant":"string"}]

Cert,LaneID,Merchant
"""string""","""string""","""string"""

Get the details of an electronic address type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get ElectronicAddressTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all electronic address types. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all electronic address types.

Get details of an electronic address.

Usage:

tq get ElectronicAddresses

{"ElectronicAddressID":"string"}

[{"ElectronicAddressID":"string"}]

ElectronicAddressID
"""string"""

Flags:

• --All
  Get electronic addresses for constituent(s) or query general public electronic addresses for a specific address.

Either constituentIds, useGeneralPublic, or address must be specified in request. For constituent electronic address, visible affiliation electronic addresses can be included with includeAffiliations=true. To exclude electronic addresses of the visible affiliations pass includeAffiliations=false. To retrieve only the primary electronic addresses, pass primaryOnly=true.

{"Address":"string", "ConstituentIds":"string", "ElectronicAddressTypeID":"string", "IncludeAffiliations":"string", "IncludeFromAffiliations":"string", "PrimaryOnly":"string", "UseGeneralPublic":"string"}

[{"Address":"string","ConstituentIds":"string","ElectronicAddressTypeID":"string","IncludeAffiliations":"string","IncludeFromAffiliations":"string","PrimaryOnly":"string","UseGeneralPublic":"string"}]

Address,ConstituentIds,ElectronicAddressTypeID,IncludeAffiliations,IncludeFromAffiliations,PrimaryOnly,UseGeneralPublic
"""string""","""string""","""string""","""string""","""string""","""string""","""string"""

• --IsAttachedToLogin
  Check if the specified electronic address is attached to a web login.

{"ElectronicAddressID":"string"}

[{"ElectronicAddressID":"string"}]

ElectronicAddressID
"""string"""

Get the details of an email profile by id

Usage:

tq get EmailProfiles

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all email profiles

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get summary of all email profiles

Get the details of an emarket indicator by id.

Usage:

tq get EmarketIndicators

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all emarket indicators. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all emarket indicators.

Get the details of an era by id.

Usage:

tq get Eras

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all eras. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all eras.

Returns a response containing a list of EventControl rows for the N-Scan event control table.

Usage:

tq get EventControl

{"EndDate":"string", "StartDate":"string"}

[{"EndDate":"string","StartDate":"string"}]

EndDate,StartDate
"""string""","""string"""

F

Get details of a Facility.

Usage:

tq get Facilities

{"ID":"string"}

[{"ID":"string"}]

ID
"""string"""

Flags:

• --All
  Get details of all the Facilities.
• --Screens
  Returns details of all screens and the HouseMap for the facility. The screen details include which other screens are assigned to each screen navigation arrow button.

{"FacilityID":"string"}

[{"FacilityID":"string"}]

FacilityID
"""string"""

• --Summaries
  Get summary representation of all Facilities.

Get details of a fee.

Usage:

tq get Fees

{"ID":"string"}

[{"ID":"string"}]

ID
"""string"""

Flags:

• --All
  Get all fees.

{"FeeCategoryIds":"string", "SeasonID":"string", "UserDefined":"string"}

[{"FeeCategoryIds":"string","SeasonID":"string","UserDefined":"string"}]

FeeCategoryIds,SeasonID,UserDefined
"""string""","""string""","""string"""

• --Summaries
  Get summary representation of all fees.

{"FeeCategoryIds":"string", "SeasonID":"string", "UserDefined":"string"}

[{"FeeCategoryIds":"string","SeasonID":"string","UserDefined":"string"}]

FeeCategoryIds,SeasonID,UserDefined
"""string""","""string""","""string"""

Get details of a contribution.

Usage:

tq get FinanceContributions

{"ContributionID":"string"}

[{"ContributionID":"string"}]

ContributionID
"""string"""

Flags:

• --All
  Get details of all the contributions for the specified plan.

{"PlanID":"string"}

[{"PlanID":"string"}]

PlanID
"""string"""

Get the details of a format by id.

Usage:

tq get Formats

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all formats. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all formats.

Get details of a specific fund

Usage:

tq get Funds

{"FundID":"string"}

[{"FundID":"string"}]

FundID
"""string"""

Flags:

• --Summaries
  Get summary of all funds.

{"TicketingIndicator":"string"}

[{"TicketingIndicator":"string"}]

TicketingIndicator
"""string"""

G

Get the details of a gl account by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get GLAccounts

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all gl accounts. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all gl accounts.

Get the details of a gender by id.

Usage:

tq get Genders

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all available gender values. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all gender values.

Get the details of a gift aid contact method by id.

Usage:

tq get GiftAidContactMethods

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all gift aid contact methods. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all gift aid contact methods.

Gets a single Gift Aid Declaration.

Usage:

tq get GiftAidDeclarations

{"GiftAidDeclarationID":"string"}

[{"GiftAidDeclarationID":"string"}]

GiftAidDeclarationID
"""string"""

Flags:

• --All
  Gets all Gift Aid Declarations for a provided constituent including primary affiliates by default.

{"ConstituentID":"string", "IncludeAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string"}]

ConstituentID,IncludeAffiliations
"""string""","""string"""

Get the details of a gift aid document status by id.

Usage:

tq get GiftAidDocumentStatuses

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all gift aid document statuses. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all gift aid document statuses.

Get the details of a gift aid ineligible reason by id.

Usage:

tq get GiftAidIneligibleReasons

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all gift aid ineligible reasons. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all gift aid ineligible reasons.

Get the details of a gift aid rate by id.

Usage:

tq get GiftAidRates

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all gift aid rates. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all gift aid rates.

Get the details of a gift aid status by id.

Usage:

tq get GiftAidStatuses

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all gift aid statuses. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all gift aid statuses.

Get the details of a gift aid type by id.

Usage:

tq get GiftAidTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all gift aid types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all gift aid types.

Get details of a specific gift certificate. The original amount, amount used and balance are all returned. Amounts applied to a current web session are included.

Usage:

tq get GiftCertificates

{"GiftCertificateNumber":"string"}

[{"GiftCertificateNumber":"string"}]

GiftCertificateNumber
"""string"""

H

Get the details of a Hold Code Category by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get HoldCodeCategories

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all Hold Code Categories. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all Hold Code Categories.

Get the details of a hold code/user group mapping by id.

Usage:

tq get HoldCodeUserGroups

{"HoldCodeUserGroupID":"string"}

[{"HoldCodeUserGroupID":"string"}]

HoldCodeUserGroupID
"""string"""

Flags:

• --All
  Get all hold code/user group mappings. Optional filter for a UserGroup or HoldCode.

{"HoldCode":"string", "UserGroup":"string"}

[{"HoldCode":"string","UserGroup":"string"}]

HoldCode,UserGroup
"""string""","""string"""

• --Summaries
  Get a summary representation of all hold code/user group mappings. Optional filter for a UserGroup or HoldCode.

{"HoldCode":"string", "UserGroup":"string"}

[{"HoldCode":"string","UserGroup":"string"}]

HoldCode,UserGroup
"""string""","""string"""

• --Summary
  Get summary representation of a hold code/user group mapping by id.

{"HoldCodeUserGroupID":"string"}

[{"HoldCodeUserGroupID":"string"}]

HoldCodeUserGroupID
"""string"""

Get details of a Hold Code.

Usage:

tq get HoldCodes

{"HoldCodeID":"string"}

[{"HoldCodeID":"string"}]

HoldCodeID
"""string"""

Flags:

• --All
  Get details of all Hold Codes.

I

Get the details of an inactive reason by id.

Usage:

tq get InactiveReasons

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all inactive reasons. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all inactive reasons.

Get the details of an Integration Default by id.

Usage:

tq get IntegrationDefaults

{"ID":"string"}

[{"ID":"string"}]

ID
"""string"""

Flags:

• --All
  Get all Integration Defaults. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.
• --Summaries
  Get a summary representation of all Integration Defaults.

Get the details of an action type by id.

Usage:

tq get Integrations

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all action types. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all action types.

Get the details of an interest category by id.

Usage:

tq get InterestCategories

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all interest categories. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all interest categories.

Get the details of an interest type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get InterestTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all interest types. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all interest types.

Get details of an interest.

Usage:

tq get Interests

{"InterestID":"string"}

[{"InterestID":"string"}]

InterestID
"""string"""

Flags:

• --All
  Get all the interests of the specified constituent id. To exclude attributes of the visible affiliations pass includeAffiliations=false. To filter the interests of specific categories pass comma separted values under categories.

{"CategoryIds":"string", "ConstituentID":"string", "IncludeAffiliations":"string"}

[{"CategoryIds":"string","ConstituentID":"string","IncludeAffiliations":"string"}]

CategoryIds,ConstituentID,IncludeAffiliations
"""string""","""string""","""string"""

Get details of an address and all the phones attached to it.

Usage:

tq get Internal

{"AddressID":"string"}

[{"AddressID":"string"}]

AddressID
"""string"""

Flags:

• --All
  Get details of all the addresses and the phones attached to them of the constituent id. To exclude addresses and the phones of the visible affiliations pass includeAffiliations=false.

{"ConstituentID":"string", "IncludeAffiliations":"string", "IncludeFromAffiliations":"string"}

[{"ConstituentID":"string","IncludeAffiliations":"string","IncludeFromAffiliations":"string"}]

ConstituentID,IncludeAffiliations,IncludeFromAffiliations
"""string""","""string""","""string"""

• --ConstituentMiniSnapshot
  Get constituent details along with primary address, primary salutation, primary electronic address, primary & general phones.

{"ConstituentID":"string"}

[{"ConstituentID":"string"}]

ConstituentID
"""string"""

Get details of an inventoryContactPermissionType.

Usage:

tq get InventoryContactPermissionTypes

{"InventoryContactPermissionTypeID":"string"}

[{"InventoryContactPermissionTypeID":"string"}]

InventoryContactPermissionTypeID
"""string"""

Flags:

• --All
  Get details of all the Contact Permission Types associated to Production Seasons. Inventory Contact Permission Type is a mapping of a Contact Permission Type to a Production Season.

{"ProductionSeasonIds":"string"}

[{"ProductionSeasonIds":"string"}]

ProductionSeasonIds
"""string"""

Get details of an inventoryWebContent.

Usage:

tq get InventoryWebContents

{"InventoryWebContentID":"string"}

[{"InventoryWebContentID":"string"}]

InventoryWebContentID
"""string"""

Flags:

• --All
  Get details of all the inventoryWebContents.

{"ContentTypeIds":"string", "ProductionElementIds":"string"}

[{"ContentTypeIds":"string","ProductionElementIds":"string"}]

ContentTypeIds,ProductionElementIds
"""string""","""string"""

• --AllSummaries
  Get details of all the inventoryWebContents.

{"ContentTypeIds":"string", "ProductionElementIds":"string"}

[{"ContentTypeIds":"string","ProductionElementIds":"string"}]

ContentTypeIds,ProductionElementIds
"""string""","""string"""

Get status of a processing automated billing run.

Usage:

tq get InvoiceBilling

{"ID":"string"}

[{"ID":"string"}]

ID
"""string"""

Get details of a customer issue.

Usage:

tq get Issues

{"IssueID":"string"}

[{"IssueID":"string"}]

IssueID
"""string"""

Flags:

• --All
  Get all the details of all the issues for the specified constituent id. If you want to filter the issues based on date pass in the values for 'startDate' and 'endDate'. If you want to filter issues based on contact type, category, activity type, origin, performance number or package number pass in the corresponding values in comma separated values.

{"ActivityTypeIds":"string", "CategoryIds":"string", "ConstituentID":"string", "ContactTypeIds":"string", "EndDate":"string", "IncludeAffiliations":"string", "OriginIds":"string", "PackageIds":"string", "PerformanceIds":"string", "Resolved":"string", "StartDate":"string"}

[{"ActivityTypeIds":"string","CategoryIds":"string","ConstituentID":"string","ContactTypeIds":"string","EndDate":"string","IncludeAffiliations":"string","OriginIds":"string","PackageIds":"string","PerformanceIds":"string","Resolved":"string","StartDate":"string"}]

ActivityTypeIds,CategoryIds,ConstituentID,ContactTypeIds,EndDate,IncludeAffiliations,OriginIds,PackageIds,PerformanceIds,Resolved,StartDate
"""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string""","""string"""

K

Get the details of a keyword category by id.

Usage:

tq get KeywordCategories

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all keyword categories. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all keyword categories.

Get the details of a keyword by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get Keywords

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all keywords. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --DataFor
  Gets potential values for a Keyword as KeywordDataItems.

{"KeywordID":"string"}

[{"KeywordID":"string"}]

KeywordID
"""string"""

• --Summaries
  Get a summary representation of all keywords.

L

Get the details of a language by id.

Usage:

tq get Languages

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all languages. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all languages.

Get the details of a list category by id.

Usage:

tq get ListCategories

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get all list categories. For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all list categories.

Get a single List without contents.

Usage:

tq get Lists

{"ListID":"string"}

[{"ListID":"string"}]

ListID
"""string"""

Flags:

• --Contents
  Gets Constituent ids for the contents of a List.

{"ListID":"string"}

[{"ListID":"string"}]

ListID
"""string"""

• --ContentsDetail
  Gets Constituent details for the contents of a List.

{"ListID":"string"}

[{"ListID":"string"}]

ListID
"""string"""

• --ListCriterionMatchReasons
  Returns list criteria match reasons for a constituent in a list.

{"ConstituentID":"string", "ListID":"string"}

[{"ConstituentID":"string","ListID":"string"}]

ConstituentID,ListID
"""string""","""string"""

• --Summaries
  Get a summary of all Lists.

{"ListIds":"string"}

[{"ListIds":"string"}]

ListIds
"""string"""

Get the details of a login type by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get LoginTypes

{"Filter":"string", "ID":"string", "MaintenanceMode":"string"}

[{"Filter":"string","ID":"string","MaintenanceMode":"string"}]

Filter,ID,MaintenanceMode
"""string""","""string""","""string"""

Flags:

• --All
  Get all login types. To get only the resoures for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter.

{"Filter":"string", "MaintenanceMode":"string"}

[{"Filter":"string","MaintenanceMode":"string"}]

Filter,MaintenanceMode
"""string""","""string"""

• --Summaries
  Get a summary representation of all login types.

M

Get the details of a Machine Setting by id. To get the resource in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

Usage:

tq get MachineSettings

{"ID":"string", "MaintenanceMode":"string"}

[{"ID":"string","MaintenanceMode":"string"}]

ID,MaintenanceMode
"""string""","""string"""

Flags:

• --All
  Get details of all Machine Settings. To get them in maintenance mode (which ignores Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP).

{"MaintenanceMode":"string"}

[{"MaintenanceMode":"string"}]

MaintenanceMode
"""string"""

• --Summaries
  Get a summary representation of all Machine Settings.