Custom Key Dates

"A Key Date is a custom date which can be configured by an agency to track important dates, milestones, progress points, etc. for a given application.",

• id* (string) - The primary key for the record.
• type* (string) - The JSON:API type specifier.
• attributes* (object) - Primary record attributes.
  • date* (string) - The date of the key date, as entered by the caseworker
  • key-date-name* (string) - The name of the key date.
  • key-date-slug* (string) - A slug for the key date
  • key-date-description* (string) - A description of the key date, as entered by the agency.
  • created-at* (string) - Date the key date was first created in Binti.
  • updated-at* (string) - Date the key date was last updated in Binti.
  • related-attributes* (object) - Attributes from related models. Prefaced with which relationship the attributes come from.
    • application-id* (string) - ID of the associated application.
    • application-created-at* (string) - Date application was created.
    • application-type* (string) - Type of application (Initial or Renewal).
    • application-status* (string) - Status of the application.
    • application-external-identifier* (string) - External systems identifier for individual Application. Must be unique for agency.
    • license-external-identifier* (string) - External systems identifier for a License or collection of Applications per family. Must be unique for agency.
• 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.
  • application (object) - A relationship with a single entry.
    • data* (object) - The related application

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

      • type* (string) - Always initial-applications or renewal-applications

        Allowed values

        • initial-applications
        • renewal-applications