Seach for Monthly Accounts via Operator App/Website (3rd Party) – Parking Base

In order to retrieve monthly account data via your app or website, you need to directly integrate into Valet Manager's Monthly Account Controller API. This API allows you to created new Monthly Accounts, edit details about existing monthly accounts, download reports, and offer a number of convenience methods for data retrieval around monthly accounts.

When searching for an account, there are one primary endpoint of relevance. You can search accounts by account number, permit number, first name, last name, and license plate. It is important to note that the returned accounts must match ALL data entered. So if you enter "JOHN" and "PAYNE" in the first and last name fields, the accounts retuned must have both "JOHN" as the first name and "PAYNE" as the last name.

The following command searches the Company "demo" for account "001-09480"

curl -X GET --header 'Authorization: Bearer <JWT>' 'https://api.valet-manager.com/monthlyAccounts/demo?limit=100&accountNumber=001-09480

Here is the response:

[
  {
    "metadata":  {
      "createdDate":"2021-04-19T15:09:36.650Z",
      "createdSource":"API",
      "modifiedDate":"2021-04-25T04:31:28.707Z",
      "modifiedSource":"API"
    },
    "monthlyPermits":  [
      {
        "permitNumber":"2009101",
        "lastRateChangeDate":"1970-01-01T00:00:00.000Z",
        "baseRate":0,
        "rate":100,
        "startDate":"2021-04-01T04:00:00.000Z",
        "endDate":"2021-05-01T04:00:00.000Z",
        "permitType":"STANDARD",
        "numberOfSpaces":1,
        "specialRateId":"",
        "specialRateName":"",
        "location":"",
        "monthlyCars":  [
          {
            "firstName":"",
            "lastName":"",
            "phone":"",
            "year":"",
            "make":"Aprilia",
            "model":"TEST",
            "color":"Yellow",
            "state":"",
            "plate":"ABC1234",
            "type":"STANDARD",
            "taxCertificate":  {
              "startDate":"1970-01-01T00:00:00.000Z",
              "expirationDate":"1970-01-01T00:00:00.000Z",
              "valid":false},"windshieldStickerNumber":"",
              "claimStickerNumber":"",
              "startDate":"2021-04-19T15:09:37.571Z",
              "endDate":"2021-04-19T15:09:37.571Z",
              "replacement":false
           }
         ],
         "carNumber":1,
         "authorizedDrivers":[],
         "diplomatId":"",
         "commercial":false,
         "nonProfit":false,
         "buildingResident":false,
         "qualifiedResident":false,
         "lastPrinted":"1970-01-01T00:00:00.000Z",
         "status":"ACTIVE",
         "salesTaxPercent":0,
         "serviceTaxPercent":0,
         "cancellationFee":0,
         "securityDeposit":0,
         "securityDepositReturnDate":"2021-04-19T15:09:37.298Z",
         "accessCardDeposit":0,
         "accessCardDepositReturnDate":"2021-04-19T15:09:37.298Z",
         "rentGuarantee":false,
         "rentGuaranteeEndDate":"2021-04-19T15:09:37.298Z",
         "rentStablized":false,
         "customerApprovalSignature":"",
         "customerApprovalIpAddress":"",
         "customerApprovalDateTime":"2021-04-19T15:09:37.298Z",
         "diplomat":false
       }
     ],
     "billingAddress":  {
       "documentId":"",
       "userId":"",
       "company":"",
       "attention":"",
       "address":"",
       "address2":"99 IRVING AVE",
       "city":"",
       "state":"ENGLEWOOD CLIFFS",
       "zip":"NJ","addressName":"",
       "defaultAddress":false,
       "class":"address"
     },
     "mailingAddress":  {  
       "documentId":"",
       "userId":"",
       "company":"",
       "attention":"",
       "address":"99 IRVING AVE",
       "address2":"",
       "city":"ENGLEWOOD CLIFFS",
       "state":"NJ",
       "zip":"07632",
       "addressName":"",
       "defaultAddress":false,
       "class":"address" 
     },
     "documentId":"MonthlyAccount::8ab09b3d-0940-43ba-a821-e31610c4c4db",
     "parentDocumentId":"",
     "accountNumber":"001-09480",
     "channels":[
       "d72046a64560ce9dadd6b2cac963f8d0"
     ],
     "contact":  {
       "firstName":"JOHN",
       "middleName":"",
       "lastName":"PAYNE",
       "title":"",
       "company":"",
       "phoneNumbers":  [
         {
           "number":"4124775555",
           "region":"US",
           "type":"",
           "class":"PhoneNumber"
         }
       ],
       "emailAddresses":  [
         "test@gmail.com"
       ]
     },
     "company":"demo",
     "garageId":"d72046a64560ce9dadd6b2cac963f8d0",
     "balanceDue":500,
     "status":"ACTIVE",
     "taxCertificate":  {  
       "taxCertificateNumber":"07632",
       "startDate":"1970-01-01T00:00:00.000Z",
       "expirationDate":"2021-04-19T15:09:36.650Z",
       "valid":false
     },
     "preventOverride":false,
     "cardNumber":"2669883604028927",
     "quickbooksCustomerName":"",
     "quickbooksListId":"",
     "outstandingBalanceAging":"2021-03-06T04:59:59.000Z",
     "outstandingBalance":200,
     "invoiceFrequency":"MONTHLY",
     "invoiceDayOfWeek":"MONDAY",
     "effectiveDate":"2021-04-19T15:09:36.650Z",
     "automaticPayment":false,
     "automaticPaymentDocumentID":"",
     "automaticPaymentDayOfMonth":5,
     "invoiceNotifications":  [
       "EMAIL"
     ],
     "paymentNotifications":  [ 
       "EMAIL"
     ],
     "accountType":"LEASEHOLDER",
     "minBilling":0,
     "journalAccountType":"INCOME",
     "paidByParentAccount":false,
     "notes":[],"maxBilling":0,
     "attachments":[],
     "history":[],
     "commissionBrokerName":"",
     "commissionBrokerId":"",
     "commissionAmountPercent":0,
     "commissionAmountFlat":0,
     "lastBillingCycle":"1970-01-01T00:00:00.000Z",
     "lastChargeToAccountBillingCycle":"1970-01-01T00:00:00.000Z",
     "lastLateFeeCycle":"1970-01-01T00:00:00.000Z",
     "class":"MonthlyAccount"
  }
]

Related articles