API version v1.0
| Description | Endpoint to retrieve an agreement specified by it's Great America contract id. |
| Resource URL | https://api.mpstoolbox.com/v1/agreements/{contractid} |
| Rate Limited | False |
| Response Format | JSON |
| Authentication | API-Key |
| Parameter | Type | Description | Optional | Default |
|---|---|---|---|---|
| contractId | bigint | The Great America contract id of the agreement to retrieve. | False | NULL |
| GET | https://api.mpstoolbox.com/v1/agreements/2002907 |
{
"705144388": {
"general": {
"application_id": 705144388,
"contract_id": 2002907,
"contract_status": "Approved",
"date_created": {
"date": "2024-08-20 00:00:00.000000",
"timezone_type": 3,
"timezone": "America/New_York"
},
"term": 60
},
"customer": {
"company": "B2BToolbox",
"account_number": A432,
"first_name": "Noah",
"last_name": "Miller",
"job_title": "Developer",
"email": "nmiller@mpstoolbox.com",
"phone": "123-123-1231",
"website": "www.theb2btoolbox.com",
"signee_name": null,
"signee_email": null,
"signee_title": null
},
"billing_address": {
"address1": "123 Fake Street",
"address2": "",
"city": "Kingston",
"state_province": "AL",
"zip_postal": "01010",
"phone": "123-123-1231"
},
"products": [
{
"product_id": 214,
"base_product_name": "TASKalfa MZ3200i",
"base_product_sku": "1102ZT2US0",
"bundle_name": "TASKalfa MZ3200i",
"bundle_sku": "BND-1102ZT2US0",
"manufacturer": "Kyocera",
"quantity": 1,
"total_cost": 11685.599999999999,
"monthly_cost": 194.76,
"address1": "123 Fake Street",
"address2": "2",
"city": "Kingston",
"state_province": "AL",
"zip_postal": "01010"
}
]
}
}{
"code": 204,
"data": "No Data Found"
}