1.2 KiB
1.2 KiB
ISP / Bandwidth Agreement Lookup Pattern
Goal
Find a client's Internet connectivity details (speed, ISP, circuit ID, cost) using only the ConnectWise PSA API.
Steps
- Resolve the company using a broad partial name search:
GET /company/companies?conditions=name contains "{partial}"
Inspect results and match byidentifier(e.g.,ABCOInsurance). - List ISP configurations (if any):
GET /company/configurations?companyId={id}
Filter bytype.name == "ISP"or inspectnamefor ISP keywords. - Fetch agreement details:
GET /finance/agreements?conditions=company/id={id}
Filter bytype.name(e.g.,ISP Bandwidth/Fiber) to locate the bandwidth contract. - Key fields to surface:
- Agreement:
name,agreementStatus,billAmount,startDate,nextInvoiceDate - Config:
name,ipAddress,modelNumber,vendorNotes - Notes may contain circuit IDs, port details, or rack locations.
- Agreement:
Example Session (worked example; client details redacted)
- Company ID:
<companyId>, Identifier:<ClientIdentifier> - Config:
<site>-Comcast Fiber(ISP type) with circuit notes - Agreements:
<tier> Internet Fiber($<amount>/mo) +municipal/university easement riders($<amount>/mo)