Matters

Matters#index

Retrieves all firm matters

GET /matters

Response:

Returns a 200 OK with an array of matters:

[
    {
        "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:

{
    "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,
    "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.

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

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

Response:

Returns a 201 created.

Matters#update

Updates an existing matter.

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

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

Response:

Returns 200 OK

Matters#destroy

Destroys an existing contact

DELETE /matters/:id

Response:

Returns 200 OK