Follow

Manual Integration

Payer/Resident Upload CSV Format- 

  • Fields
    • First/Last Name (Either firstName or lastName required)
    • birthDate (Not Required)
      • mm/dd/yyyy format
    • email (Not Required)
    • phone (Not Required)
    • Type (Not Required - defaults to resident)
      • Options:
        • PAYER
        • RESIDENT
        • PROSPECT
    • Account Number (required)
    • PayStatusType (Not Required - defaults to not_accept if left blank)
      • Options:
        • ACCEPT
        • NOT_ACCEPT
        • CERTIFIED_FUNDS
    • accountId (Required - This the ID that links the person to a property/account, if you do not know this reach out to support)
    • residentId (Required - This is an identifier that is set by the client for the payer/resident. The resident Id needs to be unique for each resident/person)
    • code (Not Required)
    • parentId (Not Required)
    • parentCode (Not Required)
    • propertyId (Not Required)
    • leaseId (Not Required)
    • LeaseStatusType (Not Required - defaults to past if left blank, for payer applications use current)
      • Options:
        • CURRENT
        • PAST
        • FUTURE
        • EVICT
    • address (Not Required)
    • unitId (Not Required)
    • unit (Required - This is where the unit number should be placed)
    • city (Not Required)
    • state (Not Required)
    • zip (Not Required)
    • buildingId (Not Required - This is where the building number should be placed if desired)
    • leaseStartOn (Not Required - If used lease start date should have format mm/dd/yyyy)
    • leaseEndOn (Not Required - If used lease end date should have format mm/dd/yyyy)
    • moveInOn (Not Required - If used move in on date should have format mm/dd/yyyy)
    • moveOutOn (Not Required - If used move out on date should have format mm/dd/yyyy)
    • roommate (Not Required - defaults to false if left blank)
      • Options:
        • TRUE
        • FALSE
    • pets (Not Required - defaults to false if left blank)
      • Options:
        • TRUE
        • FALSE

 

Prospect Upload -

 

  • Fields
    • First/Last Name (Either firstName or lastName required)
    • birthDate (Not Required)
    • email (Not Required)
    • phone (Not Required)
    • Type (Not Required - defaults to prospect)
      • Options:
        • PROSPECT
        • RESIDENT
    • Account Number (required)
    • PayStatusType (Not Required - defaults to not_accept if left blank)
      • Options
        • ACCEPT
        • NOT_ACCEPT
        • CERTIFIED_FUNDS
    • accountId (Required - This the ID that links the person to a property/account, if you do not know this reach out to support)
    • prospectId (Required - This is a prospect identifier that is set by the client. The prospect Id needs to be unique for each prospect)
    • code (Not Required)
    • visitedOn (Not Required - Date on which the prospect visited)
    • agent (Not Required - Agent associated with prospect)
    • rent (Not Required - Cost of unit prospect was shown)
    • moveInOn (Not Required - If used move in on date should have format mm/dd/yyyy)
    • leaseStartOn (Not Required - If used lease start date should have format mm/dd/yyyy)
    • leaseEndOn (Not Required - If used lease end date should have format mm/dd/yyyy)
    • receivables (Not Required - Amount for prospect receivables)

 

 

Receivables Upload -

 

  • Fields
    • accountId (Required - This the Id that links the receivables to a property/account, if you do not know this reach out to support)
    • personId (Required - This is Id of the resident or prospect that the receivables are associated with that were set upon resident/prospect upload)
    • due (Required - The date this receivable is due in format mm/dd/yyyy)
    • code ( Required - This is the client designated code used for the receivable e.g. Rent,Water, Loan, etc.)
    • description (Required - This is a description of the receivables that will displayed to resident)
    • amount (Required - This is the amount of the receivable in pennies e.g. $5.00 would be 500)
  • Notes - Multiple receivables can be uploaded for one resident/payer, each receivable would require its own line on the .csv with the correct account and person ID's. 
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk