ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

TaxManagement

API	Description
GET api/v1/tax-management/filter-prov-tax-clients	No documentation available.
GET api/v1/tax-management/filter-tax-linked-clients	No documentation available.
POST api/v1/tax-management/update-prov-tax-clients-note	No documentation available.

AnnualComplianceWorkflowTotal

API	Description
GET api/v1/annual-compliance-workflow-total/get-all-info-workflow?jobId={jobId}	No documentation available.
GET api/v1/annual-compliance-workflow-total/get-all-info-workflow-v1?jobId={jobId}	No documentation available.
GET api/v1/annual-compliance-workflow-total/get-user-branch-workflow?branchId={branchId}	No documentation available.
GET api/v1/annual-compliance-workflow-total/get-user-branch-workflow-v1?branchId={branchId}	No documentation available.
POST api/v1/annual-compliance-workflow-total/update-workflow-management-v0	No documentation available.
GET api/v1/annual-compliance-workflow-total/get-ordinary-qualifying-list	No documentation available.
GET api/v1/annual-compliance-workflow-total/get-delivery-list	No documentation available.

Users

API	Description
GET api/v1/users/map-sso-token?encryptedToken={encryptedToken}&encryptedGssId={encryptedGssId}	No documentation available.
POST api/v1/users/logout	No documentation available.
POST api/v1/users/set-audit	No documentation available.
GET api/v1/users/me	No documentation available.
GET api/v1/users/get-all-simples	No documentation available.
GET api/v1/users/get-user?userId={userId}	No documentation available.
GET api/v1/users/get-all-details	No documentation available.
GET api/v1/users/get-csm	No documentation available.
GET api/v1/users/get-user-by-type/{type}/{branchId}	No documentation available.
GET api/v1/users/get-user-by-type-basfs/{type}/{branchId}	No documentation available.
GET api/v1/users/get-user-assigne-to-job-query	No documentation available.
GET api/v1/users/get-user-assigne-to-coporate-affairs-industion	No documentation available.
GET api/v1/users/get-user-assigne-to-companies-office-annual-return	No documentation available.
GET api/v1/users/get-receiving-acqs-receiving-user	No documentation available.
GET api/v1/users/get-user-reminders	No documentation available.

ClientSystem

API	Description
GET api/v1/clientsystem/current-clients	No documentation available.
GET api/v1/clientsystem/incomplete-clients	No documentation available.
GET api/v1/clientsystem/current-clients/totalfee	No documentation available.

AnnualComplianceWorkflowGeneral

API	Description
GET api/v1/annual-compliance-workflow-general/get-branch-list	No documentation available.
GET api/v1/annual-compliance-workflow-general/get-head-office-reviewer-list?jobId={jobId}	No documentation available.
GET api/v1/annual-compliance-workflow-general/get-head-office-reviewer-list-v1?jobId={jobId}	No documentation available.

CorporateAffairs

API	Description
GET api/v1/corporate-affairs/filter-current-clients	No documentation available.
GET api/v1/corporate-affairs/filter-current-inductions	No documentation available.
GET api/v1/corporate-affairs/filter-workflow	No documentation available.
GET api/v1/corporate-affairs/get-inductions-statuses	No documentation available.
GET api/v1/corporate-affairs/get-workflow-status	No documentation available.
GET api/v1/corporate-affairs/get-inductions-detail/{jobId}	No documentation available.
POST api/v1/corporate-affairs/update-inductions	No documentation available.
GET api/v1/corporate-affairs/new-inductions?clientId={clientId}	No documentation available.
GET api/v1/corporate-affairs/get-workflow-detail/{jobId}	No documentation available.
POST api/v1/corporate-affairs/update-workflow-detail	No documentation available.
GET api/v1/corporate-affairs/get-due-for-filing	No documentation available.
GET api/v1/corporate-affairs/get-companies?dateSelected={dateSelected}	No documentation available.
GET api/v1/corporate-affairs/export-excel-companies?dateSelected={dateSelected}	No documentation available.
GET api/v1/corporate-affairs/get-current-clients-total-fee	No documentation available.
GET api/v1/corporate-affairs/get-reasons-why-we-are-not-filing	No documentation available.
POST api/v1/corporate-affairs/update-reasons-why-we-are-not-filing	No documentation available.
GET api/v1/corporate-affairs/get-company-associates?caId={caId}&clientIdAssoc={clientIdAssoc}&jobId={jobId}	No documentation available.
POST api/v1/corporate-affairs/update-company-associates	No documentation available.
GET api/v1/corporate-affairs/delete-company-associates?caId={caId}	No documentation available.
POST api/v1/corporate-affairs/create-annual-return-job	No documentation available.
GET api/v1/corporate-affairs/get-old-address?clientId={clientId}	No documentation available.
GET api/v1/corporate-affairs/get-annual-return-detail?clientId={clientId}	No documentation available.
POST api/v1/corporate-affairs/update-annual-return-detail	No documentation available.
GET api/v1/corporate-affairs/get-mfdb?clientId={clientId}	No documentation available.
POST api/v1/corporate-affairs/update-mfdb	No documentation available.
GET api/v1/corporate-affairs/get-client-partner-detail?clientId={clientId}	No documentation available.
POST api/v1/corporate-affairs/update-client-partner-detail	No documentation available.

Lookup

API	Description
GET api/v1/lookup/get-lookups?jobId={jobId}&domain={domain}	No documentation available.
POST api/v1/lookup/update-lookups	No documentation available.

Mail

API	Description
POST api/v1/mail/get-mail-job	No documentation available.
GET api/v1/mail/get-mail-query-resolved?jobQueryId={jobQueryId}&jobId={jobId}&resolved={resolved}	No documentation available.
POST api/v1/mail/send-to-user	No documentation available.
GET api/v1/mail/get-mail-system-review?srJobId={srJobId}&srContent={srContent}	No documentation available.

ClientGroup

API	Description
GET api/v1/client-group/get-client-group?jobId={jobId}	No documentation available.

Jobs

API	Description
GET api/v1/jobs/get-next-action-date?jobId={jobId}	No documentation available.
GET api/v1/jobs/job-credit-control-check?jobId={jobId}&activityId={activityId}&clientId={clientId}&jobDate={jobDate}	No documentation available.
GET api/v1/jobs/is-all-orthers-filed?jobId={jobId}	No documentation available.

Protocols

API	Description
GET api/v1/protocol/get-protocol?command={command}&param={param}&validity={validity}	No documentation available.
GET api/v1/protocol/draftfees?jobId={jobId}	No documentation available.
GET api/v1/protocol/email-doc?template={template}&jobId={jobId}&type={type}	No documentation available.
POST api/v1/protocol/manager-group-query	No documentation available.
GET api/v1/protocol/get-companies-office-link?jobId={jobId}	No documentation available.
GET api/v1/protocol/new-documents?jobId={jobId}	No documentation available.
GET api/v1/protocol/crm-group?jobId={jobId}	No documentation available.
GET api/v1/protocol/job?jobId={jobId}	No documentation available.
POST api/v1/protocol/get-doc-custom-protocol	No documentation available.

Settings

API	Description
GET api/v1/settings/get-status-colors	No documentation available.
GET api/v1/settings/get-tags	No documentation available.
GET api/v1/settings/get-activity-categories	No documentation available.
GET api/v1/settings/get-file-types	No documentation available.
GET api/v1/settings/common	No documentation available.
GET api/v1/settings/menus	No documentation available.
GET api/v1/settings/fy	No documentation available.
GET api/v1/settings/get-branch-image?img={img}	No documentation available.
GET api/v1/settings/gst-job-status	No documentation available.
GET api/v1/settings/get-all-priority	No documentation available.
GET api/v1/settings/get-all-branches	No documentation available.
GET api/v1/settings/get-entity-types	No documentation available.
GET api/v1/settings/get-gst-types	No documentation available.
GET api/v1/settings/current-offset	No documentation available.
GET api/v1/settings/get-next-action-date?date={date}&workingDays={workingDays}	No documentation available.
GET api/v1/settings/get-bus-activity?includePassive={includePassive}	No documentation available.
GET api/v1/settings/get-activities?tmsIdentifier[0]={tmsIdentifier[0]}&tmsIdentifier[1]={tmsIdentifier[1]}	No documentation available.
POST api/v1/settings/update-user-setting	No documentation available.
GET api/v1/settings/get-user-setting?token={token}	No documentation available.

Reminders

API	Description
GET api/v1/reminders/filter	No documentation available.
GET api/v1/reminders/get-jobs	No documentation available.
GET api/v1/reminders/get-reminder-hierarchy	No documentation available.

ClientDetail

API	Description
GET api/v1/clientdetail/entities/{clientGroupId}	No documentation available.
GET api/v1/clientdetail/csm-and-ap-details/{clientId}	No documentation available.
GET api/v1/clientdetail/main-details/{clientId}	No documentation available.
GET api/v1/clientdetail/get-client-partnership-detail/{clientId}	No documentation available.
GET api/v1/clientdetail/get-company-detail/{clientId}	No documentation available.
GET api/v1/clientdetail/get-company-tax-election/{clientId}	No documentation available.
GET api/v1/clientdetail/get-client-individual-information/{clientId}	No documentation available.
GET api/v1/clientdetail/trust-parties/{clientId}	No documentation available.
GET api/v1/clientdetail/trust-gifting/{clientId}/{showAllParties}	No documentation available.
GET api/v1/clientdetail/trust-gifting-notes/{clientId}	No documentation available.
GET api/v1/clientdetail/trust-professional-trustee/{clientId}	No documentation available.
GET api/v1/clientdetail/get-workflows?clientId={clientId}&inclCompleted={inclCompleted}	No documentation available.
GET api/v1/clientdetail/filter-notes	No documentation available.
GET api/v1/clientdetail/get-client-notes-detail/{clientNoteId}	No documentation available.
GET api/v1/clientdetail/filter-documents	No documentation available.
GET api/v1/clientdetail/get-call-count/{clientId}	No documentation available.
GET api/v1/clientdetail/get-permanent-file/{clientId}	No documentation available.
GET api/v1/clientdetail/fees-common/{clientId}	No documentation available.
GET api/v1/clientdetail/current-fees/{clientId}/{year}	No documentation available.
GET api/v1/clientdetail/quote-history/{clientId}	No documentation available.
GET api/v1/clientdetail/direct-debit-authoritiesy/{clientId}	No documentation available.
GET api/v1/clientdetail/gst-setting/{clientId}	No documentation available.
GET api/v1/clientdetail/annual-financials-tax-settings/{clientId}	No documentation available.
GET api/v1/clientdetail/ird-international-tax-file-nos/{clientId}	No documentation available.
GET api/v1/clientdetail/workflowmax-links/{clientId}	No documentation available.
GET api/v1/clientdetail/group/{clientId}	No documentation available.
GET api/v1/clientdetail/client-systems/{clientId}	No documentation available.
GET api/v1/clientdetail/get-file?filePath={filePath}	No documentation available.
POST api/v1/clientdetail/update-aml-client?clientId={clientId}&isClientGroup={isClientGroup}	No documentation available.

AnnualCompliance

API	Description
GET api/v1/annual-compliance/get-list-contracted-clients-group	No documentation available.
GET api/v1/annual-compliance/get-fy-list	No documentation available.
GET api/v1/annual-compliance/get-acq-status	No documentation available.
GET api/v1/annual-compliance/get-ird-list	No documentation available.
GET api/v1/annual-compliance/get-l-list	No documentation available.
GET api/v1/annual-compliance/filter-contracted-acqs-group	No documentation available.
GET api/v1/annual-compliance/filter-contracted-acqs-entities	No documentation available.
GET api/v1/annual-compliance/filter-contracted-acqs-incomplete	No documentation available.
GET api/v1/annual-compliance/get-print-acq-letters-detail?isSingleClient={isSingleClient}	No documentation available.
POST api/v1/annual-compliance/change-print-acq-letter-year	No documentation available.

AnnualComplianceWorkflowAccountant

API	Description
GET api/v1/annual-compliance-workflow-accountant/get-general-ledger-list	No documentation available.

Note

API	Description
POST api/v1/note/save-client-note	No documentation available.
POST api/v1/note/save-client-notes	No documentation available.

AnnualComplianceWorkflowInfo

API	Description
GET api/v1/annual-compliance-workflow-info/get-status-list?userPermissionLevel={userPermissionLevel}&status={status}	No documentation available.
GET api/v1/annual-compliance-workflow-info/get-status-list-v1?status={status}	No documentation available.
GET api/v1/annual-compliance-workflow-info/get-activity-list	No documentation available.

GSTReturn

API	Description
GET api/v1/gstreturn/gst-return-job/{jobId}	No documentation available.
POST api/v1/gstreturn/update-gst-return-job	No documentation available.
GET api/v1/gstreturn/gst-list-job-status/{jobStatus}	No documentation available.
POST api/v1/gstreturn/update-gst-return-processing-notes	No documentation available.
GET api/v1/gstreturn/get-activity-history-detail/{jobLogId}	No documentation available.
GET api/v1/gstreturn/get-group-queries?groupId={groupId}	No documentation available.
POST api/v1/gstreturn/update-query-note	No documentation available.
POST api/v1/gstreturn/update-followups-group-queries	No documentation available.
POST api/v1/gstreturn/update-contacts-group-queries	No documentation available.
POST api/v1/gstreturn/update-comments-group-query	No documentation available.
GET api/v1/gstreturn/filter-query-audit-log-by-jobQueryId?jobQueryId={jobQueryId}	No documentation available.
GET api/v1/gstreturn/new-job-query?jobId={jobId}	No documentation available.
POST api/v1/gstreturn/update-entity-and-gst-type	No documentation available.
GET api/v1/gstreturn/get-system-review-reasons	No documentation available.
POST api/v1/gstreturn/update-system-review-reasons	No documentation available.
GET api/v1/gstreturn/get-fee-variation-and-systems-review-popup-info?jobId={jobId}&clientID={clientID}	No documentation available.
POST api/v1/gstreturn/update-system-review-job-reason	No documentation available.
POST api/v1/gstreturn/save-client-note	No documentation available.
POST api/v1/gstreturn/send-to-client	No documentation available.
POST api/v1/gstreturn/send-to-client-update-query-notes	No documentation available.
GET api/v1/gstreturn/validate-lookup?domain={domain}&luId={luId}	No documentation available.
GET api/v1/gstreturn/quote-detail?jobId={jobId}	No documentation available.
GET api/v1/gstreturn/quote-entity-types?entityType={entityType}	No documentation available.
GET api/v1/gstreturn/quote-gst-types	No documentation available.
GET api/v1/gstreturn/bas-induct-defaults?itemId={itemId}&gstType={gstType}&entityType={entityType}	No documentation available.
POST api/v1/gstreturn/update-quote-detail	No documentation available.

FeeVariationRequest

API	Description
GET api/v1/fee-variation-request/get-categories	No documentation available.
POST api/v1/fee-variation-request/update-category	No documentation available.
GET api/v1/fee-variation-request/get-variation-request-details?jobId={jobId}	No documentation available.
POST api/v1/fee-variation-request/update-variation-request	No documentation available.
POST api/v1/fee-variation-request/create-variation-request	No documentation available.

AnnualComplianceWorkflow

API	Description
GET api/v1/annual-compliance-workflow/filter-workflow-management	No documentation available.
GET api/v1/annual-compliance-workflow/get-all-year	No documentation available.
GET api/v1/annual-compliance-workflow/get-all-status	No documentation available.

SystemsReview

API	Description
GET api/v1/systems-review/get-systems-review?jobId={jobId}	No documentation available.
POST api/v1/systems-review/update-systems-review	No documentation available.
POST api/v1/systems-review/create-systems-review	No documentation available.

Clients

API	Description
GET api/v1/clients/filter	No documentation available.
GET api/v1/clients/filter-simple	No documentation available.
GET api/v1/clients/group-status/{clientGroupId}	No documentation available.
GET api/v1/clients/group-status-by-client/{clientId}	No documentation available.
GET api/v1/clients/group-status-by-jobid/{jobId}	No documentation available.
POST api/v1/clients/accepts-acknowledgements/{clientGroupId}	No documentation available.
GET api/v1/clients/get-suggest-keyword?keyword={keyword}	No documentation available.
GET api/v1/clients/get-suggest-keyword-v1?keyword={keyword}	No documentation available.
GET api/v1/clients/get-audit-log-for-client?clientGroupId={clientGroupId}	No documentation available.
POST api/v1/clients/update-group-status	No documentation available.
POST api/v1/clients/attempt-user-unLock?clientId={clientId}	No documentation available.

JobQuery

API	Description
GET api/v1/jobquery/detail/{jobQueryId}	No documentation available.
POST api/v1/jobquery/update	No documentation available.
GET api/v1/jobquery/review-queries?jobId={jobId}	No documentation available.
GET api/v1/jobquery/get-job-queries?jobId={jobId}	No documentation available.

ClientGST

API	Description
GET api/v1/clientgst/current-clients	No documentation available.
GET api/v1/clientgst/incomplete-clients	No documentation available.
POST api/v1/clientgst/create-job	No documentation available.
GET api/v1/clientgst/workflow	No documentation available.
GET api/v1/clientgst/workflow-period-ending	No documentation available.
GET api/v1/clientgst/current-clients/totalfee	No documentation available.
GET api/v1/clientgst/incomplete-clients/totalfee	No documentation available.

ReceivingACQs

API	Description
GET api/v1/receiving-acqs/filter-acqs-group	No documentation available.
GET api/v1/receiving-acqs/filter-acqs-entity	No documentation available.
GET api/v1/receiving-acqs/get-status	No documentation available.
GET api/v1/receiving-acqs/get-receiving-acqs-detail?jobId={jobId}	No documentation available.
POST api/v1/receiving-acqs/update-receiving-acqs-detail	No documentation available.
POST api/v1/receiving-acqs/reminder-email	No documentation available.
POST api/v1/receiving-acqs/info-received-letter	No documentation available.
POST api/v1/receiving-acqs/financial-start-letter	No documentation available.
GET api/v1/receiving-acqs/get-jobs	No documentation available.
POST api/v1/receiving-acqs/get-acq-work-receipt	No documentation available.
POST api/v1/receiving-acqs/get-acq-scan	No documentation available.
GET api/v1/receiving-acqs/get-accountant?branchId={branchId}	No documentation available.