# Supercases

This object allows for the management of many cases across a number of borrowers. That is
to say that a supercase can create, manage, and close many cases at once.
This is particularly useful if an issue occurs which affects a large group of borrowers.
- Cases created by a supercase are called `subcases`
- A supercase can only manage cases it has created (i.e., NOT cases created via the `/cases` endpoint)

Managing "who" is affected by a supercase is an important aspect of supercases:
- A `member` of a supercase is one "borrower-loan" pairing.
- A `population` is a set of members added at once.
  - A supercase might have many populations if different members are
added at different times.
  - It's useful to keep track of sets of members like this because different
actions might need to be taken on different members depending on when
they're added to a supercase.
  - A `population`'s membership may be changed until it is "committed" by setting
`isDraft: false`, at which time the memberships are locked and subcases are created.

 - [GET /supercases](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_list.md)
 - [POST /supercases](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_create.md): Creates a new supercase.
 - [GET /supercases/members-template.csv](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_members_template_csv.md)
 - [GET /supercases/{supercaseId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_get.md)
 - [PUT /supercases/{supercaseId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_update.md)
 - [POST /supercases/{supercaseId}/bulk-create-do-not-interact](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_create_dni.md)
 - [POST /supercases/{supercaseId}/bulk-delete-do-not-interact](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_delete_dni.md)
 - [GET /supercases/{supercaseId}/bulk-operations](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_list.md)
 - [GET /supercases/{supercaseId}/bulk-operations/search](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_search.md)
 - [GET /supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_operation_get.md)
 - [GET /supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/member-bulk-operation-results](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.get_member_bulk_operation_results_by_operation.md): Returns a list of member bulk operation results for the supercase bulk operation. Each member bulk operation result represents a member that was affected by the operation.
 - [GET /supercases/{supercaseId}/bulk-operations/{supercaseBulkOperationId}/target-populations](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.get_bulk_operation_target_populations.md): Returns a list of target populations for the supercase bulk operation. Each target population represents a set of members that will be affected by the operation.
 - [POST /supercases/{supercaseId}/bulk-send](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_send_message.md)
 - [POST /supercases/{supercaseId}/bulk-update](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_bulk_update.md)
 - [GET /supercases/{supercaseId}/case-count](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.supercase_case_count.md)
 - [GET /supercases/{supercaseId}/documents](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.documents.get_supercase_documents.md)
 - [POST /supercases/{supercaseId}/documents](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.documents.add_supercase_documents.md)
 - [PUT /supercases/{supercaseId}/documents](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.documents.set_supercase_documents.md)
 - [GET /supercases/{supercaseId}/global-notes](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_list.md)
 - [POST /supercases/{supercaseId}/global-notes](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_create.md)
 - [GET /supercases/{supercaseId}/global-notes/{noteId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_get.md)
 - [PUT /supercases/{supercaseId}/global-notes/{noteId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.notes.global_note_update.md)
 - [GET /supercases/{supercaseId}/notes](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_list.md)
 - [POST /supercases/{supercaseId}/notes](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_create.md)
 - [GET /supercases/{supercaseId}/notes/{noteId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_get.md)
 - [PUT /supercases/{supercaseId}/notes/{noteId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.notes.private_note_update.md)
 - [GET /supercases/{supercaseId}/populations](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.population_list.md)
 - [GET /supercases/{supercaseId}/populations/draft](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_get.md)
 - [POST /supercases/{supercaseId}/populations/draft/commit](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_commit.md): Creates subcases for all members of the draft population and moves the population to the committed state.
 - [GET /supercases/{supercaseId}/populations/draft/members](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list.md)
 - [POST /supercases/{supercaseId}/populations/draft/members](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add.md): Add to the current population membership the members in this request.
 - [PUT /supercases/{supercaseId}/populations/draft/members](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set.md): Set the draft population membership to the population in this request. (Removing all current members if they exist.)
 - [GET /supercases/{supercaseId}/populations/draft/members.csv](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_list_csv.md)
 - [POST /supercases/{supercaseId}/populations/draft/members.csv](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_add_csv.md): Add to the current population membership with the population in this request. Format is a CSV document.
 - [PUT /supercases/{supercaseId}/populations/draft/members.csv](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.draft_population_members_set_csv.md): Set the current population membership to the population in this request. (Removing all current members if they exist.) Format is a CSV document.
 - [GET /supercases/{supercaseId}/populations/members.csv](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.committed_members_list_csv.md)
 - [GET /supercases/{supercaseId}/populations/{populationId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.population_get.md)
 - [PUT /supercases/{supercaseId}/populations/{populationId}](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.population_update.md): Update the population.
 - [POST /supercases/{supercaseId}/populations/{populationId}/bulk-send](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.population_bulk_send_message.md)
 - [GET /supercases/{supercaseId}/populations/{populationId}/members](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list.md)
 - [GET /supercases/{supercaseId}/populations/{populationId}/members.csv](https://docs.peachfinance.com/api-docs/api-public/supercases/peach.supercases.handlers.population_members_list_csv.md)
