Resource Information


Description Endpoint to retreive all agreement records.
Resource URL https://api.mpstoolbox.com/v1/agreements
Rate Limited False
Response Format JSON
Authentication API-Key

Parameters


Parameter Type Description Optional Default
None Retreives a list of all agreements approved by Great America. No parameters are required. True NULL

Example


GET https://api.mpstoolbox.com/v1/agreements/

Response

{
  "265729144": {
      "general": {
          "application_id": 265729144,
          "contract_id": 2011847,
          "contract_status": "Approved",
          "date_created": {
          "date": "2024-09-16 00:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/New_York"
          },
          "term": 48,
          "quoted": "No"
      },
      "customer": {
          "company": "B2BToolbox",
          "account_number": "",
          "first_name": "Noah",
          "last_name": "Miller",
          "job_title": "Developer ",
          "email": "nmiller@theb2btoolbox.com",
          "phone": "123-123-1234",
          "website": "www.b2btoolbox.com",
          "signee_name": null,
          "signee_email": null,
          "signee_title": null
      },
      "billing_address": {
          "address1": "201 Test Ave",
          "address2": "",
          "city": "Kingston",
          "state_province": "ON",
          "zip_postal": "12345",
          "phone": "123-123-1234"
      },
      "products": [
          {
          "product_id": 268,
          "base_product_name": "ECOSYS MA4500ifx",
          "base_product_sku": "110C102US0",
          "bundle_name": "ECOSYS MA4500ifx
Office Ready Table Top
47ppm B&W MFP Copy/Print/Scan/Fax", "bundle_sku": "UPB-110C102US0", "manufacturer": "Kyocera", "quantity": 1, "service_type": "MPS", "total_cost": 4309.92, "msrp": "3361.00", "finance_amount": "1961.05", "monthly_cost": "89.79", "monthly_hardware": "59.79", "monthly_service": "30.00", "address1": "201 Park Ave", "address2": "", "city": "Lake Villa", "state_province": "IL", "zip_postal": "60046" } ] } }

Error Response

{
    "code": 204,
    "data": "No Data Found"
}