Case Notes

A Case Note is a free form note that is written by a case worker to log information about a case. A Case Note can be assigned to a family, or a Child. There are various types of Case Notes that allow for other fields to be populated.

• id* (string) - The primary key for the record.
• type* (string) - The JSON:API type specifier.
• attributes* (object) - Primary record attributes.

  • amount-spent* (number) - Amount spent on services.

  • case-note-body* (string) - Case Note content. Free text field.

  • case-note-type* (string) - Case Note category.

    Allowed values

    • visit
    • phone_call
    • email
    • other
    • supervision
    • case_update
    • complaint_or_violation
    • placement
    • approval_date_estimate
    • family_evaluation
    • recruiting
    • support_services
    • next_planned_contact
    • placement_approval
    • training
    • renewal_progress_update
    • reference_update
    • email_campaign
    • automated_email
    • legal_consult
    • medical
    • home_environment

  • contact-method* (string) - Means of contact with family if applicable.

    Allowed values

    • contact_email
    • contact_phone_call
    • contact_visit
    • contact_written_letter
    • contact_attempted_visit
    • contact_scheduled_visit
    • contact_case_management_meeting
    • contact_text_message
    • contact_video_conference
    • contact_other

  • date* (string) - Date the events of this Case Note took place.

  • estimated-approval-date* (string) - Date of estimated application approval, if relevent.

  • support-service-type* (string) - Support service provided with Case Note.

    Allowed values

    • education
    • employment
    • child_care
    • legal
    • case_management
    • clothing
    • food
    • mental_health
    • family_team
    • furniture
    • healthcare
    • safety_items
    • support_groups
    • mentoring
    • visitation
    • dpss_wic
    • recreation
    • rent
    • transportation

  • license-external-identifier* (string) - External id on the License associated with the User subject of Case Note.

  • created-at* (string) - Date Case Note was created in Binti.

  • updated-at* (string) - Date Case Note was last updated at in Binti.

• relationships (object) - Related objects. For each relationship, you can find detailed information about the object by issuing another API call to look it up by ID, or for certain endpoints, you will find details in the "included" section.
  • caseworker (object) - A relationship with a single entry.
    • data* (object) - A reference to the Agency Worker who authored this Case Note.

      • id* (string) - The ID of the other object.

      • type* (string) - Always agency-workers

        Allowed values

        • agency-workers
  • adult-profile (object) - A relationship with a single entry.
    • data* (object) - A reference to the user to which this Case Note refers.

      • id* (string) - The ID of the other object.

      • type* (string) - Always user-agency-profiles

        Allowed values

        • user-agency-profiles
  • child (object) - A relationship with a single entry.
    • data* (object) - A reference to the Child to which this Case Note refers.

      • id* (string) - The ID of the other object.

      • type* (string) - Always children

        Allowed values

        • children
  • licenses (object) - A relationship with multiple entries.
    • data* (array) - Array of entries.

      • id* (string) - The ID of the other object.

      • type* (string) - Always licenses

        Allowed values

        • licenses