# Matters

### Matters#index

Retrieves all firm matters

```
GET /matters
```

**Response:**

Returns a 200 OK with an array of matters:

```json
[
    {
        "id": 1,
        "number": null,
        "title": "John Doe's Matter",
        "description": null,
        "attorney_id": null,
        "client_id": 1,
        "created_at": "2019-08-22T21:27:00.253-05:00",
        "updated_at": "2019-08-22T21:27:00.253-05:00",
        "archived": false,
        "discarded_at": null,
        "settings": null,
        "firm_id": 1,
        "receipt_number": null,
        "preference_category_id": null,
        "priority_date": null,
        "priority_date_status": "undefined",
        "invoice_id": null,
        "created_by_migration": null,
        "status": null,
        "type": null
    }
]
```

### Matters#show

Returns a single matter

```
GET /matters/:id
```



**Response:**

Returns a 200 OK with a single matter:

```json
{
   "id":1,
   "number":null,
   "title":"John Doe's Matter",
   "description":null,
   "attorney_id":null,
   "client_id":1,
   "created_at":"2019-08-22T21:27:00.253-05:00",
   "updated_at":"2019-08-22T21:27:00.253-05:00",
   "archived":false,
   "discarded_at":null,
   "settings":null,
   "firm_id":1,
   "receipt_number":null,
   "preference_category_id":null,
   "priority_date":null,
   "priority_date_status":"undefined",
   "invoice_id":null,
   "created_by_migration":null,
   "type":null,
   "status":null,
   "user_ids":[
      2
   ],
   "receipts":[
      {
         "id":1,
         "matter_id":1,
         "firm_id":1,
         "number":"EAC0000000000",
         "description":"a description",
         "contact_id":1,
         "created_at":"2024-08-22T18:25:31.393Z",
         "updated_at":"2025-04-01T20:53:49.395Z",
         "status_update_failed_at":"2025-04-01T20:53:49.390Z",
         "status_update_type":"manual"
      }
   ],
   "client":{
      "id":1,
      "first_name":"John",
      "last_name":"Doe",
      "middle_name":null,
      "company_name":null,
      "email":"some@email.com",
      "user_id":null,
      "firm_id":1,
      "settings":null,
      "data":{
         
      },
      "avatar":{
         "url":"default-avatar.png",
         "large_avatar":{
            "url":"default-avatar.png"
         },
         "medium_avatar":{
            "url":"default-avatar.png"
         },
         "small_avatar":{
            "url":"default-avatar.png"
         }
      },
      "discarded_at":null,
      "archived":true,
      "created_at":"2023-10-24T20:41:56.339Z",
      "updated_at":"2024-08-22T18:24:12.196Z",
      "cq_person_settings":{
         "gi_ano":true,
         "gi_ssn":true,
         "bio_tab":true,
         "adtl_tab":null,
         "bio_race":true,
         "work_tab":true,
         "gi_gender":true,
         "bio_height":true,
         "bio_weight":true,
         "family_tab":true,
         "gi_elis_no":true,
         "gi_full_name":true,
         "adtl_sevis_no":null,
         "bio_eye_color":true,
         "family_father":true,
         "family_mother":true,
         "gi_disability":true,
         "bio_hair_color":true,
         "gi_citizenship":true,
         "gi_other_names":true,
         "work_education":true,
         "adtl_irs_tax_no":null,
         "family_children":true,
         "gi_phone_number":true,
         "work_employment":true,
         "adtl_memberships":null,
         "adtl_visa_expiry":null,
         "general_info_tab":true,
         "gi_date_of_birth":true,
         "gi_email_address":true,
         "gi_mobile_number":true,
         "adtl_armed_forces":null,
         "adtl_visa_details":null,
         "gi_place_of_birth":true,
         "adtl_annual_income":null,
         "gi_address_history":true,
         "gi_travel_document":true,
         "adtl_visa_consulate":null,
         "adtl_ever_visited_us":null,
         "gi_work_phone_number":true,
         "adtl_foreign_employer":null,
         "adtl_immi_proceedings":null,
         "family_marital_status":true,
         "adtl_highest_education":null,
         "adtl_other_asset_value":null,
         "adtl_real_estate_value":null,
         "bio_hispanic_or_latino":true,
         "adtl_foreign_residences":null,
         "adtl_prior_pr_petitions":null,
         "adtl_current_immi_status":null,
         "adtl_prior_rtg_issuances":null,
         "adtl_prior_immi_visa_apps":null,
         "adtl_arrival_and_departure":null,
         "adtl_place_of_entry_into_us":null,
         "adtl_primary_field_of_study":null,
         "adtl_prior_work_permit_apps":null,
         "adtl_spouse_applying_for_pr":null,
         "adtl_citizenship_certificate":null,
         "adtl_legal_status_entry_into_us":null,
         "adtl_states_and_countries_lived":null,
         "adtl_checking_and_savings_balance":null
      },
      "cq_company_settings":{
         "cq_fein":true,
         "cq_name":true,
         "cq_fax_no":true,
         "cq_website":true,
         "cq_net_worth":true,
         "cq_naics_code":true,
         "cq_asset_value":true,
         "cq_business_type":true,
         "cq_email_address":true,
         "cq_mailing_address":true,
         "cq_daytime_phone_no":true,
         "cq_net_annual_income":true,
         "cq_gross_annual_income":true,
         "cq_date_of_incorporation":true,
         "cq_no_of_employees_in_us":true,
         "cq_year_of_incorporation":true,
         "cq_no_of_executives_in_us":true,
         "cq_place_of_incorporation":true,
         "cq_authorized_representative_details":true,
         "cq_no_of_special_qualification_positions_in_us":true
      },
      "primary":true,
      "old_application_party_id":null,
      "encrypted_ssn":null,
      "encrypted_ssn_iv":null,
      "created_by_migration":null,
      "uuid":null,
      "assignee_id":null,
      "lead_phone":null,
      "lead_last_contacted":null,
      "lead_message":null,
      "lead":false,
      "lead_contact_frequency":"bi_weekly",
      "lead_status_id":null,
      "lead_converted_date":null,
      "permissions_level":"shared",
      "merged_contact_ids":null,
      "sms_consent":false,
      "opted_out":false,
      "hr_portal_id":null,
      "cached_trust_balance":null,
      "ssn":null
   },
   "notes":[
      {
         "id":1,
         "content":"Note content",
         "category":"All Notes",
         "firm_id":1,
         "matter_id":1,
         "assignee_id":null,
         "created_at":"2024-12-04T16:40:14.026Z",
         "updated_at":"2024-12-04T16:40:14.026Z",
         "created_by_id":1,
         "client_id":1,
         "created_by_migration":null,
         "title":"Note Title",
         "date":"2024-12-04T16:39:00.000Z",
         "discarded_at":null,
         "starred":false,
         "author_name":null,
         "note_category_id":null
      }
   ]
}
```

### Matters#**create**

Creates a new matter. Keep in mind to send matter data inside a matter root key.&#x20;

```
POST /matters
```

You should pass a JSON with the following parameters:

* `number string`
* `title string`
* `description string`
* `client_id integer` _required_
* `user_ids int array`

```json
{
  "matter": {
    "number": "1234",
    "title": "Some title",
    "description": "Some description",
    "client_id": 1,
    "user_ids": [1, 2]
  }
```

**Response:**

Returns a 201 created.&#x20;

### Matters#update

Updates an existing matter.&#x20;

```
PUT /matters/:id
```

You should pass a JSON with the following parameters:

* `number string`
* `title string`
* `description string`
* `client_id integer` _required_
* `user_ids int array`

```json
{
  "matter": {
    "number": "1",
    "title": "New title",
    "description": "New description",
    "client_id": 1,
    "user_ids": [1, 2]
  }
}
```

**Response:**

Returns 200 OK

### Matters#destroy

Destroys an existing contact

```
DELETE /matters/:id
```

**Response:**

Returns 200 OK

### Matters#receipts

Retrieves all matter receipts

```
GET /matters/:id/receipts
```

**Response:**

```json
[
  {
    "id": 1,
    "matter_id": 1,
    "firm_id": 1,
    "number": "EAC0000000000",
    "description": "a description",
    "contact_id": 1,
    "created_at": "2024-08-22T18:25:31.393Z",
    "updated_at": "2025-04-01T20:53:49.395Z",
    "status_update_failed_at": "2025-04-01T20:53:49.390Z",
    "status_update_type": "manual"
  }
]
```

Returns 200 OK
