Querying for agency bill plans
Query for agency bill plans using the following endpoints:
- GET
/admin/v1/agency-bill-plans - GET
/admin/v1/agency-bill-plans/{agencyBillPlanId}
Example request
The following GET retrieves an agency bill plan with id bc:145.
Command
GET /admin/v1/agency-bill-plans/bc:145Response
{
"data": {
"attributes": {
"autoProcessWhenPaymentMatches": true,
"clearCommissionThresholdDefaults": {
"usd": "3.00"
},
"clearGrossThresholdDefaults": {
"usd": "5.00"
},
"clearingLogicTarget": {
"code": "payments",
"name": "Payments"
},
"createOffsetsOnBilledInvoices": false,
"currencies": [
{
"code": "usd",
"name": "USD"
}
],
"cycleCloseDayOfMonth": 15,
"cycleCloseDayOfMonthLogic": {
"code": "exact",
"name": "Exact Day"
},
"daysAfterCycleCloseToSendStmnt": 0,
"daysUntilFirstDunningSent": 0,
"daysUntilPromiseReminderSent": 10,
"daysUntilSecondDunningSent": 0,
"effectiveDate": "2024-05-10",
"exceptionForPastDueStatement": true,
"exceptionIfPromiseNotReceived": false,
"firstDunningSentIfNotPaid": false,
"id": "bc:145",
"inUse": false,
"lowCommissionCleared": true,
"lowGrossCleared": true,
"name": "Standard Agency Bill Plan",
"netThresholdForSuppressingStmtDefaults": {
"usd": "2.00"
},
"paymentExceptionsSent": true,
"paymentTermsInDays": 45,
"planOrder": 1,
"pmntSchdChngOffsetsOnBilled": false,
"producerWriteoffThresholdDefaults": {
"usd": "5.00"
},
"promiseDueInDays": 15,
"promiseExceptionsSent": false,
"reminderSentIfPromiseNotRcvd": false,
"secondDunningSentIfNotPaid": false,
"snapshotNonPastDueItems": true,
"statementSentAfterCycleClose": true,
"statementsWithLowNetSuppressed": true,
"workflowPlan": {
"code": "StdAgencyBill",
"name": "Standard Agency Bill"
}
},
"checksum": "0",
"links": {}
}
}