### Pagination Example Source: https://docketwise.gitbook.io/docketwise-api-docs/index Demonstrates how to request subsequent pages of records by specifying the page parameter in the request. ```HTTP GET /contacts?page=2 ``` -------------------------------- ### GET /invoices Source: https://docketwise.gitbook.io/docketwise-api-docs/invoices This endpoint retrieves all invoices for the firm. It returns a list of invoice objects including details like status, dates, and discounts. Useful for getting an overview of all outstanding or paid invoices. ```APIDOC ## GET /invoices ### Description Retrieves all firm invoices. ### Method GET ### Endpoint /invoices ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) Returns an array of invoice objects with fields like id, status, due_date, and more. #### Response Example [ { "id": 1, "firm_id": 1, "user_id": 1, "contact_id": 1, "due_date": "2021-09-29", "close_date": null, "discount_percent_description": null, "discount_percent": 0, "discount_amount_description": null, "discount_amount": 0, "trust_request_amount": null, "trust_level": null, "last_reminder": null, "created_at": "2021-09-22T17:47:49.041Z", "updated_at": "2021-09-22T17:47:49.041Z", "issue_date": "2021-09-22", "invoice_number": "1", "footer": null, "has_discount_percent": false, "has_discount_amount": false, "color_scheme": "", "include_footer": false, "invoice_type": "bill", "status": "paid", "reminder_frequency": 7, "send_reminders": false, "public_code": "1234example", "discarded_at": null, "created_by_id": 1, "stored_total": "0.0", "stored_balance": "0.0", "payment_plan_id": null, "description": "Trust Request", "channel": "email", "viewed_by_contact": false, "include_logo": true, "quickbooks_uid": null } ] ``` -------------------------------- ### GET /documents/:id/download Source: https://docketwise.gitbook.io/docketwise-api-docs/documents Generates a temporary, one-hour public URL for downloading a specific document. ```APIDOC ## GET /documents/:id/download ### Description Generates a 1-hour public URL for the document to be downloaded. ### Method GET ### Endpoint /documents/:id/download ### Response #### Success Response (200) - **url** (string) - A temporary URL to download the document. #### Response Example ```json { "url": "https://s3-url.com/path-to-document" } ``` ``` -------------------------------- ### Retrieve Matter Statuses via GET API Source: https://docketwise.gitbook.io/docketwise-api-docs/matter_statuses Retrieves a list of matter statuses using a GET request to the /matter_statuses endpoint. No additional parameters or authentication details are specified in the provided text. Returns a 200 OK response with an array of matter status objects in JSON format. Limitations may include firm-specific access or required API keys not mentioned here. ```shell GET /matter_statuses ``` ```json [ { "id": 1, "name": "Matter Status", "duration": null, "created_at": "2024-06-25T23:07:09.456Z", "updated_at": "2024-06-25T23:07:09.456Z", "firm_id": 1, "sort": null, "task_list_id": null, "message_template_id": null, "move_to_next_status": false, "cc_message_to_matter_applicant": false } ] ``` -------------------------------- ### GET /oauth/authorize Source: https://docketwise.gitbook.io/docketwise-api-docs/index Initiates the OAuth 2.0 authorization flow. Users must be redirected to this endpoint to grant permission to the application. ```APIDOC ## GET /oauth/authorize ### Description Initiates the OAuth 2.0 authorization flow. Users must be redirected to this endpoint to grant permission to the application. ### Method GET ### Endpoint https://app.docketwise.com/oauth/authorize ### Parameters #### Query Parameters - **response_type** (string) - Required - Must be set to 'code' - **client_id** (string) - Required - The client ID of your application - **redirect_uri** (string) - Required - The URI to redirect users after authorization - **scope** (string) - Optional - The scope of access requested ### Request Example ``` GET /oauth/authorize?response_type=code&client_id=your_client_id&redirect_uri=http%3A%2F%2Fyourapp.com%2Fcallback&scope=public%20write ``` ### Response #### Success Response (302) Redirects to the provided redirect_uri with an authorization code as a query parameter. #### Response Example ``` HTTP/1.1 302 Found Location: http://yourapp.com/callback?code=authorization_code ``` ``` -------------------------------- ### GET /documents Source: https://docketwise.gitbook.io/docketwise-api-docs/documents Retrieves a list of all documents for the firm. Supports filtering by title using the 'search' query parameter. ```APIDOC ## GET /documents ### Description Retrieves all firm documents. Supports filtering by title using the 'search' query parameter. ### Method GET ### Endpoint /documents #### Query Parameters - **search** (string) - Optional - Returns documents filtered by title. ### Request Example ``` GET /documents?search=some%20title ``` ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the document. - **title** (string) - The title of the document. - **firm_id** (integer) - The ID of the firm the document belongs to. - **client_id** (integer) - The ID of the client associated with the document. - **created_at** (string) - Timestamp when the document was created. - **updated_at** (string) - Timestamp when the document was last updated. - **archived** (boolean) - Indicates if the document is archived. - **size** (integer) - The size of the document in bytes. - **user_id** (integer) - The ID of the user who created the document. - **uploaded_by_email** (string) - Email of the user who uploaded the document (if applicable). - **doc_url** (string) - URL to access the document. #### Response Example ```json [ { "id": 1, "title": "John Doe's G28", "firm_id": 1, "client_id": 7, "created_at": "2019-09-02T17:56:46.492-05:00", "updated_at": "2019-09-02T17:56:46.492-05:00", "archived": false, "size": 369233, "user_id": 3, "uploaded_by_email": null, "doc_url": "https://app.docketwise.com/documents/:id" } ] ``` ``` -------------------------------- ### Update Invoice - API Request Example Source: https://docketwise.gitbook.io/docketwise-api-docs/invoices This snippet demonstrates how to update an existing invoice using the Docketwise API. It includes the endpoint path and a JSON payload representing the invoice data to be updated. The example showcases various fields like user ID, contact ID, status, due date, and associated matters. Ensure all required fields are correctly formatted. ```http PUT /invoices/:id ``` ```json { "invoice": { "user_id": 1, "contact_id": 1, "status": "paid", "due_date": "2021-09-29", "close_date": null, "discount_percent_description": null, "discount_percent": 0, "discount_amount_description": null, "discount_amount": 0, "trust_request_amount": null, "invoice_type": "bill", "trust_level": null, "last_reminder": null, "issue_date": "2021-10-06", "footer": null, "has_discount_percent": false, "has_discount_amount": false, "include_footer": false, "send_reminders": false, "reminder_frequency": 7, "description": null, "include_logo": true, "invoice_matters_attributes": [ { "matter_id": 1 } ] } } ``` -------------------------------- ### Retrieve matter types with GET request Source: https://docketwise.gitbook.io/docketwise-api-docs/matter_types Defines the HTTP GET request to retrieve matter types from the Docketwise API. The endpoint requires no input parameters and returns a 200 OK status with an array of matter type objects. It includes nested matter statuses for each matter type. ```http GET /matter_types ``` -------------------------------- ### GET /contacts Source: https://docketwise.gitbook.io/docketwise-api-docs/index Retrieves a list of contacts with pagination support. Returns up to 200 records per page. ```APIDOC ## GET /contacts ### Description Retrieves a list of contacts with pagination support. Returns up to 200 records per page. ### Method GET ### Endpoint https://app.docketwise.com/api/v1/contacts ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number to retrieve (default: 1) ### Request Example ``` GET /contacts?page=2 ``` ### Response #### Success Response (200) - **data** (array) - Array of contact objects - **pagination** (object) - Pagination information in X-Pagination header #### Response Example ``` HTTP/1.1 200 OK X-Pagination: {"total": 500, "per_page": 200, "current_page": 2, "last_page": 3, "next_page_url": "https://app.docketwise.com/api/v1/contacts?page=3", "prev_page_url": "https://app.docketwise.com/api/v1/contacts?page=1"} { "data": [...] } ``` ``` -------------------------------- ### GET /documents/:id Source: https://docketwise.gitbook.io/docketwise-api-docs/documents Retrieves details for a single document specified by its ID. ```APIDOC ## GET /documents/:id ### Description Returns a single document specified by its ID. ### Method GET ### Endpoint /documents/:id ### Response #### Success Response (200) - **id** (integer) - Unique identifier for the document. - **title** (string) - The title of the document. - **firm_id** (integer) - The ID of the firm the document belongs to. - **client_id** (integer) - The ID of the client associated with the document. - **created_at** (string) - Timestamp when the document was created. - **updated_at** (string) - Timestamp when the document was last updated. - **archived** (boolean) - Indicates if the document is archived. - **size** (integer) - The size of the document in bytes. - **user_id** (integer) - The ID of the user who created the document. - **uploaded_by_email** (string) - Email of the user who uploaded the document (if applicable). - **doc_url** (string) - URL to access the document. #### Response Example ```json { "id": 1, "title": "John Doe's G28", "firm_id": 1, "client_id": 7, "created_at": "2019-09-02T17:56:46.492-05:00", "updated_at": "2019-09-02T17:56:46.492-05:00", "archived": false, "size": 369233, "user_id": 3, "uploaded_by_email": null, "doc_url": "https://app.docketwise.com/documents/:id" } ``` ``` -------------------------------- ### GET /matter_statuses Source: https://docketwise.gitbook.io/docketwise-api-docs/matter_statuses Retrieves a list of all matter statuses available in the system. This endpoint returns an array of matter status objects, each containing details like ID, name, creation/update timestamps, and associated firm ID. ```APIDOC ## GET /matter_statuses ### Description Retrieves a list of all matter statuses available in the system. ### Method GET ### Endpoint /matter_statuses ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **matter_statuses** (array) - An array of matter status objects. - **id** (integer) - The unique identifier for the matter status. - **name** (string) - The name of the matter status. - **duration** (any) - The duration associated with the status (can be null). - **created_at** (string) - The timestamp when the matter status was created. - **updated_at** (string) - The timestamp when the matter status was last updated. - **firm_id** (integer) - The identifier of the firm this status belongs to. - **sort** (any) - Sorting information for the status (can be null). - **task_list_id** (any) - The ID of the associated task list (can be null). - **message_template_id** (any) - The ID of the associated message template (can be null). - **move_to_next_status** (boolean) - Indicates if this status automatically moves to the next one. - **cc_message_to_matter_applicant** (boolean) - Indicates if messages are CC'd to the matter applicant. #### Response Example ```json [ { "id": 1, "name": "Matter Status", "duration": null, "created_at": "2024-06-25T23:07:09.456Z", "updated_at": "2024-06-25T23:07:09.456Z", "firm_id": 1, "sort": null, "task_list_id": null, "message_template_id": null, "move_to_next_status": false, "cc_message_to_matter_applicant": false } ] ``` ``` -------------------------------- ### Retrieve All Invoices (GET /invoices) Source: https://docketwise.gitbook.io/docketwise-api-docs/invoices This endpoint retrieves a list of all invoices associated with the firm. It returns a 200 OK status with an array of invoice objects. No specific input parameters are required. ```HTTP GET /invoices ``` -------------------------------- ### GET /matter_types Source: https://docketwise.gitbook.io/docketwise-api-docs/matter_types This endpoint retrieves a list of all matter types available in the system. Each matter type includes details like ID, name, creation timestamps, and associated matter statuses. It is useful for fetching foundational data for case management workflows. ```APIDOC ## GET /matter_types ### Description Retrieves a list of matter types. ### Method GET ### Endpoint /matter_types ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example Empty (GET request with no body) ### Response #### Success Response (200) Returns an array of matter type objects, each containing id, name, created_at, updated_at, firm_id, and an array of matter statuses with their details. #### Response Example [ { "id": 1, "name": "Matter Type", "created_at": "2024-06-25T23:06:22.326Z", "updated_at": "2024-06-25T23:06:22.326Z", "firm_id": 1, "matter_statuses": [ { "id": 1, "name": "Case Evaluation and Document Collection", "duration": null, "created_at": "2024-12-04T16:25:20.950Z", "updated_at": "2024-12-04T16:25:20.950Z", "firm_id": 1, "sort": null, "task_list_id": null, "message_template_id": null, "move_to_next_status": false, "cc_message_to_matter_applicant": false } ] } ] ``` -------------------------------- ### GET /matters/:id Source: https://docketwise.gitbook.io/docketwise-api-docs/matters Retrieves detailed information about a specific legal matter including associated receipts and client data. ```APIDOC ## GET /matters/:id ### Description Returns detailed information about a specific legal matter including associated receipts and client data. ### Method GET ### Endpoint /matters/:id ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the matter to retrieve ### Response #### Success Response (200) Returns a matter object with the following fields: - **id** (integer) - Matter ID - **title** (string) - Matter title - **client_id** (integer) - Associated client ID - **receipts** (array) - Array of receipt objects - **client** (object) - Detailed client information #### Response Example ```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", "primary":true, "old_application_party_id":null, "encrypted_ssn":null, "encrypted_ssn_iv":null, "created_by_migration":null, "uuid":null, "assignee_id":null } } ``` ``` -------------------------------- ### GET /contacts - Retrieve All Contacts Source: https://docketwise.gitbook.io/docketwise-api-docs/contacts Retrieves a list of all firm contacts. This endpoint supports filtering by contact type and a general filter. ```APIDOC ## GET /contacts ### Description Retrieves all firm contacts. Supports filtering by 'type' and 'filter'. ### Method GET ### Endpoint /contacts ### Query Parameters - **type** (string) - Optional - Can be 'Person' or 'Institution'. - **filter** (string) - Optional - Can be 'all'. ### Response #### Success Response (200) - **contacts** (array) - An array of contact objects. #### Response Example ```json [ { "id": 1, "first_name": "John", "last_name": "Doe", "middle_name": null, "company_name": "", "email": null, "lead": false, "lead_phone": null, "created_at": "2020-04-02T23:49:19.738-05:00", "updated_at": "2020-04-02T23:49:20.403-05:00", "physical_address": { "id": null, "street_number_and_name": null, "apartment_number": null, "city": null, "state": null, "county": null, "province": null, "date_from": null, "date_to": null, "in_care_of": null, "created_at": null, "updated_at": null, "country": null } } ] ``` ``` -------------------------------- ### GET /invoices/:invoice_id/charges Source: https://docketwise.gitbook.io/docketwise-api-docs/charges Retrieves all invoice charges for a specific invoice. This endpoint returns a list of charges associated with the given invoice ID. It is useful for fetching historical or current charges on an invoice. ```APIDOC ## GET /invoices/:invoice_id/charges ### Description Retrieves all invoice charges for a specific invoice. ### Method GET ### Endpoint /invoices/:invoice_id/charges ### Parameters #### Path Parameters - **invoice_id** (integer) - Required - The ID of the invoice to retrieve charges for #### Query Parameters #### Request Body ### Request Example ### Response #### Success Response (200) - **charges** (array) - An array of charge objects, each containing id, matter_id, invoice_id, contact_id, firm_id, user_id, description, amount, status, created_at, updated_at, created_by_migration, date #### Response Example [ { "id": 1, "matter_id": null, "invoice_id": 1, "contact_id": 1, "firm_id": 1, "user_id": 2, "description": null, "amount": "100.0", "status": "service", "created_at": "2022-03-03T17:27:09.950Z", "updated_at": "2022-03-03T17:27:10.164Z", "created_by_migration": null, "date": "2022-03-03" }, { "id": 2, "matter_id": 1, "invoice_id": 1, "contact_id": 1, "firm_id": 1, "user_id": 2, "description": "New description", "amount": "100.0", "status": "service", "created_at": "2022-01-12T15:35:32.586Z", "updated_at": "2022-03-03T17:47:39.669Z", "created_by_migration": null, "date": "2022-01-12" } ] ``` -------------------------------- ### Retrieve all contacts (API) Source: https://docketwise.gitbook.io/docketwise-api-docs/contacts GET endpoint to fetch all firm contacts. Supports filtering by contact type (Person/Institution). Returns an array of contact objects with nested address data. ```HTTP GET /contacts ``` ```JSON [ { "id": 1, "first_name": "John", "last_name": "Doe", "middle_name": null, "company_name": "", "email": null, "lead": false, "lead_phone": null, "created_at": "2020-04-02T23:49:19.738-05:00", "updated_at": "2020-04-02T23:49:20.403-05:00", "physical_address": { "id": null, "street_number_and_name": null, "apartment_number": null, "city": null, "state": null, "county": null, "province": null, "date_from": null, "date_to": null, "in_care_of": null, "created_at": null, "updated_at": null, "country": null } } ] ``` -------------------------------- ### Retrieve Single Matter Source: https://docketwise.gitbook.io/docketwise-api-docs/matters This endpoint retrieves a single matter by its ID. It requires a GET request to the specified path and returns a 200 OK status with the matter's details in JSON format. The response includes comprehensive information about the matter, its associated client, and receipts. ```http GET /matters/:id ``` -------------------------------- ### Retrieve Invoice Charges - JSON Response Source: https://docketwise.gitbook.io/docketwise-api-docs/charges This endpoint retrieves all invoice charges for a given invoice ID via GET request. It requires the invoice_id as a parameter in the URL. The response is a JSON array of charge objects with fields like id, amount, status, and dates. No authentication or additional dependencies are mentioned, assuming it's part of the API system. ```json [ { "id": 1, "matter_id": null, "invoice_id": 1, "contact_id": 1, "firm_id": 1, "user_id": 2, "description": null, "amount": "100.0", "status": "service", "created_at": "2022-03-03T17:27:09.950Z", "updated_at": "2022-03-03T17:27:10.164Z", "created_by_migration": null, "date": "2022-03-03" }, { "id": 2, "matter_id": 1, "invoice_id": 1, "contact_id": 1, "firm_id": 1, "user_id": 2, "description": "New description", "amount": "100.0", "status": "service", "created_at": "2022-01-12T15:35:32.586Z", "updated_at": "2022-03-03T17:47:39.669Z", "created_by_migration": null, "date": "2022-01-12" } ] ``` -------------------------------- ### Sample Matter Response Source: https://docketwise.gitbook.io/docketwise-api-docs/matters This is a sample JSON response for the 'Retrieve Single Matter' endpoint. It illustrates the structure and fields returned, including matter details, client information, and receipt data. Note that some fields may be null if not applicable. ```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 } } ``` -------------------------------- ### GET /matters/:id/receipts Source: https://docketwise.gitbook.io/docketwise-api-docs/matters Retrieves all receipts associated with a specific matter. ```APIDOC ## GET /matters/:id/receipts ### Description Retrieves all receipts associated with a specific matter. ### Method GET ### Endpoint /matters/:id/receipts ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the matter whose receipts are to be retrieved. ### Response #### Success Response (200) - **id** (integer) - The ID of the receipt. - **matter_id** (integer) - The ID of the matter associated with the receipt. - **firm_id** (integer) - The ID of the firm. - **number** (string) - The receipt number. - **description** (string) - A description of the receipt. - **contact_id** (integer) - The ID of the contact associated with the receipt. - **created_at** (string) - The timestamp when the receipt was created. - **updated_at** (string) - The timestamp when the receipt was last updated. - **status_update_failed_at** (string) - Timestamp when status update failed. - **status_update_type** (string) - Type of status update. ### Response Example ```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" } ] ``` #### Error Response (404) - **error** (string) - Matter not found. ``` -------------------------------- ### Create New Document - HTTP Source: https://docketwise.gitbook.io/docketwise-api-docs/documents Uploads a new document to the system. Requires document data within a 'document' root key, including title, filename, base64 encoded file data, and optionally client and matter IDs. Returns a 201 Created status. ```HTTP POST /documents { "document": { "title": "Test", "base64_data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z/C/HgAGgwJ/lK3Q6wAAAABJRU5ErkJggg==", "filename": "img.png", "client_id": 8116, "matter_id": 1 } } ``` -------------------------------- ### Generate Document Download URL - HTTP Source: https://docketwise.gitbook.io/docketwise-api-docs/documents Creates a temporary, publicly accessible URL for downloading a specific document. The URL is valid for one hour. Returns a 200 OK with the temporary URL. ```HTTP GET /documents/:id/download ``` -------------------------------- ### POST /notes - Create Note Source: https://docketwise.gitbook.io/docketwise-api-docs/notes Creates a new note. A `matter_id` or `client_id` is required when creating a note. ```APIDOC ## POST /notes ### Description Creates a new note. A `matter_id` or `client_id` is required when creating a note. ### Method POST ### Endpoint /notes ### Parameters #### Request Body - **matter_id** (string) - Required (either matter_id or client_id) - The ID of the matter the note belongs to. - **client_id** (string) - Required (either matter_id or client_id) - The ID of the client the note belongs to. - **title** (string) - Optional - The title of the note. - **content** (string) - Optional - The content of the note. ### Request Example ```json { "matter_id": "1", "title": "request photos", "content": "ask for the missing pictures" } ``` ### Response #### Success Response (201) - **id** (integer) - The unique identifier for the created note. - **content** (string) - The content of the note. - **category** (string) - The category of the note. - **firm_id** (integer) - The ID of the firm the note belongs to. - **matter_id** (string) - The ID of the matter the note is associated with (if any). - **assignee_id** (integer) - The ID of the assignee for the note (if any). - **created_at** (string) - The timestamp when the note was created. - **updated_at** (string) - The timestamp when the note was last updated. - **created_by_id** (integer) - The ID of the user who created the note. - **client_id** (integer) - The ID of the client the note is associated with (if any). - **created_by_migration** (string) - Indicates if the note was created via migration. - **title** (string) - The title of the note. - **date** (string) - The date associated with the note. - **discarded_at** (string) - The timestamp when the note was discarded (if applicable). - **starred** (boolean) - Indicates if the note is starred. - **author_name** (string) - The name of the note's author. - **note_category_id** (integer) - The ID of the note's category. - **client_name** (string) - The name of the associated client. - **assignee_names** (string) - The names of the note's assignees. - **created_by_name** (string) - The name of the user who created the note. - **assignee_user_ids** (array) - An array of user IDs assigned to the note. - **note_category** (object) - Details about the note's category. #### Response Example ```json { "id": 1, "content": "ask for the missing pictures", "category": "All Notes", "firm_id": 1, "matter_id": null, "assignee_id": null, "created_at": "2024-12-24", "updated_at": "2024-12-24T14:20:23.770Z", "created_by_id": 1, "client_id": 1, "created_by_migration": null, "title": "request photos", "date": "2024-12-24T14:20:23.769Z", "discarded_at": null, "starred": false, "author_name": null, "note_category_id": null, "client_name": "John Doe", "assignee_names": "@Jane Doe", "created_by_name": "Jane Doe", "assignee_user_ids": [ 1 ], "note_category": { "id": null, "name": "All Notes", "firm_id": null, "created_at": null, "updated_at": null } } ``` ``` -------------------------------- ### POST /documents Source: https://docketwise.gitbook.io/docketwise-api-docs/documents Creates a new document. The document data should be sent within a 'document' root key in the request body. ```APIDOC ## POST /documents ### Description Creates a new document. The document data should be sent within a 'document' root key in the request body. ### Method POST ### Endpoint /documents #### Request Body - **document** (object) - Required - Contains the document details. - **title** (string) - Required - The title of the document. - **filename** (string) - Required - The name of the file, including its extension (e.g., 'document.pdf'). - **base64_data** (string) - Required - The file content encoded in Base64. - **description** (string) - Optional - A description for the document. - **client_id** (integer) - Required - The ID of the client associated with the document. - **matter_id** (integer) - Required - The ID of the matter associated with the document. ### Request Example ```json { "document": { "title": "Test", "base64_data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z/C/HgAGgwJ/lK3Q6wAAAABJRU5ErkJggg==", "filename": "img.png", "client_id": 8116, "matter_id": 1 } } ``` ### Response #### Success Response (201) Indicates that the document was successfully created. ``` -------------------------------- ### List All Documents - HTTP Source: https://docketwise.gitbook.io/docketwise-api-docs/documents Retrieves a list of all firm documents. Supports filtering by title using a 'search' query parameter. Returns a 200 OK with an array of document objects. ```HTTP GET /documents GET /documents?search=some%20title ``` -------------------------------- ### Create Invoice Charge - JSON Request Source: https://docketwise.gitbook.io/docketwise-api-docs/charges This endpoint creates a new invoice charge via POST request to the specified invoice ID. It requires a JSON body wrapped in a 'charge' root key with required fields like amount, status, and date. Optional fields include description and matter_id. The response is a 201 created status; no full response JSON is provided in the docs. ```json { "charge": { "amount": 100, "status": "service", "date": "2021-09-22", "description": "New description" } } ``` -------------------------------- ### POST /matters Source: https://docketwise.gitbook.io/docketwise-api-docs/matters Creates a new matter. The matter data should be sent within a 'matter' root key in the request body. ```APIDOC ## POST /matters ### Description Creates a new matter. The matter data should be sent within a 'matter' root key in the request body. ### Method POST ### Endpoint /matters ### Parameters #### Request Body - **matter** (object) - Required - Contains matter details. - **number** (string) - Optional - The matter number. - **title** (string) - Optional - The matter title. - **description** (string) - Optional - A description of the matter. - **client_id** (integer) - Required - The ID of the client associated with the matter. - **user_ids** (array of integers) - Optional - An array of user IDs assigned to the matter. ### Request Example ```json { "matter": { "number": "1234", "title": "Some title", "description": "Some description", "client_id": 1, "user_ids": [1, 2] } } ``` ### Response #### Success Response (201) Returns a 201 Created status code upon successful creation. #### Error Response (400/422) - **error** (string) - Description of the error. - **details** (object) - Specific validation errors. ``` -------------------------------- ### Create new contact (API) Source: https://docketwise.gitbook.io/docketwise-api-docs/contacts POST endpoint to create a new contact. Requires contact data wrapped in a contact root key. Supports addresses and phone numbers as nested attributes. Returns 201 on success. ```HTTP POST /contacts ``` ```JSON { "contact": { "first_name": "Test", "middle_name": "Test", "last_name": "Test", "email": "test@test.com", "type": "Person", "addresses_attributes": [{ "data": { "street_number_and_name": "This is and address", "physical": true } }], "phone_numbers_attributes": [{ "data": { "number": "1234567", "daytime": true } }] } } ```