/check-agreement

description: View agreement status and entitlements for a company in ConnectWise PSA
argument-hint: "[company_id] [agreement_id] [include_additions] [active_only]"
arguments: [company_id, agreement_id, include_additions, active_only]

Check ConnectWise PSA Agreement

View agreement status, covered products, and remaining hours/incidents for a company.

Prerequisites

• Valid ConnectWise PSA API credentials configured
• User must have agreement read permissions
• Either company_id or agreement_id is required

Steps

1. **Validate input**

• Require either company_id or agreement_id
• Validate IDs are numeric

2. **Retrieve agreements**

If agreement_id provided:

   GET /finance/agreements/{id}

If company_id provided:

   GET /finance/agreements?conditions=company/id={company_id}

Add active filter if active_only=true:

   conditions=...and cancelledFlag=false and (endDate>=2026-02-04 or endDate is null)

3. **Retrieve agreement additions (if include_additions=true)**

   GET /finance/agreements/{id}/additions

4. **Retrieve covered work types**

   GET /finance/agreements/{id}/workTypes

5. **Retrieve covered work roles**

   GET /finance/agreements/{id}/workRoles

6. **Format and return agreement details**

Parameters

| Parameter | Type | Required | Default | Description | |-----------|------|----------|---------|-------------| | company_id | integer | No* | - | Company ID to check | | agreement_id | integer | No* | - | Specific agreement ID | | include_additions | boolean | No | true | Include additions | | active_only | boolean | No | true | Only show active |

*Either company_id or agreement_id is required

Examples

Check Company Agreements

/check-agreement --company_id 12345

Check Specific Agreement

/check-agreement --agreement_id 9876

Include All Agreements (Including Expired)

/check-agreement --company_id 12345 --active_only false

Minimal View (No Additions)

/check-agreement --agreement_id 9876 --include_additions false

Output

Company Agreements Summary

================================================================================
Agreements for Acme Corporation
================================================================================

Found 2 active agreements

--------------------------------------------------------------------------------
1. Managed Services Agreement (ID: 9876)
--------------------------------------------------------------------------------
Type:           Managed Services
Status:         Active
Start Date:     2025-01-01
End Date:       2025-12-31

Billing:
  Cycle:        Monthly
  Amount:       $2,500.00/month
  Next Invoice: 2026-03-01

Prepaid Hours:
  Purchased:    40.0 hours
  Used:         24.5 hours
  Remaining:    15.5 hours

Coverage:
  Work Types:   Remote Support, On-site Support
  Work Roles:   All Roles

Additions (3):
  - Azure Management (+$500/month)
  - 24/7 Monitoring (+$300/month)
  - Additional Block Hours - 10 hrs (+$1,250, one-time)

--------------------------------------------------------------------------------
2. Break/Fix Agreement (ID: 9877)
--------------------------------------------------------------------------------
Type:           Time & Materials
Status:         Active
Start Date:     2024-01-01
End Date:       None (Perpetual)

Billing:
  Rate:         $175.00/hour
  Minimum:      0.25 hours

Coverage:
  Work Types:   All Types
  Work Roles:   All Roles

Note: Used for non-covered work.

================================================================================

Detailed Single Agreement

================================================================================
Agreement: Managed Services Agreement
================================================================================

Basic Information:
  ID:             9876
  Name:           Managed Services Agreement
  Type:           Managed Services
  Parent:         None

Company:
  Name:           Acme Corporation
  ID:             12345

Status:
  Active:         Yes
  Start Date:     2025-01-01
  End Date:       2025-12-31
  Auto Renew:     Yes
  Days Until Exp: 300 days

================================================================================
Financial Summary
================================================================================

Billing Information:
  Cycle:          Monthly
  Amount:         $2,500.00
  Terms:          Net 30
  Next Invoice:   2026-03-01

Annual Value:     $30,000.00

================================================================================
Prepaid Hours/Block Time
================================================================================

Block Hours Summary:
  Total Purchased:   50.0 hours
  Total Used:        34.5 hours
  Remaining:         15.5 hours

Block Hours Breakdown:
  +40.0 hrs - Initial Agreement Block (Jan 2025)
  +10.0 hrs - Additional Block Purchase (Jan 2026)
  -34.5 hrs - Used to date

Utilization:        69% used

Warning: 15.5 hours remaining. Consider upselling additional block.

================================================================================
Covered Work Types
================================================================================

| Work Type        | Hourly Rate | Effective Rate | Limit      |
|------------------|-------------|----------------|------------|
| Remote Support   | $150.00     | Covered        | Unlimited  |
| On-site Support  | $175.00     | Covered        | Unlimited  |
| Phone Support    | $125.00     | Covered        | Unlimited  |
| Project Work     | $175.00     | Not Covered    | N/A        |

================================================================================
Covered Work Roles
================================================================================

| Work Role         | Covered | Notes