openapi: 3.0.1 info: title: Firms API description: "We're developing a ground breaking software & know-how platform for small and medium sized law firms to recruit new clients, delight them with improved and more efficient service, and retain them. \n\nSo solving the most important commercial questions law firms ask themselves, namely how can we \n\n- get more clients, or deliver more services to those we have? \n- improve service levels whilst lowering service costs? \n- improve operating margins and grow the firm? \n\nThe first set of applications are based on our tools and know-how from founding and running top rated http://www.trademarkdirect.co.uk #1 UK attorney firm for trade marks serving 1500 clients a year. \n\nThese include our US patented trade mark similarity algorithms and machine learning modules for monitoring trade mark infringement. But our vision extends way beyond trade mark services to offer a valuable operating system' for all small and medium law firms, initially in the UK and US but expanding to all major economies and beyond in time.\n\nThis API will allows you handle all operations at Firms level." version: '1.0' servers: - url: https://api.lawpanel.com/v1/firms paths: /search: get: tags: - TMD summary: 'Searches - 05.List[S]' description: "List of searches\nOrder by date descending" operationId: 57d1b3e978125813d06c1c0e parameters: - name: take in: query description: How many to take schema: enum: - 10 type: number default: 10 - name: skip in: query description: How many to skip schema: enum: - 0 type: number default: 0 responses: '200': description: '' content: application/json: { } '/search/{id}/results': get: tags: - TMD summary: 'Searches - 03.Get results[S]' description: Getting results from a search operationId: 57d1b3e978125813d06c1c0f parameters: - name: id in: path description: Search Id required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: The search has been completed. The response body contains the list of search results. content: application/json: schema: $ref: '#/components/schemas/SearchResults' example: - id: 93f37c80-09be-48d3-a3dd-ddc63a01e0c8 searchId: cf484840-c7e7-4886-a018-fa1e540dd323 score: '50' classes: '25,40' status: Completed textMarkId: '1' textMarkString: '' resultOrder: '1' removed: 'false' selected: 'false' registry: '1' isRegistered: 'false' isRegisteredNoClassMatch: 'false' isAmber: 'false' - id: 6389bffb-db41-4a3a-b66c-a01e96b68492 searchId: cf484840-c7e7-4886-a018-fa1e540dd323 score: '45' classMatch: '23' applicationNumber: '' classes: '25,40' status: Completed textMarkId: '1' textMarkString: '' resultOrder: '1' removed: 'false' selected: 'false' registry: '1' isRegistered: 'false' isRegisteredNoClassMatch: 'false' isAmber: 'false' '204': description: The search is in progress. Query again after a few seconds to see if the search has been completed. content: application/json: { } '404': description: No search has been started with the given id. content: application/json: { } '500': description: The search failed or has been canceled. content: application/json: { } '/search/{id}/status': get: tags: - TMD summary: 'Searches - 02.Get status[S]' description: Getting status of a search operationId: 57d1b3e978125813d06c1c11 parameters: - name: id in: path description: Search Id required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: The search can be found in the queue or among the finished searches. The response contains the search status. content: application/json: example: Completed '404': description: No search has been started with the given id. content: application/json: { } '/search/{id}': get: tags: - TMD summary: 'Searches - 04.Get details[S]' description: Getting details for a search operationId: 57d1b3e978125813d06c1c13 parameters: - name: id in: path description: Search Id required: true schema: type: string responses: '200': description: The search has been completed. The response body contains the list of search results. content: application/json: example: "[\n\t{\n\t\tid: \"93f37c80-09be-48d3-a3dd-ddc63a01e0c8\",\n\t\tsearchId: \"cf484840-c7e7-4886-a018-fa1e540dd323\"\n\t\tscore: 50,\n\t\tclassMatch: 30,\n\t\tapplicationNumber: \"\"\n\t\tclasses: \"25,40\"\n\t\tstatus: \"Completed\",\n\t\ttextMarkId: 1,\n\t\ttextMarkString: \"\"\n\t\tresultOrder: 1,\n\t\tremoved: false,\n\t\tselected: false,\n\t\tregistry: 1, \n\t\tisRegistered: false,\n\t\tisRegisteredNoClassMatch: false, \n\t\tisAmber: false\n\t},\n\t{\n\t\tid: \"6389bffb-db41-4a3a-b66c-a01e96b68492\",\n\t\tsearchId: \"cf484840-c7e7-4886-a018-fa1e540dd323\"\n\t\tscore: 45,\n\t\tclassMatch: 23,\n\t\tapplicationNumber: \"\"\n\t\tclasses: \"25,40\"\n\t\tstatus: \"Completed\",\n\t\ttextMarkId: 1,\n\t\ttextMarkString: \"\"\n\t\tresultOrder: 1,\n\t\tremoved: false,\n\t\tselected: false,\n\t\tregistry: 1, \n\t\tisRegistered: false,\n\t\tisRegisteredNoClassMatch: false, \n\t\tisAmber: false\n\t}\n]" '204': description: The search is in progress. Query again after a few seconds to see if the search has been completed. content: application/json: { } '404': description: No search has been started with the given id. content: application/json: { } '500': description: The search failed or has been canceled. content: application/json: example: message: Search failed '/trademark/{registry}/{id}': get: tags: - TMD summary: 'Trademarks - 01.Get by ID[S]' description: Trademarks - 01.Get by ID operationId: 57d1b3ea78125813d06c1c2e parameters: - name: registry in: path description: '' required: true schema: type: string - name: id in: path description: '' required: true schema: type: string responses: '200': description: '' '204': description: Returned when trademark not exist '500': description: '' '/trademark/searchbytext/{txt}': get: tags: - TMD summary: 'Trademarks - 03.Search by text[S]' description: Trademarks - 03.Search by text operationId: 57d1b3ea78125813d06c1c32 parameters: - name: txt in: path description: '' required: true schema: type: string responses: '200': description: '' '400': description: '' '500': description: '' /watching: get: tags: - Watching summary: 'Watching - 03.Read many[S]' description: Return a list with watching representations. operationId: 57d1b3ea78125813d06c1c38 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with watchings representations.\n\n\n" content: application/json: schema: $ref: '#/components/schemas/ListOfWatching' example: - id: b665ca9e-92b7-444b-b9da-ab4500de7b98 user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 20 firm_portfolio_id: c94a7d6d-83e1-4186-b3fe-a6720147e2a2 application_number: '0303456' trademark: 1LED classes: - '11' registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 registry_name: GB frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly events: [ ] created: '2020-01-17T13:30:02.1027702+00:00' last_search_date_time: '2020-03-25T01:03:47.8640131+00:00' last_notification_date_time: - id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 20 firm_portfolio_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d0 application_number: '0303456' trademark: 5ARTH classes: - '20' registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 registry_name: GB frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly events: - id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f|3139581561719999999 unix_time_stamp: 1579741428 application_date: '2020-01-02T00:00:00.0000000+00:00' application_number: UK00003455018 trademark: 5ARTH classes: '20' databases: GB owner_applicant: Lai Feifeng status: Pending good_and_services: '20: desks [furniture], office furniture, furniture, chairs, display stands, [...]' handled: false created: '2020-01-22T12:50:42.5533169+00:00' last_search_date_time: '2020-03-25T01:03:47.8640131+00:00' last_notification_date_time: '2020-01-23T01:05:06.9702455+00:00' - id: 77e51ee3-bd5e-4dd7-99ca-ab44012577f8 user_id: 77e2dd06-154c-4157-ad69-a6720147e652 user_name: admin@lawpanel.io sensitivity: 3 firm_portfolio_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d3 application_number: '201003372' trademark: WINNING MATTERS classes: - '45' - '36' - '41' - '35' registry_id: ae1159e1-77cc-492f-935f-a835017eab71 registry_name: NO frequency_id: 008d4dea-642c-483a-8c57-a6720147e2d2 frequency_name: Bi-Weekly events: [ ] created: '2020-01-16T17:48:29.2109982+00:00' last_search_date_time: '2020-01-25T01:03:47.8640131+00:00' last_notification_date_time: - id: dcc1815c-af91-40c5-9cbc-ab4500df4e63 user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 20 firm_portfolio_id: application_number: '090978978' trademark: Yun Bey classes: - '9' registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 registry_name: GB frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly events: - id: dcc1815c-af91-40c5-9cbc-ab4500df4e63|3139581561729999999 watching_id: dcc1815c-af91-40c5-9cbc-ab4500df4e63 unix_time_stamp: 1579741427 application_date: '2020-01-07T00:00:00.0000000+00:00' application_number: UK00003455889 trademark: YunBey classes: '9' databases: GB owner_applicant: HUANG WEN WEN status: Pending good_and_services: '9: circular slide rules, slide-rules, counters, egg timers [sandglasses], reflective articles for wear, [...]' handled: false created: '2020-01-17T13:33:01.9800266+00:00' last_search_date_time: '2020-01-25T01:03:47.8640131+00:00' last_notification_date_time: '2020-01-23T01:05:07.7045947+00:00' post: tags: - Watching summary: 'Create Watching[S]' description: Creates a new Watching record for a trademark. operationId: 57d1b3ea78125813d06c1c3a parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "" content: application/json: schema: $ref: '#/components/schemas/CreateWatching' example: firm_portfolio_id: 541fe28f-21f5-40c4-8c15-aad8012ad11c user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 sensitivity: 10 responses: '201': description: "Returns a representation for the new Watching record created.\n\n" content: application/json: schema: $ref: '#/components/schemas/Watching' example: id: 666aaabf-2c4e-46db-b41c-ab8800dd824f user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 10 application_number: '000055236' trademark: BARCLAYS last_search_date: classes: '36,42,9,35,16' registry_id: cfe07713-af2b-4054-b5cf-a6720147e45f registry_name: eu frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly firm_portfolio_id: 08193b28-503d-4f47-82c0-aad8012ca5d7 last_notification_date_time: put: tags: - Watching summary: 'Watching - 04.Update[S]' description: Updates a Watching record. operationId: 57d1b3ea78125813d06c1c3b parameters: - name: cookie in: header description: "User authentication cookie. Read more about how to you get it from here.\n\n" required: true schema: type: string requestBody: description: "" content: application/json: schema: $ref: '#/components/schemas/WatchingUpdate' example: id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f firm_portfolio_id: 605366ae-6ba7-4f0c-acc4-ab4a00d38883 user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 sensitivity: 20 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/WatchingUpdateResult' example: id: b665ca9e-92b7-444b-b9da-ab4500de7b98 message: Watching 'b665ca9e-92b7-444b-b9da-ab4500de7b98' successfully updated successful: true '/watching/{id}': delete: tags: - Watching summary: 'Watching - 05.Delete[S]' description: Deletes a Watching record. operationId: 57d1b3ea78125813d06c1c40 parameters: - name: id in: path description: '' required: true schema: type: string responses: '200': description: Returns data about operation result. get: tags: - Watching summary: 'Watching - 02.Read[S]' description: Get a watching details. operationId: 5e7b5af9500b6b102543a2bb parameters: - name: id in: path description: The watching ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a Watching representation\n\n" content: application/json: schema: $ref: '#/components/schemas/Watching' example: id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 20 firm_portfolio_id: 605366ae-6ba7-4f0c-acc4-ab4a00d38883 application_number: '0303456' trademark: 5ARTH classes: '20' registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 registry_name: GB frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly events: - id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f|3139581561719999999 unix_time_stamp: 1579741428 application_date: '2020-01-02T00:00:00.0000000+00:00' application_number: UK00003455018 trademark: 5ARTH classes: '20' databases: GB owner_applicant: Lai Feifeng status: Pending good_and_services: '20: desks [furniture], office furniture, furniture, chairs, display stands, [...]' handled: false created: '2020-01-22T12:50:42.5533169+00:00' last_search_date: '2020-01-23T01:05:06.9702455+00:00' last_notification_date_time: '2020-01-23T01:05:06.9702455+00:00' /users/getuserdetails: get: tags: - User summary: Get my details description: Return identified user details. operationId: 57d1b3ea78125813d06c1c4e responses: '200': description: Returns an object with details about your current User and Firm identified. content: application/json: schema: $ref: '#/components/schemas/GetMyDetailsResponse' example: user: id: 03ce7827-aac0-477d-a01b-aad8012abc99 first_name: chapeti+alsina003 last_name: chapeti+alsina003 user_name: chapeti+alsina003@gmail.com email: chapeti+alsina003@gmail.com phone_number: '-' language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: English country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: Argentina user_role: FirmUser last_login_date: '2020-09-03T12:40:54.2103716+00:00' is_locked_out: false user_settings: urls_without_help_message: first_page_to_show: send_public_note_to_client: true claims: [ ] firm: id: 7350685c-cc5a-4c85-8a22-aad8012abbaa name: alsina003 firm_settings: id: 34e6a485-5ab4-4982-8cb4-aad8012abb64 header_logo_url: https://lawpanelstoragelive.blob.core.windows.net/public-assets/logo.png secondary_logo_url: https://lawpanelstoragelive.blob.core.windows.net/public-assets/logo.png header_color_left: '#FFFFFF' header_color_right: '#02404C' hide_firm_name_on_header: false tenant_name: alsina003 email: phone_number: payment_provider: payment_provider_publishable_api_key: client: id: 08053072-6b7a-4938-90d8-aad8012ad39e name: International Association for the Intellectual Property company_registration_number: '0303456' contact_name: John Doe contact_email: john@doe.com contact_number: '+543875333953' contact_address: id: 22f2a4a9-5aeb-4abe-b553-aad8012ad39e line1: Los Crespones line2: '749' line3: Tres Cerritos building: Planta Baja floor_level: '-' postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: Argentina billing_address: id: 727eccdf-a1dd-4207-8cd3-aad8012ad39e line1: Alsina line2: '151' line3: Centro building: Torre A floor_level: '2' postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: Argentina client_type: id: 604a3d85-5c5b-4364-b69c-a99201175b30 code: 1 name: Common /account/login: post: tags: - Authentication summary: Login description: "

Identify you at user level and returns the authentication cookie .Lawpanel.AuthCookie that you must include in subsequent requests.

\n\n

This cookie could be used in both: API and Web Site to identify the current user.

\n\n

This cookie plus the subscription-key identifies you at both levels: Firm and User.

" operationId: 57d1b3ea78125813d06c1c50 requestBody: description: 'JSON object with the user access data: email/username and password.' content: application/json: schema: $ref: '#/components/schemas/LoginDetails' example: email: test@example.com password: hunter2 responses: '204': description: "

You will receive a 204 response if the authentication was successfully. On header \"Set-Cookie\" you'll get the .LawPanel.AuthCookie. Response will be very similar to this one:

\n\n

\nCache-Control: no-cache
\nPragma: no-cache
\nExpires: -1
\n\nSet-Cookie:
.LawPanel.AuthCookie=S2pbhI1h-2KeCrllD5PNyo6fP-_pUlvtdU7dYCtKYVX8HiHn7ZcOxuWrdxyzsRFg4gxVycxw3Nh--TxRE6WeyLx_6DkMTBnn21RZMPQjM8hhPli-eBftOPhyKMW_uA9qkLv94sYoN8rAkbrl2x6jN5GN0C5LuXpt1A48PW7h2ZHlKQs-vhrg7t4pj3g0XHVpmuUVytLnZD5bH4iAPuts_LRfLk1ryyf5tcYluRPz-Fy02tBiygQmZ5rqTVNfu1qHwpgX5EOxMoDCA85AsGF3U8BTwMzC2mAXbFYjfVigXHdu5AmhgDGgBunv_MsfvxnFPD-mthNloYCmYq2qqwpf2fRYkoyL2J5jyAtjiCocMkl4NuXKWtUF3JE2GWMNv_gk-sW8svtn7y2xdZPO; domain=lawpanel.com; path=/; secure; HttpOnly
\n
\nAccess-Control-Max-Age: 86400
\nAccess-Control-Allow-Headers: DNT
\nAccess-Control-Allow-Headers: Origin
\nAccess-Control-Allow-Headers: Referer
\nAccess-Control-Allow-Headers: User-Agent
\nAPI-Version: 1
\nAccess-Control-Expose-Headers: API-Version, Skipped, Total, Taken, Order, FileName
\nX-XSS-Protection: 1; mode=block
\nX-Frame-Options: Deny
\nReferrer-Policy: strict-origin
\nDate: Wed, 11 Mar 2020 13:31:19 GMT
\n

\n\n

Please remember to include the .LawPanel.AuthCookie with your subsequent requests. This cookie identifies you at a user level. The subscription key identifies you at a Firm level.

" headers: Set-Cookie: description: This header contains the .LawPanel.AuthCookie to include in subsequent API calls. schema: type: string '400': description: You'll get a 400 ( Bad Request ) if authentication fails. Check your username/password values. /firmportfolio: post: tags: - Trademark summary: 'Trademark - 01.Create[S]' description: "

Creates a new trademark for your portfolio. This method is used to add trademarks non existing on IPO databases.

\n

Remember that a Case with type \"Trademark filing\" is also created with the trademark.

" operationId: 57e56e59f8c9eb0ab0f95ef5 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "Request payload to create the trademark.\n" content: application/json: schema: $ref: '#/components/schemas/CreateTrademark' example: registry_id: 783C0667-2884-4D0A-B93B-A6720147E45F mark_text: LawPanel application_number: '87064395' application_date: '2020-03-17T03:00:00.0000000+00:00' registration_number: '5230966' registration_date: '2020-03-17T03:00:00.0000000+00:00' status_date: '2020-03-17T03:00:00.0000000+00:00' mark_feature: mark status: Valid registration_type_id: 21B28699-8E12-4575-BB65-A99201173ED2 trademark_type_id: 6D374194-9DF4-4A26-89DD-A992011744FD expiry_date: '2020-03-17T03:00:00.0000000+00:00' publication_date: '2020-03-17T03:00:00.0000000+00:00' declaration_date: '2020-03-17T03:00:00.0000000+00:00' office_action_date: '2020-03-17T03:00:00.0000000+00:00' grant_date: '2020-03-17T03:00:00.0000000+00:00' client_agent_id: A1C3E613-C9A5-49C5-91D9-AAAF009C09F1 publication_notes: Notes about publication good_and_services: - language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 text: 'Facilitating, administering, arranging and managing funding in relation to litigation [...]' search_class_id: 5096b33b-2f52-456d-b306-a6720147e7fc - language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 text: 'Design and development of computer hardware and software; software as a service [SaaS]; [...]' search_class_id: 777fe621-5eba-4985-966a-a6720147e7fc image_url: https://web.lawpanel.com/images/firm/logo-lawpanel-white.png notes:

Some extra notes

do_not_create_file: false responses: '201': description: "Returns the trademark created representation: \n\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkCreated' example: id: 677eeb82-99f7-4c68-a797-ab8400f6f701 registry_id: 783c0667-2884-4d0a-b93b-a6720147e45f registry_name: USPTO registry_official_name: USPTO registry_description: United States mark_text: LawPanel application_number: '87064395' application_date: '2020-03-17T03:00:00.0000000+00:00' registration_number: '5230966' registration_date: '2020-03-17T03:00:00.0000000+00:00' status_date: '2020-03-17T03:00:00.0000000+00:00' mark_feature: mark status: Valid registration_type_id: 21b28699-8e12-4575-bb65-a99201173ed2 registration_type_name: Associated Mark trademark_type_id: 6d374194-9df4-4a26-89dd-a992011744fd trademark_type_name: Word/Device expiry_date: '2020-03-17T03:00:00.0000000+00:00' publication_date: '2020-03-17T03:00:00.0000000+00:00' declaration_date: '2020-03-17T03:00:00.0000000+00:00' office_action_date: '2020-03-17T03:00:00.0000000+00:00' grant_date: '2020-03-17T03:00:00.0000000+00:00' client_agent_id: a1c3e613-c9a5-49c5-91d9-aaaf009c09f1 client_agent_name: Stronghold Invest AB publication_notes: Notes about publication good_and_services: - id: be4a9eb5-e20c-4f89-9809-ab8400f6f701 language: id: 8246c1d0-b008-4320-8b1d-a6720147de22 name: English short_name: en is_available_for_ui: true search_class: id: 5096b33b-2f52-456d-b306-a6720147e7fc number: 2 name: Paint products description: 'Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; metals in foil and powder form for painters, decorators, printers and artists.' search_classes: '2' text: 'Facilitating, administering, arranging and managing funding in relation to litigation [...]' - id: ae0a84f0-ebd5-4071-bd9e-ab8400f6f701 language: id: 8246c1d0-b008-4320-8b1d-a6720147de22 name: English short_name: en is_available_for_ui: true search_class: id: 777fe621-5eba-4985-966a-a6720147e7fc number: 3 name: Cosmetics and Cleaning Products description: 'Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; perfumery, essential oils, cosmetics, hair lotions; dentifrices; deodorants for personal use; air perfuming preparations.' search_classes: '3,5,21,35' text: 'Design and development of computer hardware and software; software as a service [SaaS]; [...]' image_url: https://web.lawpanel.com/images/firm/logo-lawpanel-white.png notes:

Some extra notes

do_not_create_file: false user_id: 77e2dd06-154c-4157-ad69-a6720147e652 user_user_name: johndoe@ipfirm.com user: id: 77e2d3212-154c-1127-ad69-6720147e3652 first_name: John last_name: Doe user_name: johndoe@ipfirm.com email: johndoe@ipfirm.com phone_number: +54 9387543988 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: AR user_role: Firm User last_login_date: '2020-03-16T20:26:58.4429693+00:00' is_locked_out: false claims: [ ] trademark_url_on_ipo: exclude_from_auto_updates: false get: tags: - Trademark summary: 'Trademark - 03.Read many[S]' description: Get a list with trademarks for your query. operationId: 5e751ed6bd85d4669025ae5e parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with trademarks for your query.\n\n" content: application/json: schema: $ref: '#/components/schemas/ListOfTrademark' example: - id: 677eeb82-99f7-4c68-a797-ab8400f6f701 registry_id: 783c0667-2884-4d0a-b93b-a6720147e45f registry_name: USPTO registry_official_name: USPTO registry_description: United States mark_text: LawPanel application_number: '87064395' application_date: '2020-03-17T03:00:00.0000000+00:00' registration_number: '5230966' registration_date: '2020-03-17T03:00:00.0000000+00:00' status_date: '2020-03-17T03:00:00.0000000+00:00' mark_feature: mark status: Valid registration_type_id: 21b28699-8e12-4575-bb65-a99201173ed2 registration_type_name: Associated Mark trademark_type_id: 6d374194-9df4-4a26-89dd-a992011744fd trademark_type_name: Word/Device expiry_date: '2020-03-17T03:00:00.0000000+00:00' publication_date: '2020-03-17T03:00:00.0000000+00:00' declaration_date: '2020-03-17T03:00:00.0000000+00:00' office_action_date: '2020-03-17T03:00:00.0000000+00:00' grant_date: '2020-03-17T03:00:00.0000000+00:00' client_agent_id: a1c3e613-c9a5-49c5-91d9-aaaf009c09f1 client_agent_name: Stronghold Invest AB publication_notes: Notes about publication good_and_services: - id: be4a9eb5-e20c-4f89-9809-ab8400f6f701 language: id: 8246c1d0-b008-4320-8b1d-a6720147de22 name: English short_name: en is_available_for_ui: true search_class: id: 5096b33b-2f52-456d-b306-a6720147e7fc number: 2 name: Paint products description: 'Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; metals in foil and powder form for painters, decorators, printers and artists.' search_classes: '2' text: 'Facilitating, administering, arranging and managing funding in relation to litigation [...]' - id: ae0a84f0-ebd5-4071-bd9e-ab8400f6f701 language: id: 8246c1d0-b008-4320-8b1d-a6720147de22 name: English short_name: en is_available_for_ui: true search_class: id: 777fe621-5eba-4985-966a-a6720147e7fc number: 3 name: Cosmetics and Cleaning Products description: 'Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; perfumery, essential oils, cosmetics, hair lotions; dentifrices; deodorants for personal use; air perfuming preparations.' search_classes: '3,5,21,35' text: 'Design and development of computer hardware and software; software as a service [SaaS]; [...]' image_url: https://web.lawpanel.com/images/firm/logo-lawpanel-white.png notes:

Some extra notes

do_not_create_file: false user_id: 77e2dd06-154c-4157-ad69-a6720147e652 user_user_name: johndoe@ipfirm.com trademark_url_on_ipo: exclude_from_auto_updates: false /registries: get: tags: - Registry summary: 'Registry - 02.Read many[S]' description: Get a list with all registries (IPO) available in the system. operationId: 57e9e4b3901adc1844aedf7e parameters: - name: withdata in: query description: 'If you set this parameter to true, you''ll only receive registries with data to perform trademark searches.' schema: type: boolean - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: "Returns a list with all registries availables for your query.\n\n" content: application/json: schema: $ref: '#/components/schemas/RegistryList' example: - id: b93d01dc-3fb7-4c63-b565-a7a700aacdff wipo_code: AD description: ANDORRA have_data: true url_base_for_trademarks: '' iso_three_letters_country_code: AND total_trademarks: 37080 - id: 8952587d-9f09-4bda-9160-a7a700aaca19 wipo_code: AE description: UNITED ARAB EMIRATES have_data: true url_base_for_trademarks: '' iso_three_letters_country_code: ARE total_trademarks: 252109 - id: 1a03674f-2b85-4289-becd-a7a700aaccd5 wipo_code: AF description: AFGHANISTAN have_data: true url_base_for_trademarks: '' iso_three_letters_country_code: AFG total_trademarks: 12869 /trademark/searchbyids: post: tags: - TMD summary: 'Trademarks - 02.Get by IDs[S]' description: Return an array of trademarks passing an array of trademarks ID (integers) into the body of request. operationId: 57ea9130901adc1844aedf80 requestBody: description: An array of integers with the trademarks ID. content: application/json: schema: $ref: '#/components/schemas/GetByIdsParam' example: - 424804 - 424805 responses: '200': description: Return an array with trademarks representations. content: application/json: example: - id: 1294|UK application_number: '1294' registration_date: '1876-01-26T00:00:00.0000000+00:00' application_date: '1876-01-26T00:00:00.0000000+00:00' expiry_date: '2022-01-26T00:00:00.0000000+00:00' mark_feature: Figurative kind_mark: Individual mark_text: 'JAS, Hennessy & Co., Cognac.' classes: '33' status: Registered registry: UK good_and_services: - class_number: 33 description: Brandy. language_code: en applicants: - id: 114985 name: Societe Jas Hennessy & Co address: representatives: - id: 114060 name: Baker & McKenzie LLP address: created_at: '0001-01-01T00:00:00.0000000+00:00' enable: false - id: 1298|UK application_number: '1298' registration_date: '1876-01-25T00:00:00.0000000+00:00' application_date: '1876-01-25T00:00:00.0000000+00:00' expiry_date: '2002-01-25T00:00:00.0000000+00:00' mark_feature: Figurative kind_mark: Individual mark_text: SIR WALTER RALEIGH classes: '34' status: Dead registry: UK good_and_services: - class_number: 34 description: Cigars. language_code: en applicants: - id: 115885 name: E. Alton & Co Limited address: representatives: - id: 113686 name: D. Young & Co. LLP address: created_at: '0001-01-01T00:00:00.0000000+00:00' enable: false /trademark/search: post: tags: - TMD summary: 'Trademarks - 05.Search[S]' description: Trademarks - 05.Search operationId: 580f9722901adc0f60826913 responses: '200': description: '' /client: get: tags: - Company summary: Read many Company description: Return a lists with all Companies available. operationId: 59b92737f8c9eb05e07851e1 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns a list of legal entities available on the system. content: application/json: schema: $ref: '#/components/schemas/ListOfClient' example: - id: 52a17882-38bd-4dfd-8326-aad8012ad09d client: name: Barclays Plc company_registration_number: '0303456' contact_name: Bilbo Baggins contact_email: bilbo@barclays.com contact_number: '+543875333953' contact_address: id: 6a0e84cc-c9c8-4519-b88a-aad8012ad09d line1: Alsina 151 line2: Torre 1 line3: Departamento 2A building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta state_province: Salta region: Noroeste Argentino country_id: 27CB8E50-0E8B-40CD-A656-A6720147E0A1 billing_address: id: 6a0e84cc-c9c8-4519-b88a-aad8012ad09d line1: Alsina 151 line2: Torre 1 line3: Departamento 2A building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta state_province: Salta region: Noroeste Argentino country_id: 27CB8E50-0E8B-40CD-A656-A6720147E0A1 client_type: id: 25eaad5c-2bea-44e5-89e2-a99201175b40 code: 2 name: Agent total_users: 3 total_cases: 1 '204': description: This code is returned if you don't have any Company. content: application/json: { } post: tags: - Company summary: Create Company description: Creates a new Company. operationId: create-company requestBody: description: "\nPayload must contain information about the Company to be created. \n\nMost of the properties are self-explanatory, but these:\n" content: application/json: schema: $ref: '#/components/schemas/CreateCompany' example: client: name: Name of the Company company_registration_number: Registration Number contact_name: Contact name contact_email: contact@email.com contact_number: '+5493875333953' contact_address: line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 billing_address: line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 client_type_id: 0a246949-d71d-49ae-a17b-a975001bdf45 responses: '201': description: If everything happened succesfully returns the model with new Company created. content: application/json: schema: $ref: '#/components/schemas/CreateCompanyResponse' example: id: 7187420e-9e7a-43f6-b832-ac3000d470e9 name: Name of the Company company_registration_number: Registration Number contact_name: Contact name contact_email: contact@email.com contact_number: '+5493875333953' contact_address: id: 7b25e717-b1f1-4bf6-8cde-ac3000d470e7 line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: Argentina billing_address: id: 55217328-90e3-4a5c-a3cf-ac3000d470e7 line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: Argentina client_type: id: 0a246949-d71d-49ae-a17b-a975001bdf45 code: 1 name: Client put: tags: - Company summary: Update Company description: Updates a Company data. operationId: 5fabec4e6846da21c84b96aa requestBody: description: "Payload must contain information about the Company to be updated. \n\nMost of the properties are self-explanatory, but these:\n" content: application/json: schema: $ref: '#/components/schemas/UpdateCompany' example: client: id: 08053072-6b7a-4938-90d8-aad8012ad39e name: International Association for the Intellectual Property company_registration_number: '0303456' contact_name: John Doe contact_email: john@doe.com contact_number: '+543875333953' contact_address: line1: Los Crespones line2: '749' line3: Tres Cerritos building: Planta Baja floor_level: '-' postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 billing_address: line1: Alsina line2: '151' line3: Centro building: Torre A floor_level: '2' postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 client_type_id: 604a3d85-5c5b-4364-b69c-a99201175b30 responses: '201': description: Returns information about the Company Updated. content: application/json: schema: $ref: '#/components/schemas/UpdateCompanyResponse' example: id: 60ec6803-5544-4ac9-b108-aad8012ad3a3 message: Firm client successfully updated successful: true '/client/{id}': delete: tags: - Company summary: Delete Company description: 'Delete a legal entity, company or client.' operationId: 59b92e01f8c9eb05e07851e3 parameters: - name: id in: path description: The Company ID to be deleted. required: true schema: type: string responses: '200': description: Return details about the delete operation. content: application/json: schema: $ref: '#/components/schemas/DeleteCompany' example: id: e43b3206-842c-4deb-99c8-a88d00f55c48 message: Firm client successfully deleted successful: true get: tags: - Company summary: 'Company - 01.Read[S]' description: 'Return a legal entity, company or client details.' operationId: 59dd69c8901adc0c8c7a34bb parameters: - name: id in: path description: '' required: true schema: type: string responses: '200': description: Returns a legal entity representation. content: application/json: schema: $ref: '#/components/schemas/LegalEntity' example: id: 2dafa750-eda5-4a5c-a79e-ab6600b58105 name: company_registration_number: contact_name: contact_email: contact_number: contact_address: id: bc150917-1b49-4d13-bbfc-ab6600b58105 line1: '' line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: 00000000-0000-0000-0000-000000000000 country_name: billing_address: id: a6235631-36be-4483-ab4d-ab6600b58105 line1: line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: 00000000-0000-0000-0000-000000000000 country_name: client_type: id: 604a3d85-5c5b-4364-b69c-a99201175b30 code: 1 name: Common /file: get: tags: - Case summary: Read many Case description: Return all cases available. operationId: 59b93028f8c9eb05e07851e6 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Return all cases enabled to operate. content: application/json: schema: $ref: '#/components/schemas/ReadManyCaseResponse' example: - id: 999ee0a3-209c-4bfa-96a3-ac31009acde1 name: '22242' client: id: c559a609-0948-4085-a7dd-ac31009acd26 name: Robinson Richard company_registration_number: contact_name: '' contact_email: email@server.com contact_number: contact_address: id: 40d1e085-20e1-4afd-83b4-ac31009acd26 line1: line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: c6b020e9-e5b1-425d-823e-a67300008be3 country_name: Brazil billing_address: id: 3118a563-1e88-4c4a-90df-ac31009acd26 line1: line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: c6b020e9-e5b1-425d-823e-a67300008be3 country_name: Brazil client_type: 604a3d85-5c5b-4364-b69c-a99201175b30 file_status_id: dbb513aa-58e3-4a70-a805-a74c00714768 file_status_name: Opened owner: id: 8243ac64-65e9-42b5-a292-a8070178a462 first_name: TMD last_name: Migration user_name: lawpanel@tmd.com email: lawpanel@tmd.com phone_number: '654321' language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 5306aa9a-3c36-40d8-b32e-a67300008be3 country_name: GB other_supervisors: - id: d344g609-0948-4085-a7dd-ac34567ghh56 first_name: Mark last_name: KW user_name: email: phone_number: language_id: language_name: country_id: 5306aa9a-3c36-40d8-b32e-a67300008be3 country_name: GB updated_at: '2020-09-09T09:23:37.5112425+00:00' payment_status: '' updated_by: lawpanel@tmd.com tags: [ ] number: '22242' file_template: id: 3dc49d41-4cdc-47bb-b965-a807017653d4 name: Trademark TMD file_template_components: - id: 2f629748-c13f-4fc3-a760-a80701765553 name: Search result description: Represent a search result executed by a firm definition: definition_type: entity_type: FirmSearch permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 1 value_type: - id: fcad12f2-4efc-4158-8a41-a80701765749 name: Good and services description: Please describe the goods or services the name is to be used with definition: definition_type: entity_type: StringMultiText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - id: 68bb0819-e272-4392-8fcc-a8070176592e name: Website description: If there is a website for your business or goods/services please enter the URL definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 3 value_type: - id: b74feae6-201a-4b7e-a477-a80701765b13 name: Are you already using the name description: 'if so please let us know, this can help us get the name registered' definition: '{"Items":[{"Display":"Not using","Value":"Not using","Enable":false},{"Display":"Less than 1 year","Value":"Less than 1 year","Enable":false},{"Display":"1 - 3 years","Value":"1 - 3 years","Enable":false},{"Display":"4 - 5 years","Value":"4 - 5 years","Enable":false},{"Display":"More than 5 years","Value":"More than 5 years","Enable":false}],"Enable":false}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 4 value_type: - id: b5f55936-ae28-4dab-9425-a80701765d2b name: Series description: Trademark is individual or part of a series? definition: '{"OptionWithTexts":[{"Id":"IndividualTrademark","OptionName":"This is an individual trade mark and not part of a series of trade marks","OptionDescription":"","WithDescription":false,"SelectedByDefault":true,"CreatedAt":"0001-01-01T00:00:00","Enable":false},{"Id":"PartOfSeriesTrademark","OptionName":"This trade mark is part of a series of related trade marks","OptionDescription":"A series of marks is a number of marks which only have very small differences that do not substantially affect the marks (for example, a word shown in CAPITALS and in ''small'' letters).","WithDescription":true,"SelectedByDefault":false,"CreatedAt":"0001-01-01T00:00:00","Enable":false}],"CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: OptionsWithTextDefinitionDto entity_type: OptionsWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 5 value_type: - id: 9c745a64-d9aa-47f8-83e9-a80701765f17 name: Previously registered description: Trademark was previously registered? definition: '{"OptionWithTexts":[{"Id":"NotPreviouslyRegistered","OptionName":"I have not previously registered this trade mark in another country","OptionDescription":"","WithDescription":false,"SelectedByDefault":true,"CreatedAt":"0001-01-01T00:00:00","Enable":false},{"Id":"PreviouslyRegistered","OptionName":"I have previously registered this trade mark in another country","OptionDescription":"If you have previously registered this trade mark in another country you may be able to claim priority over competing trade marks in this country. Please give details of previous registrations (incl. priority date, country, number)","WithDescription":true,"SelectedByDefault":false,"CreatedAt":"0001-01-01T00:00:00","Enable":false}],"CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: OptionsWithTextDefinitionDto entity_type: OptionsWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 6 value_type: - id: b55d051b-940a-4610-a8e3-a807017660fc name: SMS Notifications description: Being able to send you texts can help us progress your application more quickly and efficiently. Please enter your mobile phone number. definition: '{"Id":"SmsNotifications","CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: CheckboxWithTextDefinitionDto entity_type: CheckboxWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 7 value_type: OptionsWithTextValueDto - id: ff7777f7-23f1-430e-94f0-aa4d00e71536 name: Order folder description: Order folder definition: '{"Items":[{"Display":"Abandoned","Value":"Abandoned","Enable":false},{"Display":"Action required","Value":"Action required","Enable":false},{"Display":"Action required (paid)","Value":"Action required (paid)","Enable":false},{"Display":"Client action (paid)","Value":"Client action (paid)","Enable":false},{"Display":"Deleted","Value":"Deleted","Enable":false},{"Display":"For review","Value":"For review","Enable":false},{"Display":"For review (paid)","Value":"For review (paid)","Enable":false},{"Display":"New orders","Value":"New orders","Enable":false},{"Display":"No action","Value":"No action","Enable":false},{"Display":"Ongoing","Value":"Ongoing","Enable":false},{"Display":"Right Start","Value":"Right Start","Enable":false},{"Display":"Standard filing","Value":"Standard filing","Enable":false},{"Display":"To be filed","Value":"To be filed","Enable":false},{"Display":"Client action","Value":"Client action","Enable":false}],"Enable":true}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 8 value_type: - id: ba1be818-5b43-411a-b9db-aa4d00e7153b name: Order status description: Order status definition: '{"Items":[{"Display":"Awaiting client comments","Value":"Awaiting client comments","Enable":false},{"Display":"Filed","Value":"Filed","Enable":false},{"Display":"On hold awaiting client","Value":"On hold awaiting client","Enable":false},{"Display":"Order cancelled","Value":"Order cancelled","Enable":false},{"Display":"Order finished","Value":"Order finished","Enable":false},{"Display":"Prepare for filing","Value":"Prepare for filing","Enable":false},{"Display":"Preparing draft application","Value":"Preparing draft application","Enable":false},{"Display":"Preparing spec","Value":"Preparing spec","Enable":false},{"Display":"Report order placed","Value":"Report order placed","Enable":false},{"Display":"Searches and legal checks","Value":"Searches and legal checks","Enable":false},{"Display":"We''re thinking","Value":"We''re thinking","Enable":false}],"Enable":true}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 9 value_type: is_base: false is_template_for_trademark_filing: true is_template_filing: false base_id: 00000000-0000-0000-0000-000000000000 ip_records: [ ] active: true post: tags: - Case summary: Create Case description: Creates a new case. operationId: Create-a-new-Case requestBody: description: "Payload must contain information about the legal entity, company or client to be created.\n" content: application/json: schema: $ref: '#/components/schemas/CreateCase' example: active: true file_template_id: c554e22c-6f6e-42d3-8954-a780013c92a0 name: Case number: No case reference user_id: 7ed98cd7-cc17-4883-989c-a6730003709d responses: '201': description: This code is returned when the case was created successfully. content: application/json: schema: $ref: '#/components/schemas/CreateCaseResponse' example: enable: true id: f71b5be6-5721-4aca-bede-abab0002dde2 name: Case number: No case reference folder: enable: true id: 31aa7ee6-1394-4bdb-9c06-abab0002ddb8 name: 87d088a8-f7b3-4ce2-8bdc-fae909a2a691_f540accb-d2e5-4016-8582-d71538343486 files: - enable: true id: f71b5be6-5721-4aca-bede-abab0002dde2 name: Case number: No case reference folder: tags: [ ] other_supervisors: client: user: enable: true id: 7ed98cd7-cc17-1487-510c-a6730003709d first_name: Tom last_name: Cruz user_name: tomcruz@act.com email: tomcruz@act.com phone_number: +54 9387452147 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 5306aa9a-3c36-40d8-b32e-a67300008be3 country_name: GB user_role: FirmUser last_login_date: '2020-02-09T23:04:14.4459343+00:00' is_yoti: false is_locked_out: false yoti_id: user_settings: claims: [ ] user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: file_status: enable: true id: dbb513aa-58e3-4a70-a805-a74c00714768 name: Opened initial_state: true file_template: enable: true id: c554e22c-6f6e-42d3-8954-a780013c92a0 name: Generic / basic file_template_components: - enable: true id: 907530ca-ae98-42b6-9293-a780013c92fd name: Free description: Represent any kind of information to save definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 1 value_type: is_base: false is_template_for_trademark_filing: false base_id: 00000000-0000-0000-0000-000000000000 components: created_by: tomcruz@act.com updated_at: '2020-04-28T00:10:26.2597074+00:00' updated_by: tomcruz@act.com firm_portfolio: active: true tags: [ ] other_supervisors: client: user: enable: true id: 7ed98cd7-cc17-1487-510c-a6730003709d first_name: Tom last_name: Cruz user_name: tomcruz@act.com email: tomcruz@act.com phone_number: +54 9387452147 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 5306aa9a-3c36-40d8-b32e-a67300008be3 country_name: GB user_role: FirmUser last_login_date: '2020-02-09T23:04:14.4459343+00:00' is_yoti: false is_locked_out: false yoti_id: user_settings: claims: [ ] user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: file_status: enable: true id: dbb513aa-58e3-4a70-a805-a74c00714768 name: Opened initial_state: true file_template: enable: true id: c554e22c-6f6e-42d3-8954-a780013c92a0 name: Generic / basic file_template_components: - enable: true id: 907530ca-ae98-42b6-9293-a780013c92fd name: Free description: Represent any kind of information to save definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 1 value_type: is_base: false is_template_for_trademark_filing: false base_id: 00000000-0000-0000-0000-000000000000 components: created_by: tomcruz@act.com updated_at: '2020-04-28T00:10:26.2597074+00:00' updated_by: tomcruz@act.com firm_portfolio: active: true '400': description: 'A 400 error is returned if you have some invalid data into your payload, i.e.: biggest text fields, invalid IDs, etc.' content: application/json: example: id: '' message: Invalid file status ID successfull: false put: tags: - Case summary: Update Case description: Updates a Case. operationId: update-case requestBody: description: "Payload with data to update the Case.\n\n" content: application/json: schema: $ref: '#/components/schemas/UpdateCase' example: id: 53d2d270-4129-4a86-9123-ab4500df3da4 name: Yun Bey file_status_id: dbb513aa-58e3-4a70-a805-a74c00714768 file_client_id: tags: - da599d0b-1010-45ca-8ced-ac3600c3c1c7 - ' 5c9ced5e-c6c5-4dee-8fed-ac3600c3ca09' other_supervisors: - 03ce7827-aac0-477d-a01b-aad8012abc99 user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 number: '0303456' components: - file_template_component_id: 03f91a9b-fa22-4e3f-b95d-aad8012abc45 entity_id: 00000000-0000-0000-0000-000000000000 value: Common Law Mark - file_template_component_id: 27cd665d-084b-45d2-a8dc-aad8012abc45 entity_id: 00000000-0000-0000-0000-000000000000 value: Opposed - file_template_component_id: 67d2da70-62ef-4a31-a665-aad8012abc45 entity_id: 00000000-0000-0000-0000-000000000000 value: '2020-09-14T00:00:00.0000000+00:00' - file_template_component_id: 78a1df77-bf30-4439-8dc7-aad8012abc4e entity_id: 00000000-0000-0000-0000-000000000000 value: This is the content for the property "Information" active: 'true' responses: '200': description: Return details about the update operation. content: application/json: example: id: c8650a60-cc9e-476c-bed9-ac3100f3db50 message: File '23109 - Case' successfully updated successful: true /firmfiletemplate: get: tags: - Case Template summary: Read many Case Template description: Return all templates available for create Cases. operationId: 59b9369ff8c9eb05e07851e9 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Return all templates enabled to operate with cases. A template contains different components to save data. content: application/json: example: - enable: true id: c554e22c-6f6e-42d3-8954-a780013c92a0 name: Generic / basic file_template_components: - enable: true id: 907530ca-ae98-42b6-9293-a780013c92fd name: Free description: Represent any kind of information to save definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 1 value_type: is_base: false is_template_for_trademark_filing: false base_id: 00000000-0000-0000-0000-000000000000 cases: 2 - enable: true id: df47efd3-f51e-42e0-a3f4-a74c00715017 name: Opposition file_template_components: - enable: true id: 62968eff-b8d3-4188-84a9-a76400615aef name: Classes description: Classes definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - enable: true id: 13a9f37e-d536-4859-bb76-a7640061607b name: Lawyer description: Lawyer in the opposition definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 3 value_type: - enable: true id: 4890dce9-570b-4f58-bc06-a76400615ea3 name: Opponent description: Opposition opponent definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - enable: true id: 086c016b-deaf-4cb3-9c2e-a76400615ccb name: Registry description: Registry definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - enable: true id: fac0cb33-f3fd-4720-8bfd-a76400615911 name: Trademark description: Represent a trademark definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 1 value_type: is_base: false is_template_for_trademark_filing: false base_id: 00000000-0000-0000-0000-000000000000 cases: 6 - enable: true id: f9e2bd7e-5c91-4008-a6bf-a74c00714ce8 name: Trademark file_template_components: - enable: true id: 29f11b48-64ce-4a3f-a5d5-a76400614edf name: Description description: A field to allow user enter a description about the trademark definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 3 value_type: - enable: true id: 0a9b3a97-36d7-44ba-8f16-a764006154df name: Previously registered description: Previously registered definition: definition_type: entity_type: Boolean permissions: required: false regex_to_validate: multiple_values: false display_order: 6 value_type: - enable: true id: c2604b44-5905-4762-9299-a76400614b21 name: Search result description: Represent a search result executed by a firm definition: definition_type: entity_type: FirmSearch permissions: required: false regex_to_validate: multiple_values: false display_order: 1 value_type: - enable: true id: f8fa52b3-3f5a-48e0-b9cc-a76400615304 name: Series description: Series definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 5 value_type: - enable: true id: b172c72a-3ab9-4463-a094-a764006150bb name: Time in use description: Time in use definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 4 value_type: - enable: true id: bfcf31e5-fa73-4680-8f86-a76400614d02 name: Url description: Url definition: definition_type: entity_type: String permissions: required: false regex_to_validate: multiple_values: false display_order: 2 value_type: is_base: false is_template_for_trademark_filing: false base_id: 00000000-0000-0000-0000-000000000000 cases: 8 /invoiceitem: post: tags: - Invoice Item summary: Create Invoice Item description: Create a new invoice item. operationId: 59b9397bf8c9eb05e07851ea requestBody: description: "Payload must contain information about the new Invoice Item.\n\n\n\n" content: application/json: schema: $ref: '#/components/schemas/CreateFeeItem' example: invoice_entity_id: 53620e77-5e3b-431b-9cb0-ac2800eaac75 invoice_entity_type: File code: '001' name: Item 001 details: This is a fee item for a Case currency_id: 14e294cf-7425-422f-83f2-a6b20003f5e3 quantity: 1 currency_units: 100 taxes: - 1db77783-9e48-4ddc-a665-a6b4002671c1 responses: '201': description: This code is returned when the Invoice Item was created successfully. content: application/json: schema: $ref: '#/components/schemas/CreateInvoiceItemResponse' example: id: 2db77f75-b957-4b5e-9bd3-ac3100d1aeae code: '001' name: Item 001 product_type: id: 615e202e-62f6-43ce-bc9f-a6b200040c9b name: Service currency: id: 14e294cf-7425-422f-83f2-a6b20003f5e3 name: Pound sterling name_short: GBP symbol: £ currency_units: 100 quantity: 1 taxes: - id: 1db77783-9e48-4ddc-a665-a6b4002671c1 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 details: This is a fee item for a Case paid_out: false invoice_entity_type: File invoice_entity_id: 53620e77-5e3b-431b-9cb0-ac2800eaac75 put: tags: - Invoice Item summary: 'Invoice Item - 03.Update[S]' description: 'Invoice Item - 03.Update[S]' operationId: 59b93981901adc17208edbcd responses: '200': description: '' delete: tags: - Invoice Item summary: 'Invoice Item - 04.Delete[S]' description: 'Invoice Item - 04.Delete[S]' operationId: 59b93983901adc17208edbce responses: '200': description: '' get: tags: - Invoice Item summary: Read many Invoice Item description: Return all invoice items available. operationId: 5f594925c3a4d6795ab942b8 parameters: - name: EntityType in: query description: 'The name of the entity binded with the Invoice Items. For example, to get Invoice Items from Cases you have to use "File".' required: true schema: type: string - name: EntityId in: query description: 'The ID of the entity with the Invoice Items binded. If you binded with a Case, it should be the Case ID.' required: true schema: type: string - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Return all Invoice Items available. content: application/json: schema: $ref: '#/components/schemas/InvoiceItemReadManyResponse' example: - id: ce30d5d7-1ce9-498e-a386-ac31015949f1 code: '001' name: Fee item name product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 120 quantity: 1 taxes: 24 details: Details about the fee item. total: 144 invoice: id: 67b65eae-8c99-4544-8549-ac3101599c49 date_time: '2020-09-09T00:00:00.0000000+00:00' date_time_due: '2020-09-09T00:00:00.0000000+00:00' invoice_type: id: de08d07a-b45b-4c53-8622-a7ec017b5dc1 name: Default code: 0 description: This is the default invoice type for all invoices leading_zeros: '0000000000' prefix: A- invoice_number: 1 client: id: 1c71c9bd-0603-4e95-8596-abb400efe5f3 name: David Gonzalez company_registration_number: contact_name: contact_email: contact_number: contact_address: id: bd5b2ed9-8bd8-4756-811f-abb400efe5ee line1: 12821 Newport Avenue line2: line3: building: floor_level: postal_code: '' city: Tustin state_province: region: country_id: 00000000-0000-0000-0000-000000000000 country_name: billing_address: id: 855a4c6e-2990-485b-923c-abb400efe5ee line1: line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: 00000000-0000-0000-0000-000000000000 country_name: client_type: id: 604a3d85-5c5b-4364-b69c-a99201175b30 code: 1 name: Common invoice_items: - id: ce30d5d7-1ce9-498e-a386-ac31015949f1 code: '001' name: Fee item name product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 120 quantity: 1 taxes: - id: 8e113d0d-aa3f-4439-85fb-a6e90008ee65 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 details: Details about the fee item. paid_out: false invoice_entity_type: File invoice_entity_id: ddaa47cc-e75d-4865-895d-abb400f00285 payments: [ ] user: id: 77e2dd06-154c-4157-ad69-a6720147e652 first_name: Admin last_name: Admin user_name: admin@lawpanel.io email: admin@lawpanel.io phone_number: +54 9387543988 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: AR user_role: Admin last_login_date: '2020-09-09T19:52:01.2115975+00:00' is_locked_out: false user_settings: claims: [ ] user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: observations: Invoice notes invoice_entity_type: File invoice_entity_id: ddaa47cc-e75d-4865-895d-abb400f00285 invoice_entity_text: '204': description: This code is returned if the entity doesn't have any Invoice Item. content: application/json: { } /currency: get: tags: - Currency summary: Read many Currency description: Return a list of currency available on the system. operationId: 59b93b43f8c9eb05e07851eb parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Return all currencies enabled to operate with payments and invoices. content: application/json: schema: $ref: '#/components/schemas/CurrencyList' example: - id: 54cb5c6a-a8e0-4dec-afcc-a6e90008d6ae name: American dollar name_short: USD symbol: $ - id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ - id: 20c47730-a985-4346-b6f7-a6e90008d76a name: Euro name_short: EUR symbol: € /invoicetype: get: tags: - Invoice Type summary: Read many Invoice Type description: Return all types of invoices available. operationId: 59b93bbf901adc17208edbcf parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_description in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns a list of Invoice Type available. content: application/json: schema: $ref: '#/components/schemas/InvoiceTypeReadManyResponse' example: - id: de08d07a-b45b-4c53-8622-a7ec017b5dc1 name: Default code: 0 description: This is the default invoice type for all invoices leading_zeros: '0000000000' prefix: '204': description: '' content: application/json: { } /firminvoice: post: tags: - Invoice summary: Create Invoice description: Creates a new invoice. operationId: 59b93c2df8c9eb05e07851ec requestBody: description: "Payload must contain information about the Invoice to be created.\n" content: application/json: schema: $ref: '#/components/schemas/CreateInvoice' example: invoice_items_ids: - ce30d5d7-1ce9-498e-a386-ac31015949f1 client_id: 1c71c9bd-0603-4e95-8596-abb400efe5f3 date_time: 1599609600 date_time_due: 1599609600 invoice_type_id: de08d07a-b45b-4c53-8622-a7ec017b5dc1 invoice_number: 1 observations: Invoice notes responses: '201': description: This code is returned when the client was created successfully. get: tags: - Invoice summary: Read many Invoice description: Returns a list with all invoices available for your Firm. operationId: 59b93c30901adc17208edbd0 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns a list with all Invoices created for your Firm. content: application/json: schema: $ref: '#/components/schemas/ReadManyInvoiceResponse' example: - id: ab88a885-f937-4ce8-9f5d-ac3100f0cb9e date_time: '2020-09-09T00:00:00.0000000+00:00' date_time_due: '2020-09-09T00:00:00.0000000+00:00' invoice_type: id: bec8d8b7-a1e5-4e4c-911a-a7cc00fff1c2 name: Default code: 0 description: This is the default invoice type for all invoices leading_zeros: '0000000000' prefix: A- invoice_number: 1 client: id: 7187420e-9e7a-43f6-b832-ac3000d470e9 name: Name of the Company company_registration_number: Registration Number contact_name: Contact name contact_email: contact@email.com contact_number: '+5493875333953' contact_address: id: 7b25e717-b1f1-4bf6-8cde-ac3000d470e7 line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: Argentina billing_address: id: 55217328-90e3-4a5c-a3cf-ac3000d470e7 line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: Argentina client_type: id: 0a246949-d71d-49ae-a17b-a975001bdf45 code: 1 name: Client total_invoice_items: 120 total_payments: 120 user: id: f947fbce-9f3f-4ece-b002-a68d014e018c first_name: John last_name: Doe user_name: john@doe.com email: john@doe.com phone_number: +54 9387543988 language_id: d690da37-20a7-436a-b6a4-a68900ad35b7 language_name: en country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: AR user_role: Admin last_login_date: '2020-08-31T11:55:18.7668609+00:00' is_locked_out: false user_settings: claims: [ ] currency: id: 14e294cf-7425-422f-83f2-a6b20003f5e3 name: Pound sterling name_short: GBP symbol: £ observations: Observations for the Invoice '204': description: This code is returned if there are not any Invoice for your Firm. content: application/json: { } put: tags: - Invoice summary: 'Invoice - 03.Update[S]' description: 'Invoice - 03.Update[S]' operationId: 59b93c32f8c9eb05e07851ed responses: '200': description: '' delete: tags: - Invoice summary: 'Invoice - 04.Delete[S]' description: 'Invoice - 04.Delete[S]' operationId: 59b93c34901adc17208edbd1 responses: '200': description: '' /paymentmethod: get: tags: - Payment Method summary: Read many Payment Method description: Retrieve all payments methods supported by LawPanel. operationId: 59b93db1901adc17208edbd2 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns a list with all payment methods available to be used to create a Payment. content: application/json: schema: $ref: '#/components/schemas/PaymentMethodReadManyResponse' example: - id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services. payment_method_component_definitions: - id: 7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd name: card_name display_name: Name class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 1 - id: c1138c80-0ee2-4f67-b2da-a7cc00ffc389 name: address_line_one display_name: Address line one class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 2 - id: c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504 name: address_line_two display_name: Address line two class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 3 - id: 3339089b-4535-4ec1-a9b9-a7e8000a3451 name: address_city display_name: City class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 4 - id: 136678f3-6827-4ea9-9a02-a7e8000a3748 name: address_state display_name: State class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 5 - id: 8f298718-3d17-450f-8871-a7e8000a3abc name: address_zip display_name: Zip class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 6 - id: 3bd795ba-adff-45af-8b2f-a7e8000a3cc3 name: address_country display_name: Country class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 7 - id: 2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6 name: observations display_name: Observations class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 8 reusable: true - id: 0b655e83-d46f-432c-80d2-a7cc00ffd4d9 code: 2 name: Bank transfer description: 'Wire transfer, bank transfer or credit transfer is a method of electronic funds transfer from one person or entity to another.' payment_method_component_definitions: - id: b4a59072-0997-464f-a91a-a7e8000a41b8 name: transfer_date display_name: Transfer date class_name: DateTime pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 0 - id: daac72de-87c7-41db-91a4-a7e8000a4426 name: from_bank_name display_name: From bank class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 1 - id: a76af918-047e-4db6-80ad-a7e8000a46a9 name: from_account_number display_name: From account class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 2 - id: 0d6c92ad-3984-4536-b008-a7e8000a4929 name: account_owner display_name: Account owner class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 3 - id: 28d552f1-b005-4442-86bd-a7e8000a4b32 name: to_bank_name display_name: To bank class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 4 - id: b2cc3edb-4fdb-4d74-9e8e-a7e8000a4d3f name: to_account_number display_name: To account class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 5 reusable: false - id: cc6120a1-b639-4746-8fa7-a86401891b45 code: 3 name: Other description: 'Other mechanism to receive payments. Manually, etc.' payment_method_component_definitions: - id: 617309ec-3d1c-46bb-b233-a86401891cc9 name: date display_name: Date class_name: DateTime pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 0 - id: edda0df3-8d47-47f7-b45a-a86401891ed1 name: comments display_name: Comments class_name: BigString pattern: '' mask: required: false select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 1 reusable: false '204': description: This code is returned if there are not payment methods available to use with Payments. content: application/json: { } /paymenttransactiontype: get: tags: - Payment Transaction Type summary: 'Payment Transaction Type - 01.Read[S]' description: 'Payment Transaction Type - 01.Read[S]' operationId: 59b94a49f8c9eb05e07851ee responses: '200': description: '' '204': description: '' /paymentprovider: get: tags: - Payment Provider summary: Read many Payment Provider description: Return all payment providers available to work with in LawPanel. operationId: 59b95063901adc17208edbd3 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns a list with all payment providers implemented on LawPanel. content: application/json: schema: $ref: '#/components/schemas/PaymentProviderReadManyResponse' example: - id: b9fcbbd8-f584-4e44-bf28-a7cc00ffed97 name: Stripe description: 'Stripe is a US technology company, operating in over 25 countries.' url: https://stripe.com/ implementation: is_default: true '204': description: This code is returned if there are not payment providers available to work with. content: application/json: { } /firmpayment: post: tags: - Payment summary: Create Payment description: Creates a new payment. operationId: 59b950e6901adc17208edbd4 requestBody: description: "Payload must contain information about the Payment to be created.\n" content: application/json: schema: $ref: '#/components/schemas/PaymentCreate' example: invoice_id: ab88a885-f937-4ce8-9f5d-ac3100f0cb9e description: A little description for the payment. This is a sample of a payment created with a credit card. payment_provider_id: b9fcbbd8-f584-4e44-bf28-a7cc00ffed97 payment_method_id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 payment_method_components: - name: payment_provider_token value: tok_1HPug6BekBiB2yVLoh0mrG66 - name: card_name value: Johann Sebastian Bach - name: address_line_one value: Frauenplan 21 - name: address_line_two value: '' - name: address_city value: Eisenach - name: address_state value: Thuringia - name: address_zip value: '' - name: address_country value: Germany - name: observations value: '' currency_units: '11.00' capture: true save_current_payment_method_data: true impact_on_payment_provider: true responses: '201': description: This code is returned if the Payment was created successfully. content: application/json: schema: $ref: '#/components/schemas/CreatePaymentResponse' example: id: 45e787ad-defe-4321-b2b6-ac3301338374 date_time: '2020-09-11T18:39:37.3409591+00:00' payment_provider: id: b9fcbbd8-f584-4e44-bf28-a7cc00ffed97 name: Stripe description: 'Stripe is a US technology company, operating in over 25 countries, that allows both private individuals and businesses to accept payments over the Internet.' url: https://stripe.com/ implementation: PaymentProviderStripe is_default: true payment_method: id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services. payment_method_component_definitions: - id: c1138c80-0ee2-4f67-b2da-a7cc00ffc389 name: address_line_one display_name: Address line one class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 2 - id: c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504 name: address_line_two display_name: Address line two class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 3 - id: dc7e0c54-8e1b-47a3-ad0a-a7e8000a2a37 name: payment_provider_token display_name: Credit card token class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 512 min: read_only: false step: place_holder: private: false internal: true display_order: 0 - id: 7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd name: card_name display_name: Name class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 1 - id: 3339089b-4535-4ec1-a9b9-a7e8000a3451 name: address_city display_name: City class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 4 - id: 136678f3-6827-4ea9-9a02-a7e8000a3748 name: address_state display_name: State class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 5 - id: 8f298718-3d17-450f-8871-a7e8000a3abc name: address_zip display_name: Zip class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 6 - id: 3bd795ba-adff-45af-8b2f-a7e8000a3cc3 name: address_country display_name: Country class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 7 - id: 2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6 name: observations display_name: Observations class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 8 reusable: true payment_method_details: Credit card VISA finished with 4242 payment_method_component_instances: - id: ea2194db-9711-4032-a8af-ac33013381b8 payment_method_component_definition: id: dc7e0c54-8e1b-47a3-ad0a-a7e8000a2a37 name: payment_provider_token display_name: Credit card token class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 512 min: read_only: false step: place_holder: private: false internal: true display_order: 0 value: tok_1HQH9kBekBiB2yVLdjDcNThX - id: 8f18f864-fef9-49b5-af5d-ac33013381bb payment_method_component_definition: id: 7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd name: card_name display_name: Name class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 1 value: Johann Sebastian Bach - id: e3e979ff-3955-45e3-b5ae-ac33013381bb payment_method_component_definition: id: c1138c80-0ee2-4f67-b2da-a7cc00ffc389 name: address_line_one display_name: Address line one class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 2 value: Frauenplan 21 - id: ce0a85c2-37ea-458c-98f6-ac33013381bb payment_method_component_definition: id: c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504 name: address_line_two display_name: Address line two class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 3 value: '' - id: 385f14f3-bf74-4419-be5f-ac33013381bb payment_method_component_definition: id: 3339089b-4535-4ec1-a9b9-a7e8000a3451 name: address_city display_name: City class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 4 value: Eisenach - id: e7d63616-76e2-4c70-a47f-ac33013381bb payment_method_component_definition: id: 136678f3-6827-4ea9-9a02-a7e8000a3748 name: address_state display_name: State class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 5 value: Thuringia - id: a88ff455-5aa7-4209-bc0e-ac33013381bb payment_method_component_definition: id: 8f298718-3d17-450f-8871-a7e8000a3abc name: address_zip display_name: Zip class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 6 value: '' - id: e634a53b-09fe-4518-8182-ac33013381bb payment_method_component_definition: id: 3bd795ba-adff-45af-8b2f-a7e8000a3cc3 name: address_country display_name: Country class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 7 value: Germany - id: 8d98d848-244b-4f41-b0bb-ac33013381bb payment_method_component_definition: id: 2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6 name: observations display_name: Observations class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 8 value: '' payment_status: id: 529935ee-8f1a-4d4b-a67e-a7e8000a1579 code: 5 name: Captured description: The payment is captured currency: id: 14e294cf-7425-422f-83f2-a6b20003f5e3 name: Pound sterling name_short: GBP symbol: £ currency_units: 11 payment_status_payment_transaction_types: - id: 51bf2017-0cfc-4bf6-af8e-a7e8000a17f6 payment_status: id: 529935ee-8f1a-4d4b-a67e-a7e8000a1579 code: 5 name: Captured description: The payment is captured payment_transaction_type: id: 413b0c48-74bf-40b7-b534-a7e80009fb61 code: 2 name: Refund description: Refund/cancel/void the payment payment_method_type: NotDefined payment_amount: payment_transactions: - id: 53cd8b42-e06f-4637-ae15-ac330133847f payment_id: 45e787ad-defe-4321-b2b6-ac3301338374 date_time: 1599849578 payment_transaction_status: id: 3d56d236-6881-4450-9436-a7cc00ff837a code: 1 name: Successful description: The transaction has been finished successfully payment_transaction_type: id: fddc3cda-0315-41e5-b0ee-a7e80009f9cc code: 1 name: Capture description: Capture the payment response: 'Invoice details: Number: 1 - Date: 9/9/2020 - Total: 120.000000 - Notes: Observations for the Invoice. Payment details: Total: £ 11.00 - Notes: A little description for the payment. This is a sample of a payment created with a credit card. ' notes: payment_provider_transaction_id: ch_1HQH9oBekBiB2yVLWk9WFPn5 amount: 11 payment_provider_entity_id: ch_1HQH9oBekBiB2yVLWk9WFPn5 get: tags: - Payment summary: 'Payment - 02.Read[S]' description: 'Payment - 02.Read[S]' operationId: 59b950e9f8c9eb05e07851ef responses: '200': description: '' '204': description: '' put: tags: - Payment summary: 'Payment - 03.Update[S]' description: 'Payment - 03.Update[S]' operationId: 59b950ec901adc17208edbd5 responses: '200': description: '' /clientuser: post: tags: - Company User summary: Create Company User description: "

Create a new user for a Company.

\n

Company Users are users able to login into Clients Area for its parent Company.

" operationId: 59b96f7af8c9eb05e07851f0 requestBody: description: "\nPayload must contain information about the Company User to be created. \n\nMost of the properties are self-explanatory, but:\n\n" content: application/json: schema: $ref: '#/components/schemas/CompanyUserCreate' example: client_id: 1c8a8cf8-a58a-46b8-a172-ab440147061f user: user_name: user@domain.com email: user@domain.com password: '123456' first_name: John last_name: Doe phone_number: '+543875333953' is_email_confirmed: true user_role: 2 responses: '201': description: This code is returned when the Company User is created successfully. put: tags: - Company User summary: Update Company User description: Updates a Company User. operationId: 59b96f7ef8c9eb05e07851f2 requestBody: description: "Payload must contain information about the Company User to be updated. \n\nMost of the properties are self-explanatory, but these:\n" content: application/json: schema: $ref: '#/components/schemas/CompanyUserUpdate' example: id: 4d70a45d-a507-4ceb-94df-ac5a00bef87d client_id: 08053072-6b7a-4938-90d8-aad8012ad39e user: id: 52d3a0c6-8157-4b0b-b485-ac5a00bef873 user_name: chapeti+client_alsina_001@gmail.com email: chapeti+client_alsina_001@gmail.com password: '********' first_name: Sebastian last_name: Guerrero phone_number: 387-155 333 953 claims_id: [ ] responses: '200': description: '' get: tags: - Company User summary: Read many Company User description: Returns a list with all Company Users available on your Firm. operationId: read-many-company-user parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: A list of objects with information about the Company Users available. content: application/json: schema: $ref: '#/components/schemas/ReadManyCompanyUser' example: - id: 7d6b5e8c-47e1-4ef1-b7ef-ac2b0134e7dc client: id: 1c8a8cf8-a58a-46b8-a172-ab440147061f name: Company AAA company_registration_number: '' contact_name: '' contact_email: '' contact_number: '' contact_address: id: a1faf098-2f03-4daf-993c-ab440147061f line1: '' line2: '' line3: '' building: '' floor_level: '' postal_code: '' city: '' state_province: '' region: '' country_id: 00000000-0000-0000-0000-000000000000 country_name: billing_address: id: 7207503e-557f-410b-9ebd-ab440147061f line1: '' line2: '' line3: '' building: '' floor_level: '' postal_code: '' city: '' state_province: '' region: '' country_id: 00000000-0000-0000-0000-000000000000 country_name: client_type: id: 0a246949-d71d-49ae-a17b-a975001bdf45 code: 1 name: Client user: id: 2e05b964-f441-4c8f-ab39-ac2b0134e7c5 first_name: John last_name: Doe user_name: user@domain.com email: user@domain.com phone_number: '+543875333953' language_id: d690da37-20a7-436a-b6a4-a68900ad35b7 language_name: en country_id: 57a84942-d7fd-4a92-8014-a68900ad3722 country_name: SY user_role: ClientUser last_login_date: is_locked_out: false user_settings: claims: [ ] user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: claims_id: [ ] - id: c0c37d0d-afdf-4f6e-bec5-ac2b0133c86f client: id: 1c8a8cf8-a58a-46b8-a172-ab440147061f name: Company AAA company_registration_number: '' contact_name: '' contact_email: '' contact_number: '' contact_address: id: a1faf098-2f03-4daf-993c-ab440147061f line1: '' line2: '' line3: '' building: '' floor_level: '' postal_code: '' city: '' state_province: '' region: '' country_id: 00000000-0000-0000-0000-000000000000 country_name: billing_address: id: 7207503e-557f-410b-9ebd-ab440147061f line1: '' line2: '' line3: '' building: '' floor_level: '' postal_code: '' city: '' state_province: '' region: '' country_id: 00000000-0000-0000-0000-000000000000 country_name: client_type: id: 0a246949-d71d-49ae-a17b-a975001bdf45 code: 1 name: Client user: id: 62b29f6e-cbc5-4ab2-afc4-ac2b0133c48d first_name: John last_name: Bach user_name: test423@lawpanel.com email: test323@lawpanel.com phone_number: '783638737' language_id: d690da37-20a7-436a-b6a4-a68900ad35b7 language_name: en country_id: 57a84942-d7fd-4a92-8014-a68900ad3722 country_name: SY user_role: ClientUser last_login_date: is_locked_out: false user_settings: claims: - id: 20d14622-df5c-4997-828d-aa3f00d79b41 claim_target: id: acc902b5-cafe-4cad-a429-aa3f00d79a04 code: 2 name: Client area description: Permissions related with actions over the client users code: 10000 name: Read only description: User can only see all data but not perform any action user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: claims_id: [ ] '/clientuser/{id}': delete: tags: - Company User summary: Delete Company User description: Deletes a Company User. operationId: 59b96f80f8c9eb05e07851f3 parameters: - name: id in: path description: The Company User ID to be deleted. required: true schema: type: string responses: '200': description: '' /countries: get: tags: - Country summary: Read many Country description: Return a list of countries available on the system. operationId: 59bacfe6901adc16e035bf43 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Return a list of all countries available in the system. headers: Total: description: Contains the total of entities without any kind of filters. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/CountryList' example: - id: b3104111-a38d-43fc-a43f-a9b600100166 name: Kosovo short_name: XK weight_order: 0 - id: ec025ddd-a939-4669-83c1-a67300008be3 name: Switzerland short_name: CH weight_order: 0 /fileattachment: post: tags: - Case Attachment summary: Create Case Attachment description: Create a new case attachment. operationId: 59bad75af8c9eb0e90ebbb4f requestBody: description: "Payload must contain information about the file attachment to be created.\n" content: application/json: schema: $ref: '#/components/schemas/CreateCaseAttachment' example: comments: .... file_id: f71b5be6-5721-4aca-bede-abab0002dde2 file_name: image3.jpg url: https://image3 file_size: '125' responses: '201': description: This code is returned when the case attachment was created successfully. content: application/json: schema: $ref: '#/components/schemas/ResponseCaseAttachment' example: id: 2abcb204-ab11-4b90-b36c-abad0004e24a file_id: f71b5be6-5721-4aca-bede-abab0002dde2 date_time: '2020-04-30T00:17:46.9276126+00:00' file_name: image3.jpg file_size: 0 comments: .... url: https://image3 user_id: 3df22cd7-cc17-4883-989c-a6745789709d get: tags: - Case Attachment summary: Read many Case Attachment description: Return all cases attachments available. operationId: 59bad75ef8c9eb0e90ebbb50 parameters: - name: fileId in: query description: The Case ID to get attachments added. required: true schema: type: string - name: take in: query description: Return all products enabled to operate with payments and invoices. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Return all cases attachments enabled to operate. content: application/json: schema: $ref: '#/components/schemas/ReadManyCaseAttachment' example: - id: 5c6b1654-a25b-4e95-9cbd-aa4800fdb57e file: id: 7135c0bb-6efb-46e8-84da-a8a900dca8d3 name: Bass & Co's PALE ALE number: '234234' folder: tags: - id: 641b05b3-858d-43e0-9dc4-a74c00713a60 name: Waiting for clients color_text: '#02404c' color_background: '#e2ebed' parent: other_supervisors: client: user: id: 8767ac64-77e9-42b5-a292-a9675453b462 first_name: TMD last_name: Migration user_name: lawpanel@tmd.com email: lawpanel@tmd.com phone_number: '654321' language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 5306aa9a-3c36-40d8-b32e-a67300008be3 country_name: GB user_role: FirmUser last_login_date: '2020-09-09T15:57:20.8386221+00:00' is_yoti: false is_locked_out: false yoti_id: user_settings: claims: [ ] user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: file_status: id: dbb513aa-58e3-4a70-a805-a74c00714768 name: Opened initial_state: true file_template: id: df47efd3-f51e-42e0-a3f4-a74c00715017 name: Opposition file_template_components: - id: fac0cb33-f3fd-4720-8bfd-a76400615911 name: Trademark description: Represent a trademark definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 1 value_type: - id: 62968eff-b8d3-4188-84a9-a76400615aef name: Classes description: Classes definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - id: 086c016b-deaf-4cb3-9c2e-a76400615ccb name: Registry description: Registry definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - id: 4890dce9-570b-4f58-bc06-a76400615ea3 name: Opponent description: Opposition opponent definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - id: 13a9f37e-d536-4859-bb76-a7640061607b name: Lawyer description: Lawyer in the opposition definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 3 value_type: is_base: false is_template_for_trademark_filing: false is_template_filing: false base_id: 00000000-0000-0000-0000-000000000000 ip_records: [ ] components: created_by: user@lawpanel.com updated_at: '2019-05-09T15:22:51.3750060+00:00' updated_by: user@lawpanel.com firm_portfolio: active: false date_time: '2019-05-09T15:23:43.5618522+00:00' file_name: project-image-8-square.png file_size: 180357 comments: '' url: https://lawpanelstoragelive.blob.core.windows.net/public-assets/15a3d7e5-e3ea-4d2f-87f9-6e497c95f20c.png user: id: 77e2dd06-154c-4157-ad69-a6720147e652 first_name: UserA last_name: UserA user_name: user@lawpanel.com email: user@lawpanel.com phone_number: +54 9387543988 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: AR user_role: UserA last_login_date: '2020-09-08T15:21:03.6948257+00:00' is_yoti: false is_locked_out: false yoti_id: user_settings: claims: [ ] user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: - id: 0ddd001b-b907-49c2-9abb-aa4600b1fc61 file: id: c40763bf-e802-4d79-8690-a988015b6a72 name: 19132 - Guava Tree number: '19132' folder: tags: [ ] other_supervisors: client: user: id: 8243ac64-65e9-42b5-a292-a8070178a462 first_name: TMD last_name: Migration user_name: lawpanel@tmd.com email: lawpanel@tmd.com phone_number: '654321' language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 5306aa9a-3c36-40d8-b32e-a67300008be3 country_name: GB file_status: id: dbb513aa-58e3-4a70-a805-a74c00714768 name: Opened initial_state: true file_template: id: 3dc49d41-4cdc-47bb-b965-a807017653d4 name: Trademark TMD file_template_components: - id: 2f629748-c13f-4fc3-a760-a80701765553 name: Search result description: Represent a search result executed by a firm definition: definition_type: entity_type: FirmSearch permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 1 value_type: - id: fcad12f2-4efc-4158-8a41-a80701765749 name: Good and services description: Please describe the goods or services the name is to be used with definition: definition_type: entity_type: StringMultiText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - id: 68bb0819-e272-4392-8fcc-a8070176592e name: Website description: If there is a website for your business or goods/services please enter the URL definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 3 value_type: - id: b74feae6-201a-4b7e-a477-a80701765b13 name: Are you already using the name description: 'if so please let us know, this can help us get the name registered' definition: '{"Items":[{"Display":"Not using","Value":"Not using","Enable":false},{"Display":"Less than 1 year","Value":"Less than 1 year","Enable":false},{"Display":"1 - 3 years","Value":"1 - 3 years","Enable":false},{"Display":"4 - 5 years","Value":"4 - 5 years","Enable":false},{"Display":"More than 5 years","Value":"More than 5 years","Enable":false}],"Enable":false}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 4 value_type: - id: b5f55936-ae28-4dab-9425-a80701765d2b name: Series description: Trademark is individual or part of a series? definition: '{"OptionWithTexts":[{"Id":"IndividualTrademark","OptionName":"This is an individual trade mark and not part of a series of trade marks","OptionDescription":"","WithDescription":false,"SelectedByDefault":true,"CreatedAt":"0001-01-01T00:00:00","Enable":false},{"Id":"PartOfSeriesTrademark","OptionName":"This trade mark is part of a series of related trade marks","OptionDescription":"A series of marks is a number of marks which only have very small differences that do not substantially affect the marks (for example, a word shown in CAPITALS and in ''small'' letters).","WithDescription":true,"SelectedByDefault":false,"CreatedAt":"0001-01-01T00:00:00","Enable":false}],"CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: OptionsWithTextDefinitionDto entity_type: OptionsWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 5 value_type: - id: 9c745a64-d9aa-47f8-83e9-a80701765f17 name: Previously registered description: Trademark was previously registered? definition: '{"OptionWithTexts":[{"Id":"NotPreviouslyRegistered","OptionName":"I have not previously registered this trade mark in another country","OptionDescription":"","WithDescription":false,"SelectedByDefault":true,"CreatedAt":"0001-01-01T00:00:00","Enable":false},{"Id":"PreviouslyRegistered","OptionName":"I have previously registered this trade mark in another country","OptionDescription":"If you have previously registered this trade mark in another country you may be able to claim priority over competing trade marks in this country. Please give details of previous registrations (incl. priority date, country, number)","WithDescription":true,"SelectedByDefault":false,"CreatedAt":"0001-01-01T00:00:00","Enable":false}],"CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: OptionsWithTextDefinitionDto entity_type: OptionsWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 6 value_type: - id: b55d051b-940a-4610-a8e3-a807017660fc name: SMS Notifications description: Being able to send you texts can help us progress your application more quickly and efficiently. Please enter your mobile phone number. definition: '{"Id":"SmsNotifications","CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: CheckboxWithTextDefinitionDto entity_type: CheckboxWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 7 value_type: OptionsWithTextValueDto - id: ff7777f7-23f1-430e-94f0-aa4d00e71536 name: Order folder description: Order folder definition: '{"Items":[{"Display":"Abandoned","Value":"Abandoned","Enable":false},{"Display":"Action required","Value":"Action required","Enable":false},{"Display":"Action required (paid)","Value":"Action required (paid)","Enable":false},{"Display":"Client action (paid)","Value":"Client action (paid)","Enable":false},{"Display":"Deleted","Value":"Deleted","Enable":false},{"Display":"For review","Value":"For review","Enable":false},{"Display":"For review (paid)","Value":"For review (paid)","Enable":false},{"Display":"New orders","Value":"New orders","Enable":false},{"Display":"No action","Value":"No action","Enable":false},{"Display":"Ongoing","Value":"Ongoing","Enable":false},{"Display":"Right Start","Value":"Right Start","Enable":false},{"Display":"Standard filing","Value":"Standard filing","Enable":false},{"Display":"To be filed","Value":"To be filed","Enable":false},{"Display":"Client action","Value":"Client action","Enable":false}],"Enable":true}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 8 value_type: - id: ba1be818-5b43-411a-b9db-aa4d00e7153b name: Order status description: Order status definition: '{"Items":[{"Display":"Awaiting client comments","Value":"Awaiting client comments","Enable":false},{"Display":"Filed","Value":"Filed","Enable":false},{"Display":"On hold awaiting client","Value":"On hold awaiting client","Enable":false},{"Display":"Order cancelled","Value":"Order cancelled","Enable":false},{"Display":"Order finished","Value":"Order finished","Enable":false},{"Display":"Prepare for filing","Value":"Prepare for filing","Enable":false},{"Display":"Preparing draft application","Value":"Preparing draft application","Enable":false},{"Display":"Preparing spec","Value":"Preparing spec","Enable":false},{"Display":"Report order placed","Value":"Report order placed","Enable":false},{"Display":"Searches and legal checks","Value":"Searches and legal checks","Enable":false},{"Display":"We''re thinking","Value":"We''re thinking","Enable":false}],"Enable":true}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 9 value_type: is_base: false is_template_for_trademark_filing: true is_template_filing: false base_id: 00000000-0000-0000-0000-000000000000 ip_records: [ ] components: created_by: lawpanel@tmd.com updated_at: '2019-05-07T10:17:53.3846162+00:00' updated_by: user@lawpanel.com firm_portfolio: active: false date_time: '2019-05-07T10:48:01.5997530+00:00' file_name: vernon-original.jpg file_size: 123216 comments: '' url: https://lawpanelstoragelive.blob.core.windows.net/public-assets/7c699279-efcd-4653-9c17-36c160b675f8.jpg user: id: 77e2dd06-154c-4157-ad69-a6720147e652 first_name: UserA last_name: UserA user_name: user@lawpanel.com email: user@lawpanel.com phone_number: +54 9387543988 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: en country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: AR '/fileattachment/{id}': delete: tags: - Case Attachment summary: Delete Case Attachment description: Delete a case attachment. operationId: 59bad768f8c9eb0e90ebbb52 parameters: - name: id in: path description: The case attachment ID required: true schema: type: string responses: '200': description: Return details about the delete operation. content: application/json: schema: $ref: '#/components/schemas/DeleteCaseAttachment' example: id: 24ab8b69-65d5-43b2-a99d-abac014452cf message: File attachment 'image1.jpg'successfully deleted successful: true get: tags: - Case Attachment summary: Read Case Attachment description: Return Case attachment available. operationId: 5eaa1793dc2cee76d6017952 parameters: - name: id in: path description: The case attachment ID. required: true schema: type: string responses: '200': description: Return the case attachment to operate. content: application/json: schema: $ref: '#/components/schemas/ReadCaseAttachment' example: enable: true id: 8940e34a-74ef-41c7-a9f5-ac31013c064c file: id: daaa210f-4925-4037-8e7a-ab7400033d9f name: 20636 - Test number: '20636' date_time: '2020-09-09T19:10:36.6222010+00:00' file_name: image1.jpg file_size: 1253 comments: ... url: https://lawpanelstoragelive.blob.core.windows.net/public-assets/8a758e34-6df3-47df-8dda-d3717cbc7aa4.jpg /firmproduct: post: tags: - Fee Item summary: 'Fee Item - 01.Create[S]' description: Create a new fee item. operationId: 59baf0a0f8c9eb0e90ebbb57 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "Payload must contain information about the fee item to be created.\n" content: application/json: schema: $ref: '#/components/schemas/CreateFeeitem' example: product_name: Product currency_id: 54cb5c6a-a8e0-4dec-afcc-a6e90008d6ae product_code: '0001' product_name_public: Product value: 150 taxes: - id: 4005e80b-fc55-44c0-ace8-903e53522e3e responses: '201': description: This code is returned when the fee item was created successfully. content: application/json: example: enable: true id: 68525143-03ad-4b56-b943-aba7013804e9 firm_id: 5a7776dc-6d34-4f4a-8cac-a67201481ca0 product: enable: true id: 786aefe4-fd18-47fc-abf1-aba7013804e6 code: xx name: test name_public: test product_type: enable: true id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - enable: true id: 1f11c0c4-b253-468a-9068-aba7013804de date_time: '2020-04-24T18:56:01.5888802+00:00' currency: enable: true id: 54cb5c6a-a8e0-4dec-afcc-a6e90008d6ae name: American dollar name_short: USD symbol: $ currency_units: 150 product_modifiers: [ ] taxes: - enable: true id: 4005e80b-fc55-44c0-ace8-903e53522e3e name: US VAT description: '' units: 0 percent: 0 get: tags: - Fee Item summary: 'Fee Item - 02.Read many[S]' description: Return all fee items available to use with an Invoice. operationId: 59baf0a4901adc16e035bf45 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: Return all products enabled to operate with payments and invoices. content: application/json: example: - enable: true id: 8632a401-b6c6-4334-95a7-a7430126fc8d code: CN013 name: All filing & registration fees - 5 Classes - China name_public: All filing & registration fees - 5 Classes - China currency_symbol: £ value: 3000 tax_percent: 20 tax_value: 600 - enable: true id: fa793481-6bd8-4f78-8214-a7430126c28e code: CN012 name: All filing & registration fees - 4 Classes - China name_public: All filing & registration fees - 4 Classes - China currency_symbol: £ value: 2400 tax_percent: 20 tax_value: 480 - enable: true id: a247c243-7e09-4597-8fd5-a74301267825 code: CN011 name: All filing & registration fees - 3 Classes - China name_public: All filing & registration fees - 3 Classes - China currency_symbol: £ value: 1800 tax_percent: 0 tax_value: 0 - enable: true id: 6b9b4cd9-4c50-4cce-ae06-a740010dc39f code: CN010 name: 'All filing & registration fees - 2 Classes - China ' name_public: 'All filing & registration fees - 2 Class - China ' currency_symbol: £ value: 1200 tax_percent: 20 tax_value: 240 - enable: true id: 9d34422d-7aa5-41c6-ba9d-a74000f6b133 code: CN009 name: All filing & registration fees - 1 Class - China name_public: Registration fees (all) - 1 class - China currency_symbol: £ value: 600 tax_percent: 20 tax_value: 120 '204': description: '' content: application/json: { } put: tags: - Fee Item summary: 'Fee Item - 04.Update[S]' description: Update an existing fee item. operationId: 59baf0a7f8c9eb0e90ebbb58 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "Payload must contain information about the fee item to be updated.\n" content: application/json: schema: $ref: '#/components/schemas/UpdateFeeItem' example: id: 69fdfe98-b0bc-447d-b760-aba8002d58f8 country_id: 3fa874af-5237-477d-badb-a67300008be3 email: bro@ther.com user_name: bro@ther.com first_name: Bro last_name: Ther language_id: 8246c1d0-b478-4320-8b1d-a6720147de22 password: '}D`WZN''OxlC307<[' phone_number: '+543875333953' user_type_id: '' claims_id: - 7c4fcc3e-1370-4efe-a2f5-a873002668dd responses: '200': description: Return details about the delete operation. content: application/json: example: id: 68525143-03ad-4b56-b943-aba7013804e9 message: Firm product successfully updated successful: true '/firmproduct/{id}': delete: tags: - Fee Item summary: 'Fee Item - 05.Delete[S]' description: Delete a fee item. operationId: 59baf0a9901adc16e035bf46 parameters: - name: id in: path description: The fee item ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: Return details about the delete operation. content: application/json: example: id: 45548143-03ad-4b56-b943-aba7013804e9 message: Firm product successfully deleted successful: true get: tags: - Fee Item summary: 'Fee Item - 03.Read[S]' description: Return product available. operationId: 5ea277b8b1feb907674fefab parameters: - name: id in: path description: The product ID. required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: Return the product enabled to operate with payments and invoices. content: application/json: example: enable: true id: 3bfb0737-c7ed-4c97-b418-ab1800d95f1e firm_id: 8a5536dc-6d34-4f4a-8cac-a67201481ca0 product: enable: true id: 3bfb0737-c7ed-4c97-b418-ab1800d95f1e code: asd name: OurFee name_public: Our fee NOIP product_type: enable: true id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - enable: true id: 8e51e221-abb0-4457-ba77-ab1800d95f1e date_time: '2019-12-03T13:11:25.5360819+00:00' currency: enable: true id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 300 product_modifiers: [ ] taxes: [ ] '204': description: '' content: application/json: { } /languages: get: tags: - Language summary: Read many Language description: Returns a list of languages available on the system. operationId: 59baf30bf8c9eb0e90ebbb59 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: "Returns a list with all languages available on the system for your query.\n\n" content: application/json: schema: $ref: '#/components/schemas/LanguageList' example: - id: 09ae78dd-8be8-44c5-8f0e-a99201169289 name: Montenegrin short_name: '' is_available_for_ui: false - id: ed79ab91-d7a7-4729-90d0-a9920116928e name: Coptic short_name: '' is_available_for_ui: false - id: 71e097b7-d334-40e8-a7e7-a99201169293 name: Cornish short_name: kw is_available_for_ui: false - id: 4c83c21c-1533-4932-89d6-a99201169298 name: Corsican short_name: co is_available_for_ui: false - id: 3349c2d9-94fb-4775-976b-a9920116929e name: Cree short_name: cr is_available_for_ui: false - id: 3cb7b230-29b8-47ca-a69d-a992011692a3 name: Crimean Tatar; Crimean Turkish short_name: '' is_available_for_ui: false - id: b701f4da-05be-4319-884e-a992011692a8 name: Creoles and pidgins short_name: '' is_available_for_ui: false - id: 63d05333-66f5-437e-8463-a992011692ad name: Kashubian short_name: '' is_available_for_ui: false - id: 830deff3-142b-4df7-bc5f-a992011692b2 name: Cushitic languages short_name: '' is_available_for_ui: false - id: 0590e9a4-b268-4465-afbe-a992011692b7 name: Czech short_name: cs is_available_for_ui: false /tax: get: tags: - Tax summary: Read many Tax description: Get a list of taxes available to work with. operationId: 59baf52df8c9eb0e90ebbb5b parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer responses: '200': description: Returns all taxes enabled to operate. content: application/json: schema: $ref: '#/components/schemas/TaxList' example: - id: 4455e80b-fc55-44c0-ace8-903e53522e3e name: US VAT description: '' units: 0 percent: 0 - id: 4f5745b3-831a-4244-8df8-a9340122807e name: AU GST description: The goods and services tax (GST) in Australia is a value added tax of 10% on most goods and services..... units: 0 percent: 10 - id: 8e223d0d-aa3f-4439-85fb-a6e90008ee65 name: UK VAT description: Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by....... units: 0 percent: 20 /searchorigins: get: tags: - Search Origin summary: 'Search Origin - 02.Read many[S]' description: Return a list with all possible search origins to create a trademark search. operationId: 59baf7bff8c9eb0e90ebbb5c parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 responses: '200': description: "Return a list with all search origin available to use.\n\n" content: application/json: schema: $ref: '#/components/schemas/SearchOriginList' example: - id: bd57d0f2-0ac2-4c7d-a980-a89500075e3b code: 6 name: Bot description: Represent searchs from one of our IA bot engines. - id: 5b45f41e-9f0d-4d91-b761-a673000392ef code: 5 name: Dashboard description: Represent searchs from our dashboard website. - id: 9c00ba17-ac4f-4de2-9e04-a67300039292 code: 4 name: Web site search description: Represent searchs from web sites. - id: f5d7d692-dab3-4744-9e0b-a67300039236 code: 3 name: iOS app search description: Represent searches from iOS apps. - id: 7c723daa-9d75-433d-848d-a673000391da code: 2 name: Android app search description: Represent searches from Android apps. - id: 49a7eeba-be07-47d5-bad0-a6730003917a code: 1 name: Firm Search Widget description: Represent searches from firm's search widget. - id: ec413954-22a7-499e-a93a-a67300039112 code: 0 name: Unknow source description: Represent searches from non determined sources. /searchclasses: get: tags: - Search Class summary: 'Search Class - 02.Read many[S]' description: Return a list with all possible search class available to create a trademark search. operationId: 59baf965f8c9eb0e90ebbb5d parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: "Returns a list with all search classes available to create a trademark search.\n\n" content: application/json: schema: $ref: '#/components/schemas/SearchClassList' example: - id: 2e04d7b7-d681-458f-8a55-a6720147e7fc number: 1 name: Chemical products description: 'Chemicals used in industry, science and photography, as well as in agriculture, horticulture and forestry; unprocessed artificial resins [...]' - id: 5096b33b-2f52-456d-b306-a6720147e7fc number: 2 name: Paint products description: 'Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; [...]' - id: 777fe621-5eba-4985-966a-a6720147e7fc number: 3 name: Cosmetics and Cleaning Products description: 'Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; [...]' - id: 46d9c9ae-863a-421d-9c06-a6720147e7fc number: 4 name: Industrial oils description: 'Industrial oils and greases; lubricants; dust absorbing, wetting and binding compositions; fuels and illuminants; candles and wicks for lighting; [...]' - id: 3c69fc1c-f131-4372-b873-a6720147e7fc number: 5 name: Pharmaceutical and veterinary description: 'Pharmaceutical and veterinary preparations; sanitary preparations for medical purposes; dietetic substances adapted for medical use, food for babies; [...]' - id: 9128ca8c-7734-4540-bffb-a6720147e7fc number: 6 name: Metal Products description: 'Common metals and their alloys; metal building materials; transportable buildings of metal; materials of metal for railway tracks; [...]' - id: b8163017-ebe6-4317-93ec-a6720147e7fc number: 7 name: Machinery Products description: 'Machines and machine tools; motors and engines (except for land vehicles); parts of engines and motors; machine coupling and transmission components [...]' - id: 3c98e3db-b305-40d9-b417-a6720147e7fc number: 8 name: Hand Tool Products description: Hand tools and hand operated implements; cutlery; side arms; razors; electric razors and hair cutters. - id: 3d379284-9313-4f3c-b3ba-a6720147e7fc number: 9 name: 'Computer, Electrical & Scientific Products' description: 'Scientific, photographic, cinema, optical, weighing, measuring, apparatus and instruments; switching, transforming, or controlling electricity; [...]' '/file/{fileId}/addnote': put: tags: - Case summary: Update Case (add note) description: Add a new note into an existing Case. operationId: 59c910aff8c9eb0f487d50d0 parameters: - name: fileId in: path description: Case ID where the note will be added. required: true schema: type: string requestBody: description: "By example, to add a note and send a communication through email system, you could send a model similar to this:\n" content: application/json: schema: $ref: '#/components/schemas/FileAddNote' example: note:

Hello!

I am a note into the File.

send_communication: 'false' communication_channel_id: ICommunicationChannelEmail responses: '200': description: Return 200 when the note added successfully. content: application/json: example: id: 876e34f9-5d43-46e2-a997-a7ae013f011f message: Note successfully added into file 'Brexit UK filing class 6 and 10' successfull: true '400': description: 'A 400 error is returned if you have some invalid data into your payload, i.e.: biggest text fields, invalid IDs, etc.' content: application/json: example: id: '' message: 'Invalid communication channel ID: ICommunicationChannelMind' successfull: false /communicationchannel: get: tags: - Communication Channel summary: Read many Communication Channel description: Return a list of all communications channels available to send communications. operationId: 59cad4baf8c9eb1bcc0b17c1 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: 'Return an array with all communications channels available:' content: application/json: example: - id: ICommunicationChannelEmail name: Email description: 'Electronic mail (email or e-mail) is a method of exchanging messages between people using electronics. Email first entered substantial use in the 1960s and by the mid-1970s had taken the form now recognized as email. Email operates across computer networks, which today is primarily the Internet. Some early email systems required the author and the recipient to both be online at the same time, in common with instant messaging. Today''s email systems are based on a store-and-forward model. Email servers accept, forward, deliver, and store messages. Neither the users nor their computers are required to be online simultaneously; they need to connect only briefly, typically to a mail server or a webmail interface, for as long as it takes to send or receive messages.' - id: ICommunicationChannelSms name: SMS description: 'Short Message Service (SMS) is a text messaging service component of most telephone, World Wide Web, and mobile telephony systems. It uses standardized communication protocols to enable mobile phone devices to exchange short text messages. An intermediary service can facilitate a text-to-voice conversion to be sent to landlines. SMS was the most widely used data application, with an estimated 3.5 billion active users, or about 80% of all mobile phone subscribers, at the end of 2010.' - id: ICommunicationChannelWeb name: Web notification description: User is going to receive just a web notification in our portal '/trademark/details/{registry}/{applicationnumber}': get: tags: - TMD summary: 'Trademarks - 07.Get details[S]' description: "

\n\tDescription\n\t\n\t\n\t\n

\n
\n

Return the details on the IPO for the trademark selected.

\n
\n\n
\n" operationId: 5aaae06beb10040bf039c78e parameters: - name: registry in: path description: The WIPO ST.3 code for the registry. To get a list with all registries availables click here. required: true schema: type: string - name: applicationnumber in: path description: Trademark's application number. required: true schema: type: string - name: subscription-key in: query description: You Firm API Key required: true schema: type: string responses: '200': description: Returns a DTO with all trademark details. content: application/json: example: id: 31003300370035003800360030007C0045005500490050004F00 application_number: '1375860' registration_date: application_date: '2017-02-14T00:00:00.0000000+00:00' expiry_date: '2027-02-14T00:00:00.0000000+00:00' mark_feature: Figurative kind_mark: Individual mark_text: M classes: '2009-09-09' status: Live registry: EUIPO good_and_services: - class_number: 9 description: "Computer network apparatus; computer programs relating to\n computer networks; apparatus for network communications;\n network management apparatus; network management computer\n software; data communications software; application\n software; communication software." language_code: "Computer network apparatus; computer programs relating to\n computer networks; apparatus for network communications;\n network management apparatus; network management computer\n software; data communications software; application\n software; communication software." - class_number: 9 description: "Appareils de réseaux informatiques; programmes\n informatiques en rapport avec des réseaux informatiques;\n appareils pour communications en réseau; appareils de\n gestion de réseaux; logiciels de gestion de réseaux;\n logiciels de communication de données; logiciels\n d'applications; logiciels de communication." language_code: "Appareils de réseaux informatiques; programmes\n informatiques en rapport avec des réseaux informatiques;\n appareils pour communications en réseau; appareils de\n gestion de réseaux; logiciels de gestion de réseaux;\n logiciels de communication de données; logiciels\n d'applications; logiciels de communication." - class_number: 9 description: "Aparatos de redes informáticas; programas informáticos\n relacionados con redes informáticas; aparatos para\n comunicaciones en red; aparatos de gestión de redes;\n software de gestión de redes; software de comunicación de\n datos; software de aplicaciones; software de comunicación." language_code: "Aparatos de redes informáticas; programas informáticos\n relacionados con redes informáticas; aparatos para\n comunicaciones en red; aparatos de gestión de redes;\n software de gestión de redes; software de comunicación de\n datos; software de aplicaciones; software de comunicación." applicants: - id: 0 name: 'Metamako General Pty Ltd in its capacity as, general partner of Metamako LP' address: representatives: - id: 0 name: Phoenix Intellectual Property address: image_url: https://lawpanellocalstorage.blob.core.windows.net/public-assets/portfolio_trademark_3100330037003500380036003000_57004F00.jpg priorities: - priority_country_code: AU priority_number: '01789874' priority_date: '2016-08-16' '/clienttype/{id}': get: tags: - Company Type summary: Read Company Type description: 'Returns details about a particular legal entity, company or client type' operationId: 5e5fc256f0dd0f05332475b2 parameters: - name: id in: path description: 'The legal entity, company or client type ID.' required: true schema: type: string responses: '200': description: 'Returns a representation for the legal entity, company or client type.' content: application/json: example: id: 25eaad5c-2bea-44e5-89e2-a99201175b40 code: 2 name: Agent '204': description: '' content: application/json: { } /clienttype: get: tags: - Company Type summary: Read many Company Type description: 'Returns a list of legal entity, company or client types available on the system.' operationId: 5e5fc497bff59224dddd21bc parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: 'Returns a list with all legal entities, companies or client types for your query.' content: application/json: schema: $ref: '#/components/schemas/ClientTypeList' example: - id: 25eaad5c-2bea-44e5-89e2-a99201175b40 code: 2 name: Agent - id: 604a3d85-5c5b-4364-b69c-a99201175b30 code: 1 name: Common /trademarksearch: post: tags: - Trademark Search summary: 'Trademark Search - 01.Create[S]' description: Creates a new trademark search and queues it for execution. operationId: 5e62ae02f96ca1198ee0c637 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "Request payload to create the search. \n" content: application/json: schema: $ref: '#/components/schemas/CreateTrademarkSearch' example: search_term: lawpanel classes: '42,9' registry_ids: - 783c0667-2884-4d0a-b93b-a6720147e45f - bdbc9579-0462-4449-b7e8-a835017ea7c4 search_origin_id: responses: '201': description: "Search has been queued for execution. \n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearch' example: id: 4B1A76CD-CBF1-4119-BA2C-A9E701367ED0 search_term: lawpanel classes: '42,9' registry_id: start_time: '0001-01-01T00:00:00.0000000+00:00' end_time: '0001-01-01T00:00:00.0000000+00:00' status: 0 results: [ ] get: tags: - Trademark Search summary: 'Trademark Search - 03.Read many[S]' description: Get a list of trademark searches. operationId: 5e68c96c205a50fba832473f parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a simplified (without results) list of trademark searches performed.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchSimplifedList' example: - enable: true id: c7fec498-ac09-4f08-8b82-ab7a014823be search_term: LawPanel classes: registry_id: start_time: '2020-03-10T19:54:43.5163870+00:00' end_time: '2020-03-10T19:56:15.0079506+00:00' status: Completed - enable: true id: b67632a1-b5c0-41e3-ad02-ab7a01478aed search_term: LawPanel classes: registry_id: start_time: '2020-03-10T19:52:35.4637377+00:00' end_time: '2020-03-10T19:52:36.5508547+00:00' status: Completed '/trademarksearch/{id}': get: tags: - Trademark Search summary: 'Trademark Search - 02.Read[S]' description: Get trademark search details including search results. operationId: 5e668a94e827b68904a52aa8 parameters: - name: id in: path description: The trademark search ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns details about the trademark search.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearch' example: enable: false id: 2186f20b-6133-41c4-96b0-ab7a0149b905 search_term: LawPanel classes: registry_id: start_time: '2020-03-10T20:00:31.1352096+00:00' end_time: '2020-03-10T20:00:32.2542094+00:00' status: Completed results: - id: 264dbd77-e651-4844-b3bf-5f7897436420 registry_id: 528e97d0-0160-455b-80a6-a835017eb05d application_number: '823437' application_date: '2004-02-19T03:00:00.0000000+00:00' mark_string: Lawpanel classes: '42' status: Expired owner: XIAOYAN score: 0 similarity: Very high - id: 2e5d7253-73c1-4a50-84e7-7d891d633e81 registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 application_number: UK00003147277 application_date: '2016-02-01T03:00:00.0000000+00:00' mark_string: LAWPANEL classes: '42,9' status: Valid owner: Lawpanel Limited score: 0 similarity: Very high - id: 5a7d617d-dddf-4497-b79f-5f2ab7212ec8 registry_id: 783c0667-2884-4d0a-b93b-a6720147e45f application_number: '79002163' application_date: '2004-02-19T03:00:00.0000000+00:00' mark_string: LAWPANEL classes: '42' status: Invalid owner: XIAOYAN score: 0 similarity: Very high - id: 96ffcd42-3678-4040-bd3a-24871e8b1030 registry_id: 783c0667-2884-4d0a-b93b-a6720147e45f application_number: '87064395' application_date: '2016-06-08T03:00:00.0000000+00:00' mark_string: LAWPANEL classes: '42,9' status: Valid owner: MKW ASSOCIATES LIMITED score: 0 similarity: Very high - id: ee964ecf-4afb-43c5-8ed0-4d51884bc0e1 registry_id: 3c5354be-726b-48d1-9bee-aa030177fb89 application_number: '3054524' application_date: '2001-12-28T03:00:00.0000000+00:00' mark_string: LAWPANEL classes: '42' status: Invalid owner: 肖岩 score: 0 similarity: Very high delete: tags: - Trademark Search summary: 'Trademark Search - 05.Delete[S]' description: Deletes a trademark search. operationId: 5e7504d9ae3a249929a41f45 parameters: - name: id in: path description: The trademark search ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns details about the operation result.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchDeleteResult' example: id: 1cafd4e4-303f-48d4-becc-ab0a012d637a message: Trademark search for 'bollywood' successfully deleted successful: true /fileportfolio: post: tags: - Case Trademark summary: 'Case Trademark - 01.Create[S]' description: Create a new "Trademark" link into a Case operationId: 5e668da22028ae41d12154d2 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "" content: application/json: schema: $ref: '#/components/schemas/CreateFilePortfolio' example: file_id: 63573649-3ee9-4367-a176-ab0a0127509c firm_portfolio_id: 42cb80ce-a153-43f2-9d9e-ab0a01275064 file_portfolio_role_id: 72ccf3d8-cc1b-4e9b-9f7b-a992011765ee responses: '201': description: Returns data about new case trademark created. content: application/json: schema: $ref: '#/components/schemas/FilePortfolioCreated' example: id: c9404ccc-3637-45e5-a6c3-ab8b01533274 /fileclient: post: tags: - Case Part summary: Create Case Part description: Create a new "Part" linked with a Case. operationId: 562d8bc4b6dd4e81a1f79b57 requestBody: description: "" content: application/json: schema: $ref: '#/components/schemas/CreateFileClient' example: file_id: ad72f2c7-3866-486f-8e98-aa0300c8b9ea client_id: e7e32f0a-9d93-406a-b231-a98f00eabf67 file_client_role_id: 1a0bbe33-d3ce-451b-bc6b-a8ff015d9a7d client_user_id: d48e832b-dc27-4818-9057-a92200be1e31 reference: '' responses: '201': description: Returns data about new case legal entity created content: application/json: schema: $ref: '#/components/schemas/FileClientCreated' example: id: a5ac9bce-338b-4232-b3c3-ab8a00e9f04d '/trademarksearch/{id}/status': get: tags: - Trademark Search summary: 'Trademark Search - 04.Get status[S]' description: Get trademark search status. You can use this method to avoid receiving the whole trademark search data. operationId: 5e68d2775766cadea2f9e89a parameters: - name: id in: path description: The trademark search ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns an entity with an integer and a text with current search status.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchStatus' example: status: 3 status_text: Completed '/registries/{id}': get: tags: - Registry summary: 'Registry - 01.Read[S]' description: Get a registry by its ID value. operationId: 5e68fb835a292eb6af23f674 parameters: - name: id in: path description: Registry ID required: true schema: type: string responses: '200': description: "Returns a registry representation.\n\n" content: application/json: schema: $ref: '#/components/schemas/Registry' example: id: b93d01dc-3fb7-4c63-b565-a7a700aacdff wipo_code: AD description: ANDORRA have_data: true url_base_for_trademarks: '' iso_three_letters_country_code: AND total_trademarks: 37080 /registrationtype: get: tags: - Registration Type summary: 'Registration Type - 02.Read many[S]' description: 'Registration Type - 02.Read many[S]' operationId: 5e7398b44688a6e1e26aa7ca parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all registration types available.\n\n" content: application/json: schema: $ref: '#/components/schemas/RegistrationTypeList' example: - id: 96dc1202-d0c4-43a5-ab22-a99201173fb0 name: Supplemental code: 20 - id: 35002c9c-9d10-4ce4-bad0-a99201173fa5 name: State code: 19 - id: ac1269aa-f659-4420-9404-a99201173f99 name: Slogan code: 18 - id: 9de08b0a-6266-45ea-81b0-a99201173f8d name: Part B code: 17 - id: 59ecaed9-0d1a-4c07-981f-a99201173f81 name: Part A code: 16 - id: cbf73e22-4324-4b3f-a2f6-a99201173f76 name: OAPI Trademark code: 15 - id: 5084e76c-5a49-4a4f-8bec-a99201173f6c name: OAPI National Reference code: 14 - id: 510fe5f6-2c68-410f-9931-a99201173f61 name: Local code: 13 - id: a3e9c0a9-1638-4af6-b15b-a99201173f56 name: IR Subsequent Designation code: 12 - id: cdfada91-8db7-4654-91aa-a99201173f4a name: IR National Extension code: 11 '/registrationtype/{id}': get: tags: - Registration Type summary: 'Registration Type - 01.Read[S]' description: Get a registration type by its ID value. operationId: 5e73b2129d3f628d492af8c8 parameters: - name: id in: path description: Registration type ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a registration type representation.\n\n\n" content: application/json: schema: $ref: '#/components/schemas/RegistrationType' example: id: 96dc1202-d0c4-43a5-ab22-a99201173fb0 name: Supplemental code: 20 '/trademarktype/{id}': get: tags: - Trademark Type summary: 'Trademark Type - 01.Read[S]' description: Get a trademark type by its ID value. operationId: 5e73b50806600a376292f6b3 parameters: - name: id in: path description: Trademark type ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a trademark type representation.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkType' example: id: 6d374194-9df4-4a26-89dd-a992011744fd name: Word/Device code: 11 /trademarktype: get: tags: - Trademark Type summary: 'Trademark Type - 02.Read many[S]' description: Returns a list with all trademark types available on the system. operationId: 5e73b75f0faeb654084de5ec parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all trademark types available.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkTypeList' example: - id: 6d374194-9df4-4a26-89dd-a992011744fd name: Word/Device code: 11 - id: 86c2145f-3051-419e-a072-a992011744f2 name: Word in Standard Characters code: 10 - id: 545b78f1-8d94-4fa4-b86a-a992011744e8 name: Typed Drawing code: 9 - id: 785826fe-4cb6-46dd-ad47-a992011744dd name: Three Dimensional code: 8 - id: 83165497-eb28-4ae7-9407-a992011744d2 name: Stylized Word code: 7 - id: edb846f5-467e-4ff4-876e-a992011744c7 name: Sound code: 6 - id: 196eba02-1533-459f-8580-a992011744bc name: Smell code: 5 - id: 171546bf-599c-42fc-909b-a992011744b2 name: Signature code: 4 - id: 8837027a-b4b3-4fa4-84f6-a992011744a7 name: Service Mark code: 3 - id: 82efe10a-b712-4c9d-8ad9-a9b6000ff8e3 name: Series code: 12 '/searchorigins/{id}': get: tags: - Search Origin summary: 'Search Origin - 01.Read[S]' description: Get a search origin by its ID value. operationId: 5e74e42504e37e6f7696b00d parameters: - name: id in: path description: Search origin ID required: true schema: type: string responses: '200': description: "Returns a search origin representation.\n\n" content: application/json: schema: $ref: '#/components/schemas/SearchOrigin' example: id: bd57d0f2-0ac2-4c7d-a980-a89500075e3b code: 6 name: Bot description: Represent searchs from one of our IA bot engines. '/firmportfolio/{id}': get: tags: - Trademark summary: 'Trademark - 02.Read[S]' description: Get trademark details. operationId: 5e750b35c8e8c601054d8b2f parameters: - name: id in: path description: The trademark ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns details about the trademark.\n\n" content: application/json: schema: $ref: '#/components/schemas/Trademark' example: id: 677eeb82-99f7-4c68-a797-ab8400f6f701 registry_id: 783c0667-2884-4d0a-b93b-a6720147e45f registry_name: USPTO registry_official_name: USPTO registry_description: United States mark_text: LawPanel application_number: '87064395' application_date: '2020-03-17T03:00:00.0000000+00:00' registration_number: '5230966' registration_date: '2020-03-17T03:00:00.0000000+00:00' status_date: '2020-03-17T03:00:00.0000000+00:00' mark_feature: mark status: Valid registration_type_id: 21b28699-8e12-4575-bb65-a99201173ed2 registration_type_name: Associated Mark trademark_type_id: 6d374194-9df4-4a26-89dd-a992011744fd trademark_type_name: Word/Device expiry_date: '2020-03-17T03:00:00.0000000+00:00' publication_date: '2020-03-17T03:00:00.0000000+00:00' declaration_date: '2020-03-17T03:00:00.0000000+00:00' office_action_date: '2020-03-17T03:00:00.0000000+00:00' grant_date: '2020-03-17T03:00:00.0000000+00:00' client_agent_id: a1c3e613-c9a5-49c5-91d9-aaaf009c09f1 client_agent_name: Stronghold Invest AB publication_notes: Notes about publication good_and_services: - id: be4a9eb5-e20c-4f89-9809-ab8400f6f701 language: id: 8246c1d0-b008-4320-8b1d-a6720147de22 name: English short_name: en is_available_for_ui: true search_class: id: 5096b33b-2f52-456d-b306-a6720147e7fc number: 2 name: Paint products description: 'Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; metals in foil and powder form for painters, decorators, printers and artists.' search_classes: '2' text: 'Facilitating, administering, arranging and managing funding in relation to litigation [...]' - id: ae0a84f0-ebd5-4071-bd9e-ab8400f6f701 language: id: 8246c1d0-b008-4320-8b1d-a6720147de22 name: English short_name: en is_available_for_ui: true search_class: id: 777fe621-5eba-4985-966a-a6720147e7fc number: 3 name: Cosmetics and Cleaning Products description: 'Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; perfumery, essential oils, cosmetics, hair lotions; dentifrices; deodorants for personal use; air perfuming preparations.' search_classes: '3,5,21,35' text: 'Design and development of computer hardware and software; software as a service [SaaS]; [...]' image_url: https://web.lawpanel.com/images/firm/logo-lawpanel-white.png notes:

Some extra notes

do_not_create_file: false user_id: 77e2dd06-154c-4157-ad69-a6720147e652 user_user_name: johndoe@ipfirm.com trademark_url_on_ipo: exclude_from_auto_updates: false delete: tags: - Trademark summary: 'Trademark - 05.Delete[S]' description: Deletes a trademark. operationId: 5e77ebdc61bec781965f260a parameters: - name: id in: path description: The trademark ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns details about the operation result.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchDeleteResult' example: id: 1cafd4e4-303f-48d4-becc-ab0a012d637a message: Trademark successfully deleted successful: true /trademark: put: tags: - Trademark summary: 'Trademark - 04.Update[S]' description: Updates an existing trademark. operationId: 5e77b72077b3c80957764a13 requestBody: description: "Request payload to update the trademark.\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkUpdate' example: id: 677eeb82-99f7-4c68-a797-ab8400f6f701 registry_id: 783c0667-2884-4d0a-b93b-a6720147e45f mark_text: LawPanel application_number: '0303456' application_date: '2020-03-17T00:00:00.0000000+00:00' registration_number: 5230966 registration_date: '2020-03-17T00:00:00.0000000+00:00' status_date: '2020-03-17T00:00:00.0000000+00:00' mark_feature: mark status: Valid registration_type_id: 21b28699-8e12-4575-bb65-a99201173ed2 trademark_type_id: 6d374194-9df4-4a26-89dd-a992011744fd expiry_date: '2020-03-17T00:00:00.0000000+00:00' publication_date: '2020-03-17T00:00:00.0000000+00:00' declaration_date: '2020-03-17T00:00:00.0000000+00:00' office_action_date: '2020-03-17T00:00:00.0000000+00:00' final_office_action_date: '' grant_date: '2020-03-17T00:00:00.0000000+00:00' client_agent_id: a1c3e613-c9a5-49c5-91d9-aaaf009c09f1 publication_notes: Notes about publication good_and_services: - id: be4a9eb5-e20c-4f89-9809-ab8400f6f701 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 search_class_id: 5096b33b-2f52-456d-b306-a6720147e7fc text: 'Facilitating, administering, arranging and managing funding in relation to litigation [...]' - id: ae0a84f0-ebd5-4071-bd9e-ab8400f6f701 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 search_class_id: 777fe621-5eba-4985-966a-a6720147e7fc text: 'Design and development of computer hardware and software; software as a service [SaaS]; [...]' image_url: https://web.lawpanel.com/images/firm/logo-lawpanel-white.png notes:

Some extra notes

responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/TrademarkUpdateResult' example: id: f3e5257b-ebea-43b6-aa60-ab0a012807db message: Firm portfolio for trademark 'PASTA BASTA' successfully updated successful: true /firmportfolio/filters: get: tags: - Trademark summary: 'Trademark - 06.Filters[S]' description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e789f0e5e099ce66d77768c parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkFilter' example: - property_name: client_agent property_type: Client property_display_name: Agent property_description: '' comparators_available: - == - '!=' multiple: false end_point: client - property_name: application_date property_type: DateTime property_display_name: Application date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: application_number property_type: String property_display_name: Application number property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: declaration_date property_type: DateTime property_display_name: Declaration date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: final_office_action_date property_type: DateTime property_display_name: Final office action date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: classes property_type: SearchClass property_display_name: Good and services property_description: '' comparators_available: - == - '!=' multiple: true end_point: searchclasses - property_name: grant_date property_type: DateTime property_display_name: Grant date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: has_reminders property_type: Boolean property_display_name: Has reminders property_description: '' comparators_available: - == - '!=' multiple: false end_point: '' - property_name: mark_feature property_type: String property_display_name: Mark feature property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: mark_text property_type: String property_display_name: Mark text property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: notes property_type: String property_display_name: Notes property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: office_action_date property_type: DateTime property_display_name: Office action date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: publication_date property_type: DateTime property_display_name: Publication date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: publication_notes property_type: String property_display_name: Publication notes property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: registration_date property_type: DateTime property_display_name: Registration date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: registration_number property_type: String property_display_name: Registration number property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: registry property_type: Registry property_display_name: Registry / IPO property_description: '' comparators_available: - == - '!=' multiple: false end_point: registries - property_name: status property_type: String property_display_name: Registry status property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: expiry_date property_type: DateTime property_display_name: Renewal date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: status_date property_type: DateTime property_display_name: Status date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' /trademarksearch/filters: get: tags: - Trademark Search summary: 'Trademark Search - 06.Filters[S]' description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e78b27f82bc4aad3642c623 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchFilter' example: - property_name: registry property_type: Registry property_display_name: Registry property_description: '' comparators_available: - == - '!=' multiple: false end_point: registries - property_name: start_time property_type: DateTime property_display_name: Search date property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: search_term property_type: String property_display_name: Search terms property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' /filter: post: tags: - Filter summary: Create Filter description: "

Creates a new filter for a specific endpoint.

\n

You can use filters to apply them on endpoints in order to get sub-sets of entities.

\n

For example, if you want to get trademarks containing the word law and the registry US you have to create a filter for the endpoint firmportfolio and then apply it.

\n

Payload to create a filter for the example above would be very similar to:

\n
\n\n

So, basically, you have to define groups of expressions for each condition on each property: one group for each property, and one, or more, expressions for each condition.

\n

Another example: if you want to include a new registry, for example GB, you should add a new expression into the first group:

\n
\n\n\n

Note that operator_next contains the nexus with next expression. On this sample an OR ( because we want trademarks from both: US or GB ).

\n\n

The example above is similar to create this filter on the web UI.

\n\n

Properties available to create filters depend on each endpoint. Check method Filters on each endpoint to get a list of all properties available. " operationId: 5e78b798bbd38a43886ac8ec requestBody: description: "Request payload to create the filter.\n

" content: application/json: schema: $ref: '#/components/schemas/CreateFilter' example: name: end_point: firmportfolio it_is_last_used_without_save: true applied: false filter_definition: groups: - expressions: - property_name: mark_text comparator: CONTAINS value: lawpanel operator_next: AND operator_next: AND responses: '201': description: Returns a representation of filter created. Use returned id as filter_id parameter on READ many endpoint. content: application/json: schema: $ref: '#/components/schemas/Filter' example: id: 66c4ef28-2429-46f3-b815-ab870165e520 end_point: firmportfolio name: '''law'' in US' applied: false filter_definition: groups: - expressions: - property_name: registry.id comparator: == value: 783c0667-2884-4d0a-b93b-a6720147e45f operator_next: OR operator_next: AND - expressions: - property_name: mark_text comparator: CONTAINS value: law operator_next: AND operator_next: AND get: tags: - Filter summary: 'Filter - 03.Read many[S]' description: Get a list with filters for your query. operationId: 5e7930bbe0edaba4c6258832 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list of Filter representations.\n" content: application/json: schema: $ref: '#/components/schemas/ListOfFilter' example: - id: 66c4ef28-2429-46f3-b815-ab870165e520 end_point: firmportfolio name: '''law'' in US' applied: false filter_definition: groups: - expressions: - property_name: registry.id comparator: == value: 783c0667-2884-4d0a-b93b-a6720147e45f operator_next: OR operator_next: AND - expressions: - property_name: mark_text comparator: CONTAINS value: law operator_next: AND operator_next: AND put: tags: - Filter summary: 'Filter - 04.Update[S]' description: Updates an existing filter. operationId: 5e79319555cbdd69fef4b431 requestBody: description: "Request payload to update the filter.\n\n" content: application/json: schema: $ref: '#/components/schemas/FilterUpdate' example: id: 66c4ef28-2429-46f3-b815-ab870165e520 name: '''law'' in US' end_point: firmportfolio applied: true filter_definition: groups: - expressions: - property_name: registry.id comparator: == value: 783c0667-2884-4d0a-b93b-a6720147e45f operator_next: OR operator_next: AND - expressions: - property_name: mark_text comparator: CONTAINS value: lawpanel operator_next: AND operator_next: AND responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FilterUpdateResult' example: id: 4dc0aa72-fca6-482b-a144-ab05010550ea message: Filter 'Europe trademarks' successfully updated successful: true '/filter/{id}': get: tags: - Filter summary: 'Filter - 02.Read[S]' description: Get filter details. operationId: 5e79210c4872b75414ba4aae parameters: - name: id in: path description: The filter ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "" content: application/json: schema: $ref: '#/components/schemas/Filter' example: id: 66c4ef28-2429-46f3-b815-ab870165e520 end_point: firmportfolio name: '''law'' in US' applied: false filter_definition: groups: - expressions: - property_name: registry.id comparator: == value: 783c0667-2884-4d0a-b93b-a6720147e45f operator_next: OR operator_next: AND - expressions: - property_name: mark_text comparator: CONTAINS value: law operator_next: AND operator_next: AND delete: tags: - Filter summary: 'Filter - 05.Delete[S]' description: Deletes a filter. operationId: 5e7934034589180fec870781 parameters: - name: id in: path description: The filter ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns details about the operation result.\n\n" content: application/json: schema: $ref: '#/components/schemas/FilterDeleteResult' example: id: 1cafd4e4-303f-48d4-becc-ab0a012d637a message: Filter successfully deleted successful: true /filter/filters: get: tags: - Filter summary: 'Filter - 06.Filters[S]' description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e7937d85878a6e2da157840 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchFilter' example: - property_name: applied property_type: Boolean property_display_name: Applied property_description: Is this filter currently applied on the endpoint? comparators_available: - == - '!=' multiple: false end_point: '' - property_name: end_point property_type: String property_display_name: Endpoint property_description: Where this filter could be applied? comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: name property_type: String property_display_name: Name property_description: Human readable filter name comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' /languages/filters: get: tags: - Language summary: Filter Language description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e793e9062b6fbd50a5064ff responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/LanguageFilter' example: - property_name: is_available_for_ui property_type: Boolean property_display_name: Is available for the web UI? property_description: Is this language available on our web user interface? comparators_available: - == - '!=' multiple: false end_point: '' - property_name: name property_type: String property_display_name: Name property_description: Language name comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: short_name property_type: String property_display_name: Short Name property_description: Abbreviation for the language comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' '/languages/{id}': get: tags: - Language summary: Read Language description: Get language details. operationId: 5e793f62cffd3c88b7866c3f parameters: - name: id in: path description: The language ID. required: true schema: type: string responses: '200': description: "" content: application/json: schema: $ref: '#/components/schemas/Language' example: id: 09ae78dd-8be8-44c5-8f0e-a99201169289 name: Montenegrin short_name: '' is_available_for_ui: false /client/filters: get: tags: - Company summary: 'Company - 03.Filters[S]' description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e7941b455a31221641b4921 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchFilter' example: - property_name: contact_email property_type: String property_display_name: Contact email property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: contact_name property_type: String property_display_name: Contact name property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: contact_number property_type: String property_display_name: Contact number property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: name property_type: String property_display_name: Name property_description: Company name comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: client_type property_type: ClientType property_display_name: Type property_description: Company type comparators_available: - == - '!=' multiple: false end_point: clienttype - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' /registries/filters: get: tags: - Registry summary: 'Registry - 03.Filters[S]' description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e79482b1255cb52fd1f569e parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchFilter' example: - property_name: description property_type: String property_display_name: Description property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: name property_type: String property_display_name: Name property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: wipo_code property_type: String property_display_name: WIPO code property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' '/searchclasses/{id}': get: tags: - Search Class summary: 'Search Class - 01.Read[S]' description: Return a class available to create a trademark search. operationId: 5e794a135cb5366b3a6bd046 parameters: - name: id in: path description: The Search Class ID required: true schema: type: string responses: '200': description: "Returns a search class representation.\n\n" content: application/json: schema: $ref: '#/components/schemas/SearchClass' example: id: 2e04d7b7-d681-458f-8a55-a6720147e7fc number: 1 name: Chemical products description: 'Chemicals used in industry, science and photography, [...]' /searchclasses/filters: get: tags: - Search Class summary: 'Search Class - 06.Filters[S]' description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e794cbdc82ce7eea6391c95 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/TrademarkSearchFilter' example: - property_name: description property_type: String property_display_name: Description property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: name property_type: String property_display_name: Name property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: number property_type: Int32 property_display_name: Number property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= multiple: false end_point: '' - property_name: search_classes property_type: String property_display_name: Other search class numbers related property_description: '' comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' /users: get: tags: - User summary: Read many User description: Get a list of your users. operationId: 5e7a1494cd00b195a1f0f8e4 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: "Returns a simplified list of users for your query.\n\n" content: application/json: schema: $ref: '#/components/schemas/ListOfUsers' example: - id: 03ce7827-aac0-477d-a01b-aad8012abc99 first_name: Ricardo Sebastian last_name: Guerrero user_name: sebastian@lawpanel.com email: sebastian@lawpanel.com phone_number: '+543875333953' language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: English country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: Argentina user_role: 0 last_login_date: '2020-01-22T12:26:00.9180468+00:00' is_locked_out: false user_type_id: 98668B91-296D-4F41-BEE8-A99201177CF0 user_type_name: Attorney post: tags: - User summary: Create User description: Creates a new "Firm User". operationId: 5ea37790e4463fb5a6db2e8e parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "Payload must contain information about the user to be created.\n" content: application/json: schema: $ref: '#/components/schemas/CreateUser' example: country_id: 3fa600af-5237-477d-badb-a67300008be3 email: albert@genius.com user_name: albert@genius.com first_name: Albert last_name: Einstein language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 password: 'GUj/j8<#0Gxa,ut>' phone_number: '+543875123953' reset_password: 'False' two_factor_authenticator: 'False' user_type_id: '' claims: [ ] responses: '201': description: This code is returned when the user was created successfully. content: application/json: example: enable: true id: sa548916-e2fa-4ce8-ba49-aba70183c408 first_name: Albert last_name: Einstein user_name: albert@genius.com email: albert@genius.com phone_number: '0' language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: English country_id: 3fa600af-5237-477d-badb-a67300008be3 country_name: Germany user_role: FirmUser last_login_date: is_yoti: false is_locked_out: false yoti_id: user_settings: claims: [ ] user_type_id: user_type_name: put: tags: - User summary: Update User description: Updates an existing user. operationId: 5ea732528e90f516ef403f94 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "Payload must contain information about the User to be updated.\n\n" content: application/json: schema: $ref: '#/components/schemas/UpdateUser' example: id: 52d3a0c6-8157-4b0b-b485-ac5a00bef873 first_name: Sebastian last_name: Guerrero user_name: client_email@domain.com email: client_email@domain.com password: '1234567' phone_number: 387-155 333 953 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 responses: '200': description: Return details about the delete operation. content: application/json: example: id: 69fdf398-b0bc-447d-b760-aba8002d58f8 message: User 'bro@ther.com' successfully updated successful: true '/users/{id}': get: tags: - User summary: Read User description: Get details about a specific User. operationId: 5e7a1d19d2f9702b2c0c17ba parameters: - name: id in: path description: The user ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns details about the user.\n\n" content: application/json: schema: $ref: '#/components/schemas/User' example: id: 03ce7827-aac0-477d-a01b-aad8012abc99 first_name: Ricardo Sebastian last_name: Guerrero user_name: chapeti+alsina003@gmail.com email: chapeti+alsina003@gmail.com phone_number: '+543875333953' language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 language_name: English country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 country_name: Argentina user_role: FirmUser last_login_date: '2020-01-22T12:26:00.9180468+00:00' is_locked_out: false user_type_id: 98668b91-296d-4f41-bee8-a99201177cf0 user_type_name: Attorney delete: tags: - User summary: Delete User description: Deletes an user. operationId: 5ea72949310e140ff8333f15 parameters: - name: id in: path description: The user ID required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: Return details about the delete operation. content: application/json: example: id: 131a8211-c74f-43d0-b8c8-abaa013621de message: User 'blanquito@ups.com' deleted successful: true '/countries/{id}': get: tags: - Country summary: Read Country description: Returns details about a particular country operationId: 5e7a1d9fff6bc84307df35ec parameters: - name: id in: path description: The country ID. required: true schema: type: string responses: '200': description: Returns details about the country. content: application/json: example: id: ec025ddd-a939-4669-83c1-a67300008be3 name: Switzerland short_name: CH weight_order: 0 '204': description: '' content: application/json: { } '/usertype/{id}': get: tags: - User Type summary: Read User Type description: Get a user type by its ID value. operationId: 5e7a265e9634c38fcbf7d361 parameters: - name: id in: path description: User type ID required: true schema: type: string responses: '200': description: "Returns a user type representation.\n\n" content: application/json: schema: $ref: '#/components/schemas/UserType' example: id: 98668b91-296d-4f41-bee8-a99201177cf0 name: Attorney code: 1 /frequencies: get: tags: - Frequency summary: 'Frequency - 02.Read many[S]' description: Returns a list with all frequencies available on the system. operationId: 5e7a47db756d854b11a904d2 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 responses: '200': description: "Returns a list with all trademark types available.\n\n" content: application/json: schema: $ref: '#/components/schemas/FrequencyList' example: - id: 085309f3-91b4-4f2e-a156-a99201164a3d name: Yearly unit_name: Year years: 1 months: 0 days: 0 hours: 0 minutes: 0 seconds: 0 total_in_seconds: 31557600 - id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 name: Weekly unit_name: Week years: 0 months: 0 days: 7 hours: 0 minutes: 0 seconds: 0 total_in_seconds: 604800 - id: 35a83aa2-e5fb-4bd7-9f02-a6720147e2d2 name: Monthly unit_name: Month years: 0 months: 1 days: 0 hours: 0 minutes: 0 seconds: 0 total_in_seconds: 2592000 - id: 008d4dea-642c-483a-8c57-a6720147e2d2 name: Bi-Weekly unit_name: 2 weeks years: 0 months: 0 days: 14 hours: 0 minutes: 0 seconds: 0 total_in_seconds: 1209600 - id: af3c4667-0857-42b9-83ed-a6720147e2d2 name: Daily unit_name: Day years: 0 months: 0 days: 1 hours: 0 minutes: 0 seconds: 0 total_in_seconds: 86400 '/frequencies/{id}': get: tags: - Frequency summary: 'Frequency - 01.Read[S]' description: Returns details of a frequency. operationId: 5e7a4de65645d95e5baa713d parameters: - name: id in: path description: The frequency ID. required: true schema: type: string responses: '200': description: "Returns a frequency representation.\n\n" content: application/json: schema: $ref: '#/components/schemas/Frequency' example: id: 085309f3-91b4-4f2e-a156-a99201164a3d name: Yearly unit_name: Year years: 1 months: 0 days: 0 hours: 0 minutes: 0 seconds: 0 total_in_seconds: 31557600 /watching/filters: get: tags: - Watching summary: 'Watching - 06.Filters[S]' description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e7b876549526ddb7715f3fa parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/WatchingFilter' example: - property_name: frequency property_type: Frequency property_display_name: Alert frequency property_description: '' comparators_available: - == - '!=' multiple: false end_point: frequencies - property_name: last_notification_date_time property_type: DateTime property_display_name: Last notification date time property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: last_search_date_time property_type: DateTime property_display_name: Last search date time property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' - property_name: interesting_watching_history_records property_type: Int32 property_display_name: Number of not handled events property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= multiple: false end_point: '' - property_name: sensitivity property_type: Int32 property_display_name: Range property_description: '' comparators_available: - == - '!=' - '>' - '>=' - < - <= multiple: false end_point: '' - property_name: user property_type: User property_display_name: Responsible property_description: '' comparators_available: - == - '!=' multiple: false end_point: users - property_name: firm_portfolio property_type: FirmPortfolio property_display_name: Trademark property_description: '' comparators_available: - == - '!=' multiple: false end_point: firmportfolio - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' /usertype: get: tags: - User Type summary: Read many User Type description: Returns a list with all user types available on the system. operationId: 5e7ba3a9a1fc742a9d55aecb parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 responses: '200': description: "Returns a list with all user types available.\n\n" content: application/json: schema: $ref: '#/components/schemas/UserTypeList' example: - id: ad2c01df-7323-42bf-9744-a99201177d0f name: Partner code: 3 - id: 764c59e3-6528-474a-887c-a99201177d02 name: Paralegal code: 2 - id: 98668b91-296d-4f41-bee8-a99201177cf0 name: Attorney code: 1 /fileclientrole: get: tags: - Case Part Role summary: Read many Case Part Role description: 'Return the list of roles possible for Part on Cases: trademark owner, designer, representative, etc.' operationId: 29C3C1A448DF4FFF9CAB068A parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns data about case legal entities roles content: application/json: schema: $ref: '#/components/schemas/ListOfPartRolesOnCases' example: - enable: true id: 2ef1ef65-98f6-4aa1-ab64-a992011765e4 code: 6 name: Agent - enable: true id: 68f8f46d-0313-4816-985c-a992011765bd code: 1 name: Client - enable: true id: 7677d33e-e916-4a15-b58a-a992011765d8 code: 4 name: Other - enable: true id: 0c01905c-dc73-40f1-9885-a992011765de code: 5 name: Other representative - enable: true id: ee252fa3-3243-4337-a357-a992011765d1 code: 3 name: Representative /fileportfoliorole: get: tags: - Ip Record Role summary: Read many Ip Record Role description: Return the list of roles possibles for the IP Records on Cases. operationId: 5e7e615b3724d91c29adfe03 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns data about case trademark roles content: application/json: schema: $ref: '#/components/schemas/ReadManyFilePortfolioRole' example: - enable: true id: ea70d6e8-229d-470d-90fa-a9fb01864182 code: 4 name: Designation is_own: false - enable: true id: 3295f071-aad8-4e8f-a28f-a992011765ff code: 3 name: Disposition is_own: false - enable: true id: 5a7fdfcd-3a50-4f87-9869-a992011765f8 code: 2 name: Other party is_own: false - enable: true id: 72ccf3d8-cc1b-4e9b-9f7b-a992011765ee code: 1 name: Own is_own: true /countries/filters: get: tags: - Country summary: Filter Country description: 'Get a list with all properties available to create a filter for this endpoint. To get more info about how to create filters, please refer to this link.' operationId: 5e812644293251ce56ee3c80 responses: '200': description: "Returns a list with all properties available to create a filter for this endpoint.\n\n" content: application/json: schema: $ref: '#/components/schemas/CountryFilter' example: - property_name: name property_type: String property_display_name: Name property_description: Human-readable country name comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: short_name property_type: String property_display_name: Short Name property_description: Abbreviation for the country comparators_available: - CONTAINS - == - '!=' - STARTSWITH - ENDSWITH multiple: false end_point: '' - property_name: updated_at property_type: DateTime property_display_name: Updated at property_description: Date of last update for this entity comparators_available: - == - '!=' - '>' - '>=' - < - <= - IN - CU multiple: false end_point: '' /task: post: tags: - Task summary: 'Task - 01.Create[S]' description: Create a new task for the Case. operationId: 5e9e3603182308e61cac8f90 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '201': description: This code is returned when the task was created successfully. content: application/json: { } put: tags: - Task summary: 'Task - 03.Update[S]' description: Update a task for the Case. operationId: 5e9e381287235dc58f840540 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. schema: type: string responses: '200': description: '' '/task/{id}': delete: tags: - Task summary: 'Task - 04.Delete[S]' description: Delete a task. operationId: 5e9e38a9094608246390ae74 parameters: - name: id in: path required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: '' get: tags: - Task summary: 'Task - 02.Read[S]' description: Get task details. operationId: 5e9e395f7772c83d281d8248 parameters: - name: id in: path required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. schema: type: string responses: '200': description: '' /taskreminder: post: tags: - Task Reminder summary: 'Task Reminder - 01.Create[S]' description: Create a new reminder for the Task. operationId: 5e9e39e2bfebf985c5edc1cb parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '201': description: Returns data about new task reminder created content: application/json: { } put: tags: - Task Reminder summary: 'Task Reminder - 03.Update[S]' description: Update a task reminder. operationId: 5e9e3a41262bcef96aa05863 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: '' '/taskreminder/{id}': get: tags: - Task Reminder summary: 'Task Reminder - 02.Read[S]' description: Get task reminder details. operationId: 5e9e3a312f851e45470dda34 parameters: - name: id in: path required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: '' delete: tags: - Task Reminder summary: 'Task Reminder - 04.Delete[S]' description: Delete a task reminder. operationId: 5e9e3a4c18d5263f932e3835 parameters: - name: id in: path required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: '' '/tax/{id}': get: tags: - Tax summary: Read Tax description: Return a tax entity details. operationId: 5ea1f0a1a5b35fdd1a9efd3f parameters: - name: id in: path description: The tax ID. required: true schema: type: string responses: '200': description: Returns a tax entity representation. content: application/json: schema: $ref: '#/components/schemas/Tax' example: id: 1235e80b-fc55-44c0-ace8-903e53522e3e name: AR VAT description: '' units: 0 percent: 0 '/currency/{id}': get: tags: - Currency summary: Read Currency description: Return a currency entity details. operationId: 5ea1f45ef9b04cb29ff3fd06 parameters: - name: id in: path description: '' required: true schema: type: string responses: '200': description: Returns a currency entity representation. content: application/json: schema: $ref: '#/components/schemas/Currency' example: id: cd12f109-c15c-42c1-9ae3-a6e91118d70c name: Pound sterling name_short: GBP symbol: £ /claim: get: tags: - Claim summary: Read many Claim description: Return claims available to assigned to users. operationId: 5ea3ae0c8f5fee7079593df7 parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Return the claims available to be assigned with users. content: application/json: schema: $ref: '#/components/schemas/ReadManyClaim' example: - id: e8ed8dbb-1234-4672-ab59-a87300266bd8 claim_target: id: e30ea880-9ce1-4ca9-a719-a87300266764 code: 1 name: Portfolio description: Permissions related with actions over the Portfolio code: 102 name: External Limited User description: User can only see and edit portfolio items assigned to them. - id: e41ff142-6547-41c4-9452-a87300266a61 claim_target: id: e30ea880-9ce1-4ca9-a719-a87300266764 code: 1 name: Portfolio description: Permissions related with actions over the Portfolio code: 101 name: Internal Limited User description: 'User can see all portfolios items, but only edit items assigned to them.' - id: 7c4fcc3e-7897-4efe-a2f5-a873002668dd claim_target: id: e30ea880-9ce1-4ca9-a719-a87300266764 code: 1 name: Portfolio description: Permissions related with actions over the Portfolio code: 100 name: Read only description: 'User can see all portfolio items, but cannot edit them.' '/file/{id}': get: tags: - Case summary: Read Case description: Return case available. operationId: 5ea77ddddfd01866a2aab1fb parameters: - name: id in: path description: The case ID. required: true schema: type: string responses: '200': description: Return the case enabled to operate. content: application/json: schema: $ref: '#/components/schemas/ReadCase' example: id: 999ee0a3-209c-4bfa-96a3-ac31009acde1 name: '22242' number: '22242' folder: id: d46cfddd-9103-4059-9380-ac31009acddd name: 56611b85-84bd-431d-835d-6e803979e3ee_e72d1fa5-baec-480a-90e3-4c360e806f45 files: - id: 999ee0a3-209c-4bfa-96a3-ac31009acde1 name: '22242' number: '22242' folder: tags: [ ] other_supervisors: - id: d344g609-0948-4085-a7dd-ac34567ghh56 first_name: Mark last_name: KW user_name: email: phone_number: language_id: language_name: country_id: 5306aa9a-3c36-40d8-b32e-a67300008be3 country_name: GB client: id: c559a609-0948-4085-a7dd-ac31009acd26 name: Robinson Richard company_registration_number: contact_name: '' contact_email: email@server.com contact_number: contact_address: id: 40d1e085-20e1-4afd-83b4-ac31009acd26 line1: line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: c6b020e9-e5b1-425d-823e-a67300008be3 country_name: Brazil billing_address: id: 3118a563-1e88-4c4a-90df-ac31009acd26 line1: line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: c6b020e9-e5b1-425d-823e-a67300008be3 country_name: Brazil client_type: 604a3d85-5c5b-4364-b69c-a99201175b30 user: id: 8243ac64-65e9-42b5-a292-a8070178a462 first_name: TMD last_name: Migration user_name: lawpanel@tmd.com email: lawpanel@tmd.com phone_number: '654321' language_id: 09ae78dd-8be8-44c5-8f0e-a99201169289 language_name: Montenegrin country_id: c6b020e9-e5b1-425d-823e-a67300008be3 country_name: Brazil file_status: id: dbb513aa-58e3-4a70-a805-a74c00714768 name: Opened initial_state: true file_template: id: 3dc49d41-4cdc-47bb-b965-a807017653d4 name: Trademark TMD file_template_components: - id: 2f629748-c13f-4fc3-a760-a80701765553 name: Search result description: Represent a search result executed by a firm definition: definition_type: entity_type: FirmSearch permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 1 value_type: - id: fcad12f2-4efc-4158-8a41-a80701765749 name: Good and services description: Please describe the goods or services the name is to be used with definition: definition_type: entity_type: StringMultiText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - id: 68bb0819-e272-4392-8fcc-a8070176592e name: Website description: If there is a website for your business or goods/services please enter the URL definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 3 value_type: - id: b74feae6-201a-4b7e-a477-a80701765b13 name: Are you already using the name description: 'if so please let us know, this can help us get the name registered' definition: '{"Items":[{"Display":"Not using","Value":"Not using","Enable":false},{"Display":"Less than 1 year","Value":"Less than 1 year","Enable":false},{"Display":"1 - 3 years","Value":"1 - 3 years","Enable":false},{"Display":"4 - 5 years","Value":"4 - 5 years","Enable":false},{"Display":"More than 5 years","Value":"More than 5 years","Enable":false}],"Enable":false}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 4 value_type: - id: b5f55936-ae28-4dab-9425-a80701765d2b name: Series description: Trademark is individual or part of a series? definition: '{"OptionWithTexts":[{"Id":"IndividualTrademark","OptionName":"This is an individual trade mark and not part of a series of trade marks","OptionDescription":"","WithDescription":false,"SelectedByDefault":true,"CreatedAt":"0001-01-01T00:00:00","Enable":false},{"Id":"PartOfSeriesTrademark","OptionName":"This trade mark is part of a series of related trade marks","OptionDescription":"A series of marks is a number of marks which only have very small differences that do not substantially affect the marks (for example, a word shown in CAPITALS and in ''small'' letters).","WithDescription":true,"SelectedByDefault":false,"CreatedAt":"0001-01-01T00:00:00","Enable":false}],"CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: OptionsWithTextDefinitionDto entity_type: OptionsWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 5 value_type: - id: 9c745a64-d9aa-47f8-83e9-a80701765f17 name: Previously registered description: Trademark was previously registered? definition: '{"OptionWithTexts":[{"Id":"NotPreviouslyRegistered","OptionName":"I have not previously registered this trade mark in another country","OptionDescription":"","WithDescription":false,"SelectedByDefault":true,"CreatedAt":"0001-01-01T00:00:00","Enable":false},{"Id":"PreviouslyRegistered","OptionName":"I have previously registered this trade mark in another country","OptionDescription":"If you have previously registered this trade mark in another country you may be able to claim priority over competing trade marks in this country. Please give details of previous registrations (incl. priority date, country, number)","WithDescription":true,"SelectedByDefault":false,"CreatedAt":"0001-01-01T00:00:00","Enable":false}],"CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: OptionsWithTextDefinitionDto entity_type: OptionsWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 6 value_type: - id: b55d051b-940a-4610-a8e3-a807017660fc name: SMS Notifications description: Being able to send you texts can help us progress your application more quickly and efficiently. Please enter your mobile phone number. definition: '{"Id":"SmsNotifications","CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: CheckboxWithTextDefinitionDto entity_type: CheckboxWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 7 value_type: OptionsWithTextValueDto - id: ff7777f7-23f1-430e-94f0-aa4d00e71536 name: Order folder description: Order folder definition: '{"Items":[{"Display":"Abandoned","Value":"Abandoned","Enable":false},{"Display":"Action required","Value":"Action required","Enable":false},{"Display":"Action required (paid)","Value":"Action required (paid)","Enable":false},{"Display":"Client action (paid)","Value":"Client action (paid)","Enable":false},{"Display":"Deleted","Value":"Deleted","Enable":false},{"Display":"For review","Value":"For review","Enable":false},{"Display":"For review (paid)","Value":"For review (paid)","Enable":false},{"Display":"New orders","Value":"New orders","Enable":false},{"Display":"No action","Value":"No action","Enable":false},{"Display":"Ongoing","Value":"Ongoing","Enable":false},{"Display":"Right Start","Value":"Right Start","Enable":false},{"Display":"Standard filing","Value":"Standard filing","Enable":false},{"Display":"To be filed","Value":"To be filed","Enable":false},{"Display":"Client action","Value":"Client action","Enable":false}],"Enable":true}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 8 value_type: - id: ba1be818-5b43-411a-b9db-aa4d00e7153b name: Order status description: Order status definition: '{"Items":[{"Display":"Awaiting client comments","Value":"Awaiting client comments","Enable":false},{"Display":"Filed","Value":"Filed","Enable":false},{"Display":"On hold awaiting client","Value":"On hold awaiting client","Enable":false},{"Display":"Order cancelled","Value":"Order cancelled","Enable":false},{"Display":"Order finished","Value":"Order finished","Enable":false},{"Display":"Prepare for filing","Value":"Prepare for filing","Enable":false},{"Display":"Preparing draft application","Value":"Preparing draft application","Enable":false},{"Display":"Preparing spec","Value":"Preparing spec","Enable":false},{"Display":"Report order placed","Value":"Report order placed","Enable":false},{"Display":"Searches and legal checks","Value":"Searches and legal checks","Enable":false},{"Display":"We''re thinking","Value":"We''re thinking","Enable":false}],"Enable":true}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 9 value_type: is_base: false is_template_for_trademark_filing: true is_template_filing: false base_id: 00000000-0000-0000-0000-000000000000 ip_records: [ ] components: created_by: lawpanel@tmd.com updated_at: '2020-09-09T09:23:37.5112425+00:00' updated_by: lawpanel@tmd.com firm_portfolio: active: true tags: [ ] other_supervisors: - id: d344g609-0948-4085-a7dd-ac34567ghh56 first_name: Mark last_name: KW user_name: email: phone_number: language_id: language_name: country_id: 5306aa9a-3c36-40d8-b32e-a67300008be3 country_name: GB client: id: c559a609-0948-4085-a7dd-ac31009acd26 name: Robinson Richard company_registration_number: contact_name: '' contact_email: email@server.com contact_number: contact_address: id: 40d1e085-20e1-4afd-83b4-ac31009acd26 line1: line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: 00000000-0000-0000-0000-000000000000 country_name: billing_address: id: 3118a563-1e88-4c4a-90df-ac31009acd26 line1: line2: line3: building: floor_level: postal_code: city: state_province: region: country_id: c6b020e9-e5b1-425d-823e-a67300008be3 country_name: Brazil client_type: user: id: 8243ac64-65e9-42b5-a292-a8070178a462 first_name: TMD last_name: Migration user_name: lawpanel@tmd.com email: lawpanel@tmd.com phone_number: '654321' language_id: 09ae78dd-8be8-44c5-8f0e-a99201169289 language_name: Montenegrin country_id: c6b020e9-e5b1-425d-823e-a67300008be3 country_name: Brazil file_status: id: dbb513aa-58e3-4a70-a805-a74c00714768 name: Opened initial_state: true file_template: id: 3dc49d41-4cdc-47bb-b965-a807017653d4 name: Trademark TMD file_template_components: - id: 2f629748-c13f-4fc3-a760-a80701765553 name: Search result description: Represent a search result executed by a firm definition: definition_type: entity_type: FirmSearch permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 1 value_type: - id: fcad12f2-4efc-4158-8a41-a80701765749 name: Good and services description: Please describe the goods or services the name is to be used with definition: definition_type: entity_type: StringMultiText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 2 value_type: - id: 68bb0819-e272-4392-8fcc-a8070176592e name: Website description: If there is a website for your business or goods/services please enter the URL definition: definition_type: entity_type: String permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 3 value_type: - id: b74feae6-201a-4b7e-a477-a80701765b13 name: Are you already using the name description: 'if so please let us know, this can help us get the name registered' definition: '{"Items":[{"Display":"Not using","Value":"Not using","Enable":false},{"Display":"Less than 1 year","Value":"Less than 1 year","Enable":false},{"Display":"1 - 3 years","Value":"1 - 3 years","Enable":false},{"Display":"4 - 5 years","Value":"4 - 5 years","Enable":false},{"Display":"More than 5 years","Value":"More than 5 years","Enable":false}],"Enable":false}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 4 value_type: - id: b5f55936-ae28-4dab-9425-a80701765d2b name: Series description: Trademark is individual or part of a series? definition: '{"OptionWithTexts":[{"Id":"IndividualTrademark","OptionName":"This is an individual trade mark and not part of a series of trade marks","OptionDescription":"","WithDescription":false,"SelectedByDefault":true,"CreatedAt":"0001-01-01T00:00:00","Enable":false},{"Id":"PartOfSeriesTrademark","OptionName":"This trade mark is part of a series of related trade marks","OptionDescription":"A series of marks is a number of marks which only have very small differences that do not substantially affect the marks (for example, a word shown in CAPITALS and in ''small'' letters).","WithDescription":true,"SelectedByDefault":false,"CreatedAt":"0001-01-01T00:00:00","Enable":false}],"CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: OptionsWithTextDefinitionDto entity_type: OptionsWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 5 value_type: - id: 9c745a64-d9aa-47f8-83e9-a80701765f17 name: Previously registered description: Trademark was previously registered? definition: '{"OptionWithTexts":[{"Id":"NotPreviouslyRegistered","OptionName":"I have not previously registered this trade mark in another country","OptionDescription":"","WithDescription":false,"SelectedByDefault":true,"CreatedAt":"0001-01-01T00:00:00","Enable":false},{"Id":"PreviouslyRegistered","OptionName":"I have previously registered this trade mark in another country","OptionDescription":"If you have previously registered this trade mark in another country you may be able to claim priority over competing trade marks in this country. Please give details of previous registrations (incl. priority date, country, number)","WithDescription":true,"SelectedByDefault":false,"CreatedAt":"0001-01-01T00:00:00","Enable":false}],"CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: OptionsWithTextDefinitionDto entity_type: OptionsWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 6 value_type: - id: b55d051b-940a-4610-a8e3-a807017660fc name: SMS Notifications description: Being able to send you texts can help us progress your application more quickly and efficiently. Please enter your mobile phone number. definition: '{"Id":"SmsNotifications","CreatedAt":"0001-01-01T00:00:00","Enable":false}' definition_type: CheckboxWithTextDefinitionDto entity_type: CheckboxWithText permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 7 value_type: OptionsWithTextValueDto - id: ff7777f7-23f1-430e-94f0-aa4d00e71536 name: Order folder description: Order folder definition: '{"Items":[{"Display":"Abandoned","Value":"Abandoned","Enable":false},{"Display":"Action required","Value":"Action required","Enable":false},{"Display":"Action required (paid)","Value":"Action required (paid)","Enable":false},{"Display":"Client action (paid)","Value":"Client action (paid)","Enable":false},{"Display":"Deleted","Value":"Deleted","Enable":false},{"Display":"For review","Value":"For review","Enable":false},{"Display":"For review (paid)","Value":"For review (paid)","Enable":false},{"Display":"New orders","Value":"New orders","Enable":false},{"Display":"No action","Value":"No action","Enable":false},{"Display":"Ongoing","Value":"Ongoing","Enable":false},{"Display":"Right Start","Value":"Right Start","Enable":false},{"Display":"Standard filing","Value":"Standard filing","Enable":false},{"Display":"To be filed","Value":"To be filed","Enable":false},{"Display":"Client action","Value":"Client action","Enable":false}],"Enable":true}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 8 value_type: - id: ba1be818-5b43-411a-b9db-aa4d00e7153b name: Order status description: Order status definition: '{"Items":[{"Display":"Awaiting client comments","Value":"Awaiting client comments","Enable":false},{"Display":"Filed","Value":"Filed","Enable":false},{"Display":"On hold awaiting client","Value":"On hold awaiting client","Enable":false},{"Display":"Order cancelled","Value":"Order cancelled","Enable":false},{"Display":"Order finished","Value":"Order finished","Enable":false},{"Display":"Prepare for filing","Value":"Prepare for filing","Enable":false},{"Display":"Preparing draft application","Value":"Preparing draft application","Enable":false},{"Display":"Preparing spec","Value":"Preparing spec","Enable":false},{"Display":"Report order placed","Value":"Report order placed","Enable":false},{"Display":"Searches and legal checks","Value":"Searches and legal checks","Enable":false},{"Display":"We''re thinking","Value":"We''re thinking","Enable":false}],"Enable":true}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: [ ] required: false regex_to_validate: multiple_values: false display_order: 9 value_type: is_base: false is_template_for_trademark_filing: true is_template_filing: false base_id: 00000000-0000-0000-0000-000000000000 ip_records: [ ] components: [ ] created_by: lawpanel@tmd.com updated_at: '2020-09-09T09:23:37.5112425+00:00' updated_by: lawpanel@tmd.com active: true /firmproductfilter: get: tags: - Fee Item Bundle summary: 'Fee Item Bundle - 01.Read many[S]' description: Return all fee items bundle available. operationId: 5ed7fa017f2151f933487f2d parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Return all fee items bundle enabled to operate.\n" content: application/json: example: - id: 1d11e45d-ab34-43cb-a730-abcf0146ff8f name: UK categories: 2 products: 9 - id: 6bbbe76e-03ff-4369-b118-ab1800d8bef0 name: Omar categories: 3 products: 8 - id: 4f98c41c-2cb1-4cba-aaf7-a74c0070c5fb name: UK & EU TM 1-8 classes categories: 2 products: 32 - id: 33805e78-46f5-41b6-bcff-a73f00d10da1 name: International categories: 0 products: 0 - id: 8cad6bb0-07c8-4e1d-9f30-a73c00a21eab name: USA categories: 2 products: 5 - id: 93406ac0-1f87-49f2-90f9-a6f80025d975 name: UK and EU TM 1-8 classes categories: 2 products: 38 '204': description: '' content: application/json: { } '/firmproductfilter/{id}': get: tags: - Fee Item Bundle summary: 'Fee Item Bundle - 02.Read[S]' description: Return fee item bundle details. operationId: 5ed7fb29785bd93e76caeefc parameters: - name: id in: path description: The fee item bundle ID. required: true schema: type: string - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string responses: '200': description: "Return the fee item bundle enabled to operate.\n" content: application/json: example: id: 4f98c41c-2cb1-4cba-aaf7-a74c0070c5fb firm_id: 8a5536dc-6d34-4f4a-8cac-a67201481ca0 product_filter: id: 4f98c41c-2cb1-4cba-aaf7-a74c0070c5fb name: UK & EU TM 1-8 classes internal_name: product_filter_details: - id: 93aff913-5b56-4b97-9199-a74c0070c919 products: - id: 7b9c70e3-e570-48c9-9d1d-a6e90008fbd9 code: '001' name: Registry fee - UK - 1 class name_public: Registry fee - UK - 1 class product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: 65a91dc7-fb1c-4e73-a9d0-a6e90008fc37 date_time: '2016-12-27T00:32:42.8524174+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 170 taxes: [ ] - id: 70ae1e30-b306-4812-b428-a6e90009251c code: '009' name: Our advice fee - UK - 1 class name_public: Our advice fee - UK - 1 class product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: 967a42d9-1670-491f-83e4-a6e900092579 date_time: '2016-12-27T00:33:18.0591632+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 249 taxes: - id: 8e113d0d-aa3f-4439-85fb-a6e90008ee65 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 product_modifier_definitions: - id: 8ca47b1d-3358-42fb-b99d-a6e90008f4bc name: '1' order: 1 product_modifier_group: id: d379fbb8-a984-45a1-b031-a6e90008f4bb name: N° Classes order: 2 - id: 0dc8cfbc-4d04-4e9b-9040-a74c0070af83 name: UKIPO order: 1 product_modifier_group: id: 13167519-ed58-4054-9f6b-a6e90008f2e2 name: Registers order: 1 - id: 215609c3-4c46-49e5-9764-a74c0070cb9c products: - id: 37eddd1c-9ce8-41c8-9b0a-a6e900090132 code: '002' name: Registry fee - UK - 2 class name_public: Registry fee - UK - 2 class product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: d533c401-cdf5-4178-ac46-a6e90009018f date_time: '2016-12-27T00:32:47.4099709+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 220 taxes: [ ] - id: fd4a4699-43d2-4f7f-a1bc-a6e900092aa2 code: '010' name: Our advice fee - UK - 2 class name_public: Our advice fee - UK - 2 class product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: 4a3b771a-1c00-48cd-a2f8-a6e900092aff date_time: '2016-12-27T00:33:22.7716174+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 299 taxes: - id: 8e113d0d-aa3f-4439-85fb-a6e90008ee65 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 product_modifier_definitions: - id: 0dc8cfbc-4d04-4e9b-9040-a74c0070af83 name: UKIPO order: 1 product_modifier_group: id: 13167519-ed58-4054-9f6b-a6e90008f2e2 name: Registers order: 1 - id: 5ca4c337-6c5e-4b8a-8c2b-a6e90008f4bc name: '2' order: 2 product_modifier_group: id: d379fbb8-a984-45a1-b031-a6e90008f4bb name: N° Classes order: 2 '204': description: '' content: application/json: { } /firmproductfilter/feeitemsparameters: post: tags: - Fee Item Bundle summary: 'Fee Item Bundle - 04.Read Parameters[S]' description: Return all parameters and definitions of fee item bundle available. operationId: 5ed94aabdd1e487fe4c9a0cc parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "" content: application/json: schema: $ref: '#/components/schemas/FeeItemBundleReadParametersParam' example: public_name: UK responses: '200': description: "Return list of parameters availables.\n" content: application/json: example: - id: a796e98e-3621-4a85-9f47-abcf0146ff1e name: Registers order: 1 product_modifier_definitions: - id: 1bd8eb8e-e061-4761-86af-abcf0146ff25 name: UKIPO order: 1 - id: 45dbfbbe-d890-4609-9da1-abcf0146ff3a name: EUIPO order: 2 - id: dc055e90-9303-4c1e-b3c7-abcf0146ff3a name: USPTO order: 3 - id: 8c250091-ad3e-4236-a473-abcf0146ff5b name: N° Classes order: 2 product_modifier_definitions: - id: eb859b25-af17-48f4-88f3-abcf0146ff5c name: '1' order: 1 - id: aa96f22c-62aa-4cbf-8d47-abcf0146ff5d name: '2' order: 2 - enable: true id: f0ca94d2-6c49-4649-a6bc-abcf0146ff5e name: '3' order: 3 - id: 3d37d804-0213-47ee-86a3-abcf0146ff6a name: '4' order: 4 - id: 243198cb-b157-4d47-aeff-abcf0146ff6b name: '5' order: 5 - id: 2d664ef4-4b55-4676-9827-abcf0146ff6c name: '6' order: 6 - id: 1a52476d-a5b2-4b1e-a2e3-abcf0146ff6d name: '7' order: 7 - id: 6069df47-7e5d-4fc8-9c9f-abcf0146ff6e name: '8' order: 8 /firmproductfilter/feeitemsbyparams: post: tags: - Fee Item Bundle summary: 'Fee Item Bundle - 03.Read by Parameters[S]' description: Return all fee items bundle availables. operationId: 5ed95392db63611e022c2f00 parameters: - name: cookie in: header description: User authentication cookie. Read more about how to you get it from here. required: true schema: type: string requestBody: description: "" content: application/json: schema: $ref: '#/components/schemas/FeeItemBundleReadByParametersParam' example: public_name: Usa param_and_values: - name: Registers value: uspto - name: N° Classes value: '1' responses: '200': description: "Return list of parameters availables.\n" content: application/json: example: - id: b33d5201-b08f-46e5-95b7-a73800fcbd6b code: USA001 name: Advice fee - USA - 1 class name_public: Advice fee - USA - 1 class product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: 2b0569fe-855b-4872-9fe7-a73800fcbd67 date_time: '2017-03-16T15:20:11.8584245+00:00' currency: enable: true id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 400 taxes: - id: 8e113d0d-aa3f-4439-85fb-a6e90008ee65 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 - id: e720f11b-09de-4d87-879b-a73800fd4ce3 code: USA002 name: 'Advice fee - USA - 4 or more classes ' name_public: 'Advice fee - USA - 4 or more classes ' product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: b44031ad-35da-48c8-b291-a73800fd4ce3 date_time: '2017-03-16T15:22:14.3010599+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 500 taxes: - id: 8e113d0d-aa3f-4439-85fb-a6e90008ee65 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 - id: ec61f1d7-6aed-4ab9-8b56-a73800fdc127 code: USA003 name: Registry fee - USA - 1 Class name_public: Registry fee - USA - 1 Class product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: d076d07c-ff4a-4e54-83c8-a73800fdc127 date_time: '2017-03-16T15:23:53.5118319+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 275 taxes: [ ] - id: 570cbe41-6591-42db-a498-a73800fe09ef code: USA004 name: Registry fee - USA - 2 Classes name_public: Registry fee - USA - 2 Classes product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: bbed028a-15bb-4b00-9a8b-a73800fe09ef date_time: '2017-03-16T15:24:55.6209427+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 450 - id: e268e171-3940-47fe-af7a-a73800fea303 date_time: '2017-03-16T15:27:06.2455733+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 550 taxes: - id: 8e113d0d-aa3f-4439-85fb-a6e90008ee65 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 - id: 6b4f3193-c55c-4106-90f0-a73800fe85f1 code: USA005 name: Registry fee - USA - 3 Classes name_public: Registry fee - USA - 3 Classes product_type: id: 13fc72e0-a875-4771-af97-a6e90008f046 name: Service prices: - id: eae2599f-6383-4fad-a939-a73800fe85f1 date_time: '2017-03-16T15:26:41.4389508+00:00' currency: id: cd80f109-c15c-42c1-9ae3-a6e90008d70c name: Pound sterling name_short: GBP symbol: £ currency_units: 825 taxes: - id: 8e113d0d-aa3f-4439-85fb-a6e90008ee65 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 '/firminvoice/{id}': get: tags: - Invoice summary: Read Invoice description: Returns details about an Invoice. operationId: 5f5906c3e52d53a64bc9c500 parameters: - name: id in: path description: Invoice ID to get details required: true schema: type: string responses: '200': description: Returns details about an Invoice. content: application/json: schema: $ref: '#/components/schemas/ReadInvoiceResponse' example: id: ab88a885-f937-4ce8-9f5d-ac3100f0cb9e date_time: '2020-09-09T00:00:00.0000000+00:00' date_time_due: '2020-09-09T00:00:00.0000000+00:00' invoice_type: id: bec8d8b7-a1e5-4e4c-911a-a7cc00fff1c2 name: Default code: 0 description: This is the default invoice type for all invoices leading_zeros: '0000000000' prefix: A- invoice_number: 1 client: id: 7187420e-9e7a-43f6-b832-ac3000d470e9 name: Name of the Company company_registration_number: Registration Number contact_name: Contact name contact_email: contact@email.com contact_number: '+5493875333953' contact_address: id: 7b25e717-b1f1-4bf6-8cde-ac3000d470e7 line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: Argentina billing_address: id: 55217328-90e3-4a5c-a3cf-ac3000d470e7 line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: Argentina client_type: id: 0a246949-d71d-49ae-a17b-a975001bdf45 code: 1 name: Client invoice_items: - id: 2db77f75-b957-4b5e-9bd3-ac3100d1aeae code: '001' name: Item 001 product_type: enable: true id: 615e202e-62f6-43ce-bc9f-a6b200040c9b name: Service currency: id: 14e294cf-7425-422f-83f2-a6b20003f5e3 name: Pound sterling name_short: GBP symbol: £ currency_units: 100 quantity: 1 taxes: - id: 1db77783-9e48-4ddc-a665-a6b4002671c1 name: UK VAT description: 'Value-added tax or value added tax (VAT) is a consumption tax levied in the United Kingdom by the national government. It was introduced in 1973 and is the third largest source of government revenue after income tax and National Insurance. It is administered and collected by HM Revenue and Customs, primarily through the Value Added Tax Act 1994.' units: 0 percent: 20 details: This is a fee item for a Case paid_out: false invoice_entity_type: File invoice_entity_id: 53620e77-5e3b-431b-9cb0-ac2800eaac75 payments: [ ] user: id: f947fbce-9f3f-4ece-b002-a68d014e018c first_name: Admin last_name: Admin user_name: admin@lawpanel.com email: admin@lawpanel.com phone_number: +54 9387543988 language_id: d690da37-20a7-436a-b6a4-a68900ad35b7 language_name: en country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: AR user_role: Admin last_login_date: '2020-08-31T11:55:18.7668609+00:00' is_yoti: false is_locked_out: false yoti_id: user_settings: claims: [ ] user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: observations: Observations for the Invoice /filelink: post: tags: - Case Link summary: Create Case Link description: Create a new case link. operationId: 5f593a81f4f352b21f8a8c5b requestBody: description: "Payload must contain information about the file link to be created.\n" content: application/json: schema: $ref: '#/components/schemas/CreateCaseLink' example: comments: ... file_id: c8650a60-cc9e-476c-bed9-ac3100f3db50 url: https://www.lawpanel.com responses: '201': description: This code is returned when the case link was created successfully. content: application/json: schema: $ref: '#/components/schemas/ResponseCaseLink' example: id: bbef5448-de95-4b5d-bcb5-ac31015276aa file: id: c8650a60-cc9e-476c-bed9-ac3100f3db50 name: 23109 - Test number: '23109' date_time: '2020-09-09T20:32:18.5817988+00:00' comments: ... url: https://www.lawpanel.com get: tags: - Case Link summary: Read many Case Link description: Return all cases links available. operationId: 5f5940d2dce284e7fbee2224 parameters: - name: take in: query description: Return all products enabled to operate with payments and invoices. schema: type: integer - name: skip in: query description: Skip N records. schema: type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Return all cases links enabled to operate. content: application/json: schema: $ref: '#/components/schemas/ReadManyCaseLink' example: - id: 15c8ff31-9a22-4fd0-af5a-a98200a81648 file: id: 0811cdd6-959c-4ad6-a4d6-a96e00c5dd0d name: newtrademark - filing number: '11111111' date_time: '2018-10-23T10:11:59.1854985+00:00' comments: Search url: http://www.google.com - id: 6c79eab9-c3c4-4257-9578-a8cb015657c8 file: enable: true id: 96c4a2fb-c836-4d1b-b651-a8cb0155e75a name: File 001 number: '1' date_time: '2018-04-23T20:46:25.9424283+00:00' comments: asdad url: https://www.nada.com '/filelink/{id}': delete: tags: - Case Link summary: Delete Case Link description: Delete a case link. operationId: 5f593f71be4923be4c6c15f8 parameters: - name: id in: path description: The Case Link ID to be deleted. required: true schema: type: string responses: '200': description: Return details about the delete operation. content: application/json: schema: $ref: '#/components/schemas/DeleteCaseLink' example: id: 24ab8b69-65d5-43b2-a99d-abac014452cf message: File link 'https://www.lawpanel.com'successfully deleted successful: true get: tags: - Case Link summary: Read Case Link description: Return file link available. operationId: 5f5940396a21d5ae80a4e933 parameters: - name: id in: path description: The file case ID. required: true schema: type: string responses: '200': description: Return the case link to operate. content: application/json: schema: $ref: '#/components/schemas/ReadCaseLink' example: id: bbef5448-de95-4b5d-bcb5-ac31015276aa file: id: c8650a60-cc9e-476c-bed9-ac3100f3db50 name: 23109 - Test number: '23109' date_time: '2020-09-09T20:32:18.5817988+00:00' comments: ... url: https://www.lawpanel.com '/paymentmethod/{id}': get: tags: - Payment Method summary: Read Payment Method description: Returns details about a Payment Method. operationId: 5f5b978d408f759fda5857a5 parameters: - name: id in: path description: Payment Method ID to get details. required: true schema: type: string responses: '200': description: Returns details about a Payment Method. content: application/json: schema: $ref: '#/components/schemas/PaymentMethodReadResponse' example: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services. payment_method_component_definitions: - enable: true id: 7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd payment_method: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: 'A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder''s promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.' payment_method_component_definitions: reusable: false name: card_name display_name: Name class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 1 - enable: true id: c1138c80-0ee2-4f67-b2da-a7cc00ffc389 payment_method: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: 'A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder''s promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.' payment_method_component_definitions: reusable: false name: address_line_one display_name: Address line one class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 2 - enable: true id: c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504 payment_method: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: 'A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder''s promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.' payment_method_component_definitions: reusable: false name: address_line_two display_name: Address line two class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 3 - enable: true id: 3339089b-4535-4ec1-a9b9-a7e8000a3451 payment_method: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: 'A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder''s promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.' payment_method_component_definitions: reusable: false name: address_city display_name: City class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 4 - enable: true id: 136678f3-6827-4ea9-9a02-a7e8000a3748 payment_method: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: 'A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder''s promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.' payment_method_component_definitions: reusable: false name: address_state display_name: State class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 5 - enable: true id: 8f298718-3d17-450f-8871-a7e8000a3abc payment_method: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: 'A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder''s promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.' payment_method_component_definitions: reusable: false name: address_zip display_name: Zip class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 6 - enable: true id: 3bd795ba-adff-45af-8b2f-a7e8000a3cc3 payment_method: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: 'A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder''s promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.' payment_method_component_definitions: reusable: false name: address_country display_name: Country class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 7 - enable: true id: 2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6 payment_method: enable: true id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: 'A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services, based on the cardholder''s promise to the card issuer to pay them for the amounts so paid plus other agreed charges. The card issuer (usually a bank) creates a revolving account and grants a line of credit to the cardholder, from which the cardholder can borrow money for payment to a merchant or as a cash advance.' payment_method_component_definitions: reusable: false name: observations display_name: Observations class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 8 reusable: false /filestatus: get: tags: - Case Status summary: Read many Case Status description: Returns a list with al statuses available to use for Cases. operationId: read-many-case-status parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns a list with all Case Statuses available ot use with Cases. content: application/json: schema: $ref: '#/components/schemas/CaseStatusReadManyResponse' example: - id: c4c2dfd7-d507-4a9d-9352-a73c013b33b6 name: Opened initial_state: true - id: 2e5b7a11-e263-46c1-a7a0-a72901028c07 name: Closed initial_state: false - id: a4966fbc-f052-4be9-90dc-a72901028aa7 name: Pending initial_state: false - id: e9019ddf-65cd-41c9-87f7-a72901028940 name: Filed initial_state: false /firmtag: get: tags: - Tag summary: Read many Tag description: Returns a list with all Tags available. operationId: read-many-tag parameters: - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_description in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns a list with all tags available. content: application/json: schema: $ref: '#/components/schemas/TagReadManyResponse' example: - id: f4757b8b-eacd-4a7f-934c-ac2200c0f3f1 name: Tag A color_text: '#02404c' color_background: '#e2ebed' parent: files_count: 0 - id: 809a1cb8-3cf3-4833-a659-ac2200c1012f name: Tag B color_text: '#02404c' color_background: '#e2ebed' parent: files_count: 0 - id: fc8b7bbc-6b7a-40eb-bdb9-ac2200c10a84 name: Tag C color_text: '#02404c' color_background: '#e2ebed' parent: files_count: 0 post: tags: - Tag summary: Create Tag description: Creates a new Tag. operationId: create-tag requestBody: description: The payload with Tag data. content: application/json: schema: $ref: '#/components/schemas/CreateTag' example: name: Tag D color_text: '#02404c' color_background: '#e2ebed' parent_id: '' responses: '201': description: This code is returned if the Tag was successfully created. content: application/json: schema: $ref: '#/components/schemas/CreateTagResponse' example: id: a3e1942e-ab2a-4914-b3c3-ac3600fef62e name: Tag D color_text: '#02404c' color_background: '#e2ebed' parent: '/firmfiletemplate/{id}': get: tags: - Case Template summary: Read Case Template description: Returns details about a Case Template. operationId: read-case-template parameters: - name: id in: path description: Case Template ID required: true schema: type: string responses: '200': description: Returns this code if the ID is valid and the Case Template exists. content: application/json: schema: $ref: '#/components/schemas/CaseTemplateReadResponse' example: id: 873c49ce-d6cf-4667-94ad-aad8011d6db7 name: Trademark filing file_template_components: - id: 2a951ce5-995d-4697-811d-aad8011d6db7 name: Case Sub status description: Case Sub status definition: '{"Items":[{"Display":"Allowed","Value":"Allowed","Enable":false},{"Display":"Awaiting Examination","Value":"Awaiting Examination","Enable":false},{"Display":"Formalised","Value":"Formalised","Enable":false},{"Display":"IR designation under Article 9","Value":"IR designation under Article 9","Enable":false},{"Display":"Opposed","Value":"Opposed","Enable":false},{"Display":"Partial Refusal of Protection","Value":"Partial Refusal of Protection","Enable":false},{"Display":"Renewal Instructions Sought","Value":"Renewal Instructions Sought","Enable":false},{"Display":"Renewed","Value":"Renewed","Enable":false},{"Display":"Total Refusal of Protection","Value":"Total Refusal of Protection","Enable":false}],"Enable":false}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: required: false regex_to_validate: multiple_values: false display_order: 1 value_type: - id: be41d32c-b1c0-417d-a5ba-aad8011d6db7 name: Case status description: Case status definition: '{"Items":[{"Display":"Registered","Value":"Registered","Enable":false},{"Display":"Abandoned","Value":"Abandoned","Enable":false},{"Display":"Case Transferred","Value":"Case Transferred","Enable":false},{"Display":"Cautionary Notice","Value":"Cautionary Notice","Enable":false},{"Display":"Common Law Mark","Value":"Common Law Mark","Enable":false},{"Display":"Lapsed","Value":"Lapsed","Enable":false},{"Display":"Not yet filed","Value":"Not yet filed","Enable":false},{"Display":"Pending","Value":"Pending","Enable":false},{"Display":"Pending(Not Responsible)","Value":"Pending(Not Responsible)","Enable":false},{"Display":"Refused","Value":"Refused","Enable":false},{"Display":"Registered","Value":"Registered","Enable":false},{"Display":"Registered(Not Responsible)","Value":"Registered(Not Responsible)","Enable":false},{"Display":"Test","Value":"Test","Enable":false},{"Display":"Withdrawn","Value":"Withdrawn","Enable":false}],"Enable":false}' definition_type: SelectItemFromListDefinitionDto entity_type: SelectItemFromList permissions: required: false regex_to_validate: multiple_values: false display_order: 0 value_type: - id: 45778ab7-da47-4127-a861-aad8011d6db7 name: Information description: '' definition: definition_type: entity_type: StringMultiText permissions: required: false regex_to_validate: multiple_values: false display_order: 3 value_type: - id: 132a0b08-da56-4a4c-ac67-aad8011d6db7 name: Date opened description: '' definition: definition_type: entity_type: DateTime permissions: required: false regex_to_validate: multiple_values: false display_order: 2 value_type: is_base: false is_template_for_trademark_filing: true is_template_filing: false base_id: d212c728-1ed6-474e-b350-a989010374d6 ip_records: - id: 6b125f60-5ff0-4a56-82c6-ac0600e4a811 code: 1 name: Trademark human_readable_name: Trademarks value: FirmPortfolio /order: post: tags: - Order summary: Create Order description: 'Creates a new Order. An Order is a composed entity by a Case, a Company, a Company User, Invoice Items, an Invoice, a Payment. In order to simplify the creation of Orders we have this special endpoint.' operationId: create-order requestBody: description: "Payload with data about the new order to be created. \n\n\n" content: application/json: schema: $ref: '#/components/schemas/CreateOrder' example: order_name: Order for trademark search "lawpanel". order_number: '1' company_name: Michael Jackson company_user_email: michael@jackson.com company_user_password: mj2020_ file_template_id: 96C4A417-7A0A-4241-AE84-AC3D011C40C8 file_template_components: - name: Search result value: 432db66d-467c-4835-bac6-ac3d00fa3af6 - name: Good and services value: Good and services contents - name: Website value: https://www.site.com - name: Are you already using the name value: 1 - 3 years - name: Series value: '{"option_id_selected":"PartOfSeriesTrademark","description":"This is the content for Series, second option selected with a description."}' - name: Previously registered value: '{"option_id_selected":"PreviouslyRegistered","description":"This is the contents for ''Previously registered'', second option."}' - name: SMS Notifications value: '{"selected":true,"description":"+5493875333953"}' - name: Order folder value: Abandoned - name: Order status value: On hold awaiting client - name: Country value: Argentina payment_currency_id: 95CE88B2-3229-4DD7-A35A-A6B20003F63B payment_items: - description: Registration fees 1 trademark on UK amount: 100 tax_id: 1DB77783-9E48-4DDC-A665-A6B4002671C1 - description: Our fees amount: 30 tax_id: do_not_create_payment: true responses: '201': description: "Returns an object with details about the operation result.\n\n" content: application/json: schema: $ref: '#/components/schemas/CreateOrderResponse' example: id: 6c2c01a1-10e2-47ae-b3b1-ac3e0144c3dc success: true message: Order '1/Order for trademark search "lawpanel".' successfully created url_to_redirect: https://web.lawpanel.local/account/loginfromorder?magic=bFZyNVdGT28rT0N0SGxwd3l2NoRGJhby /order/isavailabletocreate: get: tags: - Order summary: Is email available to create order? description: Checks if email address is available to create an order for the Company. operationId: is-email-available-to-create-order parameters: - name: companyUserEmail in: query description: The email to verify if is available to be used with an Order creation. required: true schema: type: string - name: companyName in: query description: The Company name where availability is checked required: true schema: type: string responses: '200': description: Returns information about the availability or not to create an order for the company and email sent as parameters. content: application/json: schema: $ref: '#/components/schemas/IsEmailAvailableToCreateOrderResponse' example: available: true message: Email address 'clientuser@bclient.com' is available to create a new order for company 'B client'. /clientuser/isemailavailabletocreate: get: tags: - Company User summary: 'Is email available to create a new Company User? ' description: Checks if email address is available to create a new Company User. operationId: 5f9177d185b549b9e0cf76a5 parameters: - name: email in: query description: The email to verify if is available to create a new Company User. required: true schema: type: string responses: '200': description: Returns information about the availability or not to create a Company User using the email. content: application/json: schema: $ref: '#/components/schemas/IsEmailAvailableToCreateCompanyUser' example: available: true message: Email address 'clientuser@bclient.com' is available to create a new Company User '/fileevent/file/{id}/{type}': get: tags: - Case Event summary: Read many Case Event description: Return all case events attachments available. operationId: 5fa2c5b2b971346095d2c276 parameters: - name: id in: path description: The Case ID to get all events. required: true schema: type: string - name: type in: path description: 'Optional. The type of event you want to receive. Possible values are: FileEventFeeItemAddedToFile, FileEventFeeItemDeleted, FileEventInvoiceCreatedForFile, FileEventInvoiceDeleted, FileEventInvoiceItemUpdated, FileEventInvoiceUpdatedForFile, FileEventType, FileEventTypeCommunicationOfClientUserToFirm, FileEventTypeCommunicationOfFirmUserToClient, FileEventTypeEmailAddedToFile, FileEventTypeFileAttachmentCreated, FileEventTypeFileAttachmentDeleted, FileEventTypeFileAttachmentUpdated, FileEventTypeFileClientCreated, FileEventTypeFileClientRemoved, FileEventTypeFileCreated, FileEventTypeFileDesignCreated, FileEventTypeFileDesignRemoved, FileEventTypeFileLinkCreated, FileEventTypeFileLinkDeleted, FileEventTypeFileLinkUpdated, FileEventTypeFilePortfolioCreated, FileEventTypeFilePortfolioDeleted, FileEventTypeFilePortfolioRemoved, FileEventTypeFilePortfolioUpdated, FileEventTypeFileRenamed, FileEventTypeFileUpdated, FileEventTypeFileUpdatedFromBatchTask, FileEventTypeNoteAddedToFile, FileEventTypeReminderSent, FileEventTypeReminderUpdated, FileEventTypeReportSentByEmail, FileEventTypeTaskReminderDeleted, FileEventTypeTrademarkUpdatedFromIpo.' required: true schema: enum: - FileEventFeeItemAddedToFile - FileEventFeeItemDeleted - FileEventInvoiceCreatedForFile - FileEventInvoiceDeleted - FileEventInvoiceItemUpdated - FileEventInvoiceUpdatedForFile - FileEventType - FileEventTypeCommunicationOfClientUserToFirm - FileEventTypeCommunicationOfFirmUserToClient - FileEventTypeEmailAddedToFile - FileEventTypeFileAttachmentCreated - FileEventTypeFileAttachmentDeleted - FileEventTypeFileAttachmentUpdated - FileEventTypeFileClientCreated - FileEventTypeFileClientRemoved - FileEventTypeFileCreated - FileEventTypeFileDesignCreated - FileEventTypeFileDesignRemoved - FileEventTypeFileLinkCreated - FileEventTypeFileLinkDeleted - FileEventTypeFileLinkUpdated - FileEventTypeFilePortfolioCreated - FileEventTypeFilePortfolioDeleted - FileEventTypeFilePortfolioRemoved - FileEventTypeFilePortfolioUpdated - FileEventTypeFileRenamed - FileEventTypeFileUpdated - FileEventTypeFileUpdatedFromBatchTask - FileEventTypeNoteAddedToFile - FileEventTypeReminderSent - FileEventTypeReminderUpdated - FileEventTypeReportSentByEmail - FileEventTypeTaskReminderDeleted - FileEventTypeTrademarkUpdatedFromIpo type: string responses: '200': description: Return all Case events for the Case selected. content: application/json: schema: $ref: '#/components/schemas/ReadManyCaseEvent' example: - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139337893079999999|FileEvent date_time: '2020-10-31T01:38:12.0000000+00:00' event_type: File updated by: Ashya Ison by_id: b075ae99-365d-4eb1-823f-a8f900bb37d2 comments: '' - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795689999999|FileEvent date_time: '2020-10-30T00:33:51.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795709999999|FileEvent date_time: '2020-10-30T00:33:49.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795729999999|FileEvent date_time: '2020-10-30T00:33:47.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795749999999|FileEvent date_time: '2020-10-30T00:33:45.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795769999999|FileEvent date_time: '2020-10-30T00:33:43.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795789999999|FileEvent date_time: '2020-10-30T00:33:41.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795809999999|FileEvent date_time: '2020-10-30T00:33:39.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795819999999|FileEvent date_time: '2020-10-30T00:33:38.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795839999999|FileEvent date_time: '2020-10-30T00:33:36.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795859999999|FileEvent date_time: '2020-10-30T00:33:34.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795879999999|FileEvent date_time: '2020-10-30T00:33:32.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795899999999|FileEvent date_time: '2020-10-30T00:33:30.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795919999999|FileEvent date_time: '2020-10-30T00:33:28.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795929999999|FileEvent date_time: '2020-10-30T00:33:27.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795949999999|FileEvent date_time: '2020-10-30T00:33:25.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795969999999|FileEvent date_time: '2020-10-30T00:33:23.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338795989999999|FileEvent date_time: '2020-10-30T00:33:21.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796009999999|FileEvent date_time: '2020-10-30T00:33:19.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796029999999|FileEvent date_time: '2020-10-30T00:33:17.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796039999999|FileEvent date_time: '2020-10-30T00:33:16.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796059999999|FileEvent date_time: '2020-10-30T00:33:14.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796079999999|FileEvent date_time: '2020-10-30T00:33:12.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796099999999|FileEvent date_time: '2020-10-30T00:33:10.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796119999999|FileEvent date_time: '2020-10-30T00:33:08.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796139999999|FileEvent date_time: '2020-10-30T00:33:06.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338796149999999|FileEvent date_time: '2020-10-30T00:33:05.0000000+00:00' event_type: Note added by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: Private note - file_id: 693d950b-a69e-4373-8f0c-ac6400087a26 folder_id: 60815174-02fd-49ca-8ff3-ac6400087846 user_id: 33193f6f-8076-49e5-8c39-a8090119f09f firm_id: 575726f9-ce96-4d4e-8088-a8090118c86e client_id: '' id: 693d950b-a69e-4373-8f0c-ac6400087a26|3139338797469999999|FileEvent date_time: '2020-10-30T00:30:53.0000000+00:00' event_type: File creation by: LawPanel System by_id: 942c0e1b-2202-4a7e-b9c3-a6720147e58c comments: '' '/fileevent/data/{id}': get: tags: - Case Event summary: Read Case Event description: Returns the event data serialized. operationId: 5fa2dc62a44919c3dab34b5b parameters: - name: id in: path description: The event ID to get its data. required: true schema: type: string responses: '200': description: Returns a serialized string with the event data. Returned value depends on the type of event. content: application/json: example: '{"FileId":"2d2a8faf-2e13-4c36-b9f3-ac47013119e8","NoteId":"1c96834f-a7f2-408f-a2c1-37fdd57a4fef_637401066514736366","Note":"

I''m the contents of the note added.

","NoteType":null}' /users/forgotpassword: get: tags: - User summary: Forgot Password description: Sends an email to the user's address with a link to recover its password. operationId: 5faabace5da14875769e943c parameters: - name: userName in: query description: The user name to recover the password. required: true schema: type: string responses: '200': description: 'Always returns OK without any comment, even username is valid or not. ( by security reasons )' /firminvoice/outstanding: get: tags: - Invoice summary: Read many Oustanding Invoice description: Returns a list with all invoices available for your Firm. operationId: 5fad6b1334d4b01720bcd9ee parameters: - name: clientId in: query description: Company ID to filter outstanding invoices. required: true schema: type: string - name: userId in: query description: User ID to filter oustanding invoices. required: true schema: type: string - name: take in: query description: Take N records. Default value is 10. Max value is 100. schema: enum: - 10 type: integer default: 10 - name: skip in: query description: Skip N records. schema: enum: - 0 type: integer default: 0 - name: filter_id in: query description: Filter ID to apply on this endpoint. To get further details about filters click here. schema: type: string - name: filter_definition in: query description: Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering. schema: type: string responses: '200': description: Returns a list with all Oustanding Invoices for your Firm. content: application/json: schema: $ref: '#/components/schemas/ReadManyInvoiceOutstandingResponse' example: - id: ab88a885-f937-4ce8-9f5d-ac3100f0cb9e date_time: '2020-09-09T00:00:00.0000000+00:00' date_time_due: '2020-09-09T00:00:00.0000000+00:00' invoice_type: id: bec8d8b7-a1e5-4e4c-911a-a7cc00fff1c2 name: Default code: 0 description: This is the default invoice type for all invoices leading_zeros: '0000000000' prefix: A- invoice_number: 1 client: id: 7187420e-9e7a-43f6-b832-ac3000d470e9 name: Name of the Company company_registration_number: Registration Number contact_name: Contact name contact_email: contact@email.com contact_number: '+5493875333953' contact_address: id: 7b25e717-b1f1-4bf6-8cde-ac3000d470e7 line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: Argentina billing_address: id: 55217328-90e3-4a5c-a3cf-ac3000d470e7 line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: Argentina client_type: id: 0a246949-d71d-49ae-a17b-a975001bdf45 code: 1 name: Client total_invoice_items: 120 total_payments: 31 user: id: f947fbce-8f3f-4ece-ba22-a67d014e108c first_name: John last_name: Doe user_name: john@doe.com email: john@doe.com phone_number: +54 9387543988 language_id: d690da37-20a7-436a-b6a4-a68900ad35b7 language_name: en country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 country_name: AR user_role: FirmUser last_login_date: '2020-10-01T17:37:57.6217197+00:00' is_locked_out: false user_settings: claims: [ ] user_type_id: 00000000-0000-0000-0000-000000000000 user_type_name: currency: id: 14e294cf-7425-422f-83f2-a6b20003f5e3 name: Pound sterling name_short: GBP symbol: £ observations: Observations for the Invoice /uploader/upload: post: tags: - Upload summary: Upload File description: Uploads a file to LawPanel's servers. operationId: 5fca67a871b63f4009f91948 requestBody: description: "Payload must contain information about the file to be uploaded. Payload must be a multipart-form with a param named \"file\" containing the file to be uploaded.\n\n\n" content: multipart/form-data: example: "-----------------------------9051914041544843365972754266\r\nContent-Disposition: form-data; name=\"file\"; filename=\"a.txt\"\r\nContent-Type: text/plain\r\n\r\nThis is the content of a.txt.\r\n\r\n-----------------------------9051914041544843365972754266--" responses: '200': description: Returns a JSON structure with details about the file uploaded. content: application/json: schema: $ref: '#/components/schemas/UploaderUploadFileResponse' example: id: d6f80720-430c-47cb-a3e6-07a905a0f33f url: https://lawpanellocal.blob.core.windows.net/private-assets/d6f80720-430c-47cb-a3e6-07a905a0f33f_637426929817710507.png size: 402438 name: 02.Octubre 1 de 2.png ext: .png mime_type: image/png /communication: post: summary: Communication operationId: communication responses: '200': description: /order/isavailabletocreatetmd: get: summary: Is email available to create order? (TMD) description: Checks if email address is available to create an order for TMD. operationId: 60a140f4ec1a0c721ffcbc74 parameters: - name: companyUserEmail in: query description: The email to verify if is available to be used with an Order creation. required: true schema: type: string responses: '200': description: Returns information about the availability or not to create an order for the company and email sent as parameters. content: application/json: schema: $ref: '#/components/schemas/IsEmailAvailableToCreateOrderResponse' example: available: true message: Email address 'clientuser@bclient.com' is available to create a new order for company 'B client'. /order/readcompany: get: summary: Read Company (TMD) description: Checks if email address is available to create an order for TMD. operationId: 60a14ba8cc8e906600435e69 parameters: - name: email in: query required: true schema: type: string - name: password in: query required: true schema: type: string responses: '200': description: Returns information about the availability or not to create an order for the company and email sent as parameters. content: application/json: schema: $ref: '#/components/schemas/IsEmailAvailableToCreateOrderResponse' example: available: true message: Email address 'clientuser@bclient.com' is available to create a new order for company 'B client'. '/abandonedbasket/{id}': get: summary: Abandoned Basket - 01.Read description: Return a abandoned basket entity details. operationId: 61041a515bc95229695e7bd9 parameters: - name: id in: path description: Possible use the id or code to get the entity required: true schema: type: string responses: '200': description: Returns a abandoned basket entity representation. delete: summary: Delete Abandoned Basket description: Delete a Abandoned basket operationId: 610422dfc28e7ce48e548a65 parameters: - name: id in: path description: The Abandoned basket ID to be deleted. required: true schema: type: string responses: '200': description: Return details about the delete operation. /abandonedbasket: post: summary: Create Abandoned Basket description: Creates a new Abandoned basket entity. operationId: 610421c6a2f3c1503d30db15 responses: '201': description: If everything happened succesfully returns the model with new Abandoned basket created. put: summary: Update Abandoned Basket description: Updates a Abandoned basket data. operationId: 610422798155e5615604f6b7 responses: '201': description: Returns information about the Abandoned basket Updated. '/accesssearchresult/{id}': get: summary: Access search result - 01.Read description: Return a access search result entity details. operationId: 6112a330081717ffb54759d3 parameters: - name: id in: path description: Possible use the id or code to get the entity required: true schema: type: string responses: '200': description: Returns a access search result entity representation. delete: summary: Delete Access search result description: Delete a Access search result operationId: 6112a4806f5c49fb1115fb15 parameters: - name: id in: path description: The Access search result ID to be deleted. required: true schema: type: string responses: '200': description: Return details about the delete operation. /accesssearchresult: post: summary: Create Access search result description: Creates a new Access search result entity. operationId: 6112a3a7ca614e6a8be984d4 responses: '201': description: If everything happened succesfully returns the model with new Access search result created. put: summary: Update Access search result description: Updates a Access search result data. operationId: 6112a442aa648534489ee8db responses: '201': description: Returns information about the Access search result Updated. components: schemas: Registry: type: object properties: id: type: string wipo_code: type: string description: type: string have_data: type: boolean url_base_for_trademarks: type: string iso_three_letters_country_code: type: string total_trademarks: type: integer Trademark: type: object properties: id: type: string registry_id: type: string registry_name: type: string registry_official_name: type: string registry_description: type: string mark_text: type: string application_number: type: string application_date: type: string registration_number: type: string registration_date: type: string status_date: type: string mark_feature: type: string status: type: string registration_type_id: type: string registration_type_name: type: string trademark_type_id: type: string trademark_type_name: type: string expiry_date: type: string publication_date: type: string declaration_date: type: string office_action_date: type: string grant_date: type: string client_agent_id: type: string client_agent_name: type: string publication_notes: type: string good_and_services: type: array items: required: - id - language - search_class - text type: object properties: id: type: string language: type: object properties: id: type: string name: type: string short_name: type: string is_available_for_ui: type: boolean search_class: type: object properties: id: type: string number: type: integer name: type: string description: type: string search_classes: type: string text: type: string image_url: type: string notes: type: string do_not_create_file: type: boolean user_id: type: string user_user_name: type: string trademark_url_on_ipo: { } exclude_from_auto_updates: type: boolean watching: { } Filter: type: object properties: enable: type: boolean id: type: string end_point: type: string name: type: string applied: type: boolean filter_definition: type: object properties: groups: type: array items: required: - expressions - operator_next type: object properties: expressions: type: array items: required: - property_name - comparator - value - personalized - operator_next type: object properties: property_name: type: string comparator: type: string value: type: string personalized: type: boolean operator_next: type: string operator_next: type: string example: id: 66c4ef28-2429-46f3-b815-ab870165e520 end_point: firmportfolio name: '''law'' in US' applied: false filter_definition: groups: - expressions: - property_name: registry.id comparator: == value: 783c0667-2884-4d0a-b93b-a6720147e45f operator_next: OR operator_next: AND - expressions: - property_name: mark_text comparator: CONTAINS value: law operator_next: AND operator_next: AND Language: type: object properties: id: type: string name: type: string short_name: type: string is_available_for_ui: type: boolean User: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_locked_out: type: boolean user_type_id: type: string user_type_name: type: string Frequency: type: object properties: id: type: string name: type: string unit_name: type: string years: type: integer months: type: integer days: type: integer hours: type: integer minutes: type: integer seconds: type: integer total_in_seconds: type: integer Watching: type: object properties: id: type: string user_id: type: string user_name: type: string sensitivity: type: integer application_number: type: string trademark: type: string last_search_date: { } last_search_results: { } classes: type: string registry_id: type: string registry_name: type: string frequency_id: type: string frequency_name: type: string firm_portfolio_id: type: string interesting_watching_history_records: type: integer last_notification_date_time: { } example: id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 20 firm_portfolio_id: 605366ae-6ba7-4f0c-acc4-ab4a00d38883 application_number: '0303456' trademark: 5ARTH classes: '20' registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 registry_name: GB frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly events: - id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f|3139581561719999999 unix_time_stamp: 1579741428 application_date: '2020-01-02T00:00:00.0000000+00:00' application_number: UK00003455018 trademark: 5ARTH classes: '20' databases: GB owner_applicant: Lai Feifeng status: Pending good_and_services: '20: desks [furniture], office furniture, furniture, chairs, display stands, [...]' handled: false created: '2020-01-22T12:50:42.5533169+00:00' last_search_date: '2020-01-23T01:05:06.9702455Z' last_notification_date_time: '2020-01-23T01:05:06.9702455Z' Search: type: object properties: classes: type: string search_origin_id: type: string search_term: type: string ClientTypeList: type: array items: required: - id - code - name type: object properties: id: type: string code: type: integer name: type: string SearchResults: type: array items: required: - id - searchId - score - classes - status - textMarkId - textMarkString - resultOrder - removed - selected - registry - isRegistered - isRegisteredNoClassMatch - isAmber type: object properties: id: type: string searchId: type: string score: type: string classes: type: string status: type: string textMarkId: type: string textMarkString: type: string resultOrder: type: string removed: type: string selected: type: string registry: type: string isRegistered: type: string isRegisteredNoClassMatch: type: string isAmber: type: string classMatch: type: string applicationNumber: type: string CountryFilter: type: array items: required: - property_name - property_type - property_display_name - property_description - comparators_available - multiple - end_point type: object properties: property_name: type: string property_type: type: string property_display_name: type: string property_description: type: string comparators_available: type: array items: type: string multiple: type: boolean end_point: type: string CreateCase: type: object properties: active: type: boolean file_template_id: type: string name: type: string number: type: string user_id: type: string example: active: true file_template_id: c554e22c-6f6e-42d3-8954-a780013c92a0 name: Case number: No case reference user_id: 7ed98cd7-cc17-4883-989c-a6730003709d CreateFeeitem: type: object properties: product_name: type: string currency_id: type: string product_code: type: string product_name_public: type: string value: type: integer taxes: type: array items: required: - enable - id - name - description - units - percent type: object properties: enable: type: boolean id: type: string name: type: string description: type: string units: type: integer percent: type: integer example: product_name: Product currency_id: 54cb5c6a-a8e0-4dec-afcc-a6e90008d6ae product_code: '0001' product_name_public: Product value: 150 taxes: - id: 4005e80b-fc55-44c0-ace8-903e53522e3e CreateCaseResponse: type: object properties: enable: type: boolean id: type: string name: type: string number: type: string folder: type: object properties: enable: type: boolean id: type: string name: type: string files: type: array items: required: - enable - id - name - number - folder - tags - other_supervisors - client - user - file_status - file_template - components - created_by - updated_at - updated_by - firm_portfolio - active type: object properties: enable: type: boolean id: type: string name: type: string number: type: string folder: { } tags: type: array items: { } other_supervisors: { } client: { } user: type: object properties: enable: type: boolean id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_yoti: type: boolean is_locked_out: type: boolean yoti_id: { } user_settings: { } claims: type: array items: { } user_type_id: type: string user_type_name: { } file_status: type: object properties: enable: type: boolean id: type: string name: type: string initial_state: type: boolean file_template: type: object properties: enable: type: boolean id: type: string name: type: string file_template_components: type: array items: required: - enable - id - name - description - definition - definition_type - entity_type - permissions - required - regex_to_validate - multiple_values - display_order - value_type type: object properties: enable: type: boolean id: type: string name: type: string description: type: string definition: { } definition_type: { } entity_type: type: string permissions: type: array items: { } required: type: boolean regex_to_validate: { } multiple_values: type: boolean display_order: type: integer value_type: { } is_base: type: boolean is_template_for_trademark_filing: type: boolean base_id: type: string components: { } created_by: type: string updated_at: type: string updated_by: type: string firm_portfolio: { } active: type: boolean tags: type: array items: { } other_supervisors: { } client: { } user: type: object properties: enable: type: boolean id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_yoti: type: boolean is_locked_out: type: boolean yoti_id: { } user_settings: { } claims: type: array items: { } user_type_id: type: string user_type_name: { } file_status: type: object properties: enable: type: boolean id: type: string name: type: string initial_state: type: boolean file_template: type: object properties: enable: type: boolean id: type: string name: type: string file_template_components: type: array items: required: - enable - id - name - description - definition - definition_type - entity_type - permissions - required - regex_to_validate - multiple_values - display_order - value_type type: object properties: enable: type: boolean id: type: string name: type: string description: type: string definition: { } definition_type: { } entity_type: type: string permissions: type: array items: { } required: type: boolean regex_to_validate: { } multiple_values: type: boolean display_order: type: integer value_type: { } is_base: type: boolean is_template_for_trademark_filing: type: boolean base_id: type: string components: { } created_by: type: string updated_at: type: string updated_by: type: string firm_portfolio: { } active: type: boolean CreateFilePortfolio: type: object properties: file_id: type: string firm_portfolio_id: type: string file_portfolio_role_id: type: string example: file_id: 63573649-3ee9-4367-a176-ab0a0127509c firm_portfolio_id: 42cb80ce-a153-43f2-9d9e-ab0a01275064 file_portfolio_role_id: 72ccf3d8-cc1b-4e9b-9f7b-a992011765ee CreateFilter: type: object properties: name: { } end_point: type: string it_is_last_used_without_save: type: boolean applied: type: boolean filter_definition: type: object properties: groups: type: array items: required: - expressions - operator_next type: object properties: expressions: type: array items: required: - property_name - comparator - value - operator_next type: object properties: property_name: type: string comparator: type: string value: type: string operator_next: type: string operator_next: type: string example: name: end_point: firmportfolio it_is_last_used_without_save: true applied: false filter_definition: groups: - expressions: - property_name: mark_text comparator: CONTAINS value: lawpanel operator_next: AND operator_next: AND CreateTrademark: type: object properties: registry_id: type: string mark_text: type: string application_number: type: string application_date: type: string registration_number: type: string registration_date: type: string status_date: type: string mark_feature: type: string status: type: string registration_type_id: type: string trademark_type_id: type: string expiry_date: type: string publication_date: type: string declaration_date: type: string office_action_date: type: string grant_date: type: string client_agent_id: type: string publication_notes: type: string good_and_services: type: array items: required: - language_id - text - search_class_id type: object properties: language_id: type: string text: type: string search_class_id: type: string image_url: type: string notes: type: string do_not_create_file: type: boolean example: registry_id: 783C0667-2884-4D0A-B93B-A6720147E45F mark_text: LawPanel application_number: '87064395' application_date: '2020-03-17T03:00:00Z' registration_number: '5230966' registration_date: '2020-03-17T03:00:00Z' status_date: '2020-03-17T03:00:00Z' mark_feature: mark status: Valid registration_type_id: 21B28699-8E12-4575-BB65-A99201173ED2 trademark_type_id: 6D374194-9DF4-4A26-89DD-A992011744FD expiry_date: '2020-03-17T03:00:00Z' publication_date: '2020-03-17T03:00:00Z' declaration_date: '2020-03-17T03:00:00Z' office_action_date: '2020-03-17T03:00:00Z' grant_date: '2020-03-17T03:00:00Z' client_agent_id: A1C3E613-C9A5-49C5-91D9-AAAF009C09F1 publication_notes: Notes about publication good_and_services: - language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 text: 'Facilitating, administering, arranging and managing funding in relation to litigation [...]' search_class_id: 5096b33b-2f52-456d-b306-a6720147e7fc - language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 text: 'Design and development of computer hardware and software; software as a service [SaaS]; [...]' search_class_id: 777fe621-5eba-4985-966a-a6720147e7fc image_url: https://web.lawpanel.com/images/firm/logo-lawpanel-white.png notes:

Some extra notes

do_not_create_file: false CreateTrademarkSearch: type: object properties: search_term: type: string description: 'Search terms to perform the search. Max lenght: 250 characters.' classes: type: string format: Search class numbers separated by commas. registry_id: type: string format: Guid search_origin_id: type: string format: Guid example: search_term: lawpanel classes: '42,9' registry_ids: - 783c0667-2884-4d0a-b93b-a6720147e45f - bdbc9579-0462-4449-b7e8-a835017ea7c4 search_origin_id: CreateUser: type: object properties: country_id: type: string email: type: string first_name: type: string language_id: type: string last_name: type: string password: type: string phone_number: type: string reset_password: type: string two_factor_authenticator: type: string user_name: type: string user_role: type: string user_type_id: type: string example: country_id: 3fa600af-5237-477d-badb-a67300008be3 email: albert@genius.com user_name: albert@genius.com first_name: Albert last_name: Einstein language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 password: 'GUj/j8<#0Gxa,ut>' phone_number: '+543875123953' reset_password: 'False' two_factor_authenticator: 'False' user_type_id: '' claims: [ ] CreateWatching: type: object properties: firm_portfolio_id: type: string user_id: type: string frequency_id: type: string sensitivity: type: integer example: firm_portfolio_id: 541fe28f-21f5-40c4-8c15-aad8012ad11c user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 sensitivity: 10 FileClientCreated: type: object properties: id: type: string FilePortfolioCreated: type: object properties: id: type: string FilterDeleteResult: type: object properties: id: type: string message: type: string successful: type: boolean FilterUpdate: type: object properties: id: type: string name: type: string end_point: type: string applied: type: boolean filter_definition: type: object properties: groups: type: array items: required: - expressions - operator_next type: object properties: expressions: type: array items: required: - property_name - comparator - value - operator_next type: object properties: property_name: type: string comparator: type: string value: type: string operator_next: type: string operator_next: type: string example: id: 66c4ef28-2429-46f3-b815-ab870165e520 name: '''law'' in US' end_point: firmportfolio applied: true filter_definition: groups: - expressions: - property_name: registry.id comparator: == value: 783c0667-2884-4d0a-b93b-a6720147e45f operator_next: OR operator_next: AND - expressions: - property_name: mark_text comparator: CONTAINS value: lawpanel operator_next: AND operator_next: AND FilterUpdateResult: type: object properties: id: type: string message: type: string successful: type: boolean ListOfClient: type: array items: required: - id - client - total_users - total_cases type: object properties: id: type: string client: type: object properties: name: type: string company_registration_number: type: string contact_name: type: string contact_email: type: string contact_number: type: string contact_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string billing_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string client_type: type: object properties: id: type: string code: type: integer name: type: string total_users: type: integer total_cases: type: integer CreateFileClient: example: file_id: ad72f2c7-3866-486f-8e98-aa0300c8b9ea client_id: e7e32f0a-9d93-406a-b231-a98f00eabf67 file_client_role_id: 1a0bbe33-d3ce-451b-bc6b-a8ff015d9a7d client_user_id: d48e832b-dc27-4818-9057-a92200be1e31 reference: '' ListOfFilter: type: array items: required: - id - end_point - name - applied - filter_definition type: object properties: id: type: string end_point: type: string name: type: string applied: type: boolean filter_definition: type: object properties: groups: type: array items: required: - expressions - operator_next type: object properties: expressions: type: array items: required: - property_name - comparator - value - operator_next type: object properties: property_name: type: string comparator: type: string value: type: string operator_next: type: string operator_next: type: string LoginDetails: type: object properties: email: type: string password: type: string example: email: test@example.com password: hunter2 FrequencyList: type: array items: required: - id - name - unit_name - years - months - days - hours - minutes - seconds - total_in_seconds type: object properties: id: type: string name: type: string unit_name: type: string years: type: integer months: type: integer days: type: integer hours: type: integer minutes: type: integer seconds: type: integer total_in_seconds: type: integer LegalEntity: type: object properties: id: type: string name: { } company_registration_number: { } contact_name: { } contact_email: { } contact_number: { } contact_address: type: object properties: id: type: string line1: type: string line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: { } billing_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: { } client_type: type: object properties: id: type: string code: type: integer name: type: string ListOfPartRolesOnCases: type: array items: required: - enable - id - code - name - users_can_access_as_clients - users_can_access_as_agents type: object properties: enable: type: boolean id: type: string code: type: integer name: type: string users_can_access_as_clients: type: boolean users_can_access_as_agents: type: boolean ListOfTrademark: type: array items: required: - id - registry_id - registry_name - registry_official_name - registry_description - mark_text - application_number - application_date - registration_number - registration_date - status_date - mark_feature - status - registration_type_id - registration_type_name - trademark_type_id - trademark_type_name - expiry_date - publication_date - declaration_date - office_action_date - grant_date - client_agent_id - client_agent_name - publication_notes - good_and_services - image_url - notes - do_not_create_file - user_id - user_user_name - trademark_url_on_ipo - exclude_from_auto_updates type: object properties: id: type: string registry_id: type: string registry_name: type: string registry_official_name: type: string registry_description: type: string mark_text: type: string application_number: type: string application_date: type: string registration_number: type: string registration_date: type: string status_date: type: string mark_feature: type: string status: type: string registration_type_id: type: string registration_type_name: type: string trademark_type_id: type: string trademark_type_name: type: string expiry_date: type: string publication_date: type: string declaration_date: type: string office_action_date: type: string grant_date: type: string client_agent_id: type: string client_agent_name: type: string publication_notes: type: string good_and_services: type: array items: required: - id - language - search_class - text type: object properties: id: type: string language: type: object properties: id: type: string name: type: string short_name: type: string is_available_for_ui: type: boolean search_class: type: object properties: id: type: string number: type: integer name: type: string description: type: string search_classes: type: string text: type: string image_url: type: string notes: type: string do_not_create_file: type: boolean user_id: type: string user_user_name: type: string trademark_url_on_ipo: { } exclude_from_auto_updates: type: boolean ListOfUsers: type: array items: required: - id - first_name - last_name - user_name - email - phone_number - language_id - language_name - country_id - country_name - user_role - last_login_date - is_locked_out - user_type_id - user_type_name type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: integer last_login_date: type: string is_locked_out: type: boolean user_type_id: { } user_type_name: { } ListOfWatching: type: array items: required: - id - user_id - user_name - sensitivity - firm_portfolio_id - application_number - trademark - classes - registry_id - registry_name - frequency_id - frequency_name - events - created - last_search_date_time - last_notification_date_time type: object properties: id: type: string user_id: type: string user_name: type: string sensitivity: type: integer firm_portfolio_id: type: string application_number: type: string trademark: type: string classes: type: array items: type: string registry_id: type: string registry_name: type: string frequency_id: type: string frequency_name: type: string events: type: array items: { } created: type: string last_search_date_time: type: string last_notification_date_time: { } example: - id: b665ca9e-92b7-444b-b9da-ab4500de7b98 user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 20 firm_portfolio_id: c94a7d6d-83e1-4186-b3fe-a6720147e2a2 application_number: '0303456' trademark: 1LED classes: - '11' registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 registry_name: GB frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly events: [ ] created: '2020-01-17T13:30:02.1027702Z' last_search_date_time: '2020-03-25T01:03:47.8640131Z' last_notification_date_time: - id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 20 firm_portfolio_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d0 application_number: '0303456' trademark: 5ARTH classes: - '20' registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 registry_name: GB frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly events: - id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f|3139581561719999999 unix_time_stamp: 1579741428 application_date: '2020-01-02T00:00:00.0000000+00:00' application_number: UK00003455018 trademark: 5ARTH classes: '20' databases: GB owner_applicant: Lai Feifeng status: Pending good_and_services: '20: desks [furniture], office furniture, furniture, chairs, display stands, [...]' handled: false created: '2020-01-22T12:50:42.5533169Z' last_search_date_time: '2020-03-25T01:03:47.8640131Z' last_notification_date_time: '2020-01-23T01:05:06.9702455Z' - id: 77e51ee3-bd5e-4dd7-99ca-ab44012577f8 user_id: 77e2dd06-154c-4157-ad69-a6720147e652 user_name: admin@lawpanel.io sensitivity: 3 firm_portfolio_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d3 application_number: '201003372' trademark: WINNING MATTERS classes: - '45' - '36' - '41' - '35' registry_id: ae1159e1-77cc-492f-935f-a835017eab71 registry_name: NO frequency_id: 008d4dea-642c-483a-8c57-a6720147e2d2 frequency_name: Bi-Weekly events: [ ] created: '2020-01-16T17:48:29.2109982Z' last_search_date_time: '2020-01-25T01:03:47.8640131Z' last_notification_date_time: - id: dcc1815c-af91-40c5-9cbc-ab4500df4e63 user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 user_name: chapeti+alsina003@gmail.com sensitivity: 20 firm_portfolio_id: application_number: '090978978' trademark: Yun Bey classes: - '9' registry_id: bdbc9579-0462-4449-b7e8-a835017ea7c4 registry_name: GB frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 frequency_name: Weekly events: - id: dcc1815c-af91-40c5-9cbc-ab4500df4e63|3139581561729999999 watching_id: dcc1815c-af91-40c5-9cbc-ab4500df4e63 unix_time_stamp: 1579741427 application_date: '2020-01-07T00:00:00.0000000+00:00' application_number: UK00003455889 trademark: YunBey classes: '9' databases: GB owner_applicant: HUANG WEN WEN status: Pending good_and_services: '9: circular slide rules, slide-rules, counters, egg timers [sandglasses], reflective articles for wear, [...]' handled: false created: '2020-01-17T13:33:01.9800266Z' last_search_date_time: '2020-01-25T01:03:47.8640131Z' last_notification_date_time: '2020-01-23T01:05:07.7045947Z' RegistrationTypeList: type: array items: required: - enable - id - name - code type: object properties: enable: type: boolean id: type: string name: type: string code: type: integer RegistryList: type: array items: required: - id - alternative_names - wipo_code - description - have_data - url_base_for_trademarks - iso_three_letters_country_code - total_trademarks type: object properties: id: type: string wipo_code: type: string description: type: string have_data: type: boolean url_base_for_trademarks: type: string iso_three_letters_country_code: type: string total_trademarks: type: integer SearchClass: type: object properties: id: type: string number: type: integer name: type: string description: type: string search_classes: type: string SearchClassList: type: array items: required: - id - number - name - description type: object properties: id: type: string number: type: integer name: type: string description: type: string example: - id: 2e04d7b7-d681-458f-8a55-a6720147e7fc number: 1 name: Chemical products description: 'Chemicals used in industry, science and photography, as well as in agriculture, horticulture and forestry; unprocessed artificial resins [...]' - id: 5096b33b-2f52-456d-b306-a6720147e7fc number: 2 name: Paint products description: 'Paints, varnishes, lacquers; preservatives against rust and against deterioration of wood; colorants; mordants; raw natural resins; [...]' - id: 777fe621-5eba-4985-966a-a6720147e7fc number: 3 name: Cosmetics and Cleaning Products description: 'Bleaching preparations and other substances for laundry use; cleaning, polishing, scouring and abrasive preparations; soaps; [...]' - id: 46d9c9ae-863a-421d-9c06-a6720147e7fc number: 4 name: Industrial oils description: 'Industrial oils and greases; lubricants; dust absorbing, wetting and binding compositions; fuels and illuminants; candles and wicks for lighting; [...]' - id: 3c69fc1c-f131-4372-b873-a6720147e7fc number: 5 name: Pharmaceutical and veterinary description: 'Pharmaceutical and veterinary preparations; sanitary preparations for medical purposes; dietetic substances adapted for medical use, food for babies; [...]' - id: 9128ca8c-7734-4540-bffb-a6720147e7fc number: 6 name: Metal Products description: 'Common metals and their alloys; metal building materials; transportable buildings of metal; materials of metal for railway tracks; [...]' - id: b8163017-ebe6-4317-93ec-a6720147e7fc number: 7 name: Machinery Products description: 'Machines and machine tools; motors and engines (except for land vehicles); parts of engines and motors; machine coupling and transmission components [...]' - id: 3c98e3db-b305-40d9-b417-a6720147e7fc number: 8 name: Hand Tool Products description: Hand tools and hand operated implements; cutlery; side arms; razors; electric razors and hair cutters. - id: 3d379284-9313-4f3c-b3ba-a6720147e7fc number: 9 name: 'Computer, Electrical & Scientific Products' description: 'Scientific, photographic, cinema, optical, weighing, measuring, apparatus and instruments; switching, transforming, or controlling electricity; [...]' SearchCreated: type: object properties: id: type: string SearchOrigin: type: object properties: id: type: string code: type: integer name: type: string description: type: string SearchOriginList: type: array items: required: - id - code - name - description type: object properties: id: type: string code: type: integer name: type: string description: type: string example: - id: bd57d0f2-0ac2-4c7d-a980-a89500075e3b code: 6 name: Bot description: Represent searchs from one of our IA bot engines. - id: 5b45f41e-9f0d-4d91-b761-a673000392ef code: 5 name: Dashboard description: Represent searchs from our dashboard website. - id: 9c00ba17-ac4f-4de2-9e04-a67300039292 code: 4 name: Web site search description: Represent searchs from web sites. - id: f5d7d692-dab3-4744-9e0b-a67300039236 code: 3 name: iOS app search description: Represent searches from iOS apps. - id: 7c723daa-9d75-433d-848d-a673000391da code: 2 name: Android app search description: Represent searches from Android apps. - id: 49a7eeba-be07-47d5-bad0-a6730003917a code: 1 name: Firm Search Widget description: Represent searches from firm's search widget. - id: ec413954-22a7-499e-a93a-a67300039112 code: 0 name: Unknow source description: Represent searches from non determined sources. TrademarkCreated: type: object properties: id: type: string registry_id: type: string registry_name: type: string registry_official_name: type: string registry_description: type: string mark_text: type: string application_number: type: string application_date: type: string registration_number: type: string registration_date: type: string status_date: type: string mark_feature: type: string status: type: string registration_type_id: type: string registration_type_name: type: string trademark_type_id: type: string trademark_type_name: type: string expiry_date: type: string publication_date: type: string declaration_date: type: string office_action_date: type: string grant_date: type: string client_agent_id: type: string client_agent_name: type: string publication_notes: type: string good_and_services: type: array items: required: - id - language - search_class - text type: object properties: id: type: string language: type: object properties: id: type: string name: type: string short_name: type: string is_available_for_ui: type: boolean search_class: type: object properties: id: type: string number: type: integer name: type: string description: type: string search_classes: type: string text: type: string image_url: type: string notes: type: string do_not_create_file: type: boolean user_id: type: string user_user_name: type: string user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_locked_out: type: boolean claims: type: array items: { } trademark_url_on_ipo: { } exclude_from_auto_updates: type: boolean watching: { } TrademarkFilter: type: array items: required: - property_name - property_type - property_display_name - property_description - comparators_available - multiple - end_point type: object properties: property_name: type: string property_type: type: string property_display_name: type: string property_description: type: string comparators_available: type: array items: type: string multiple: type: boolean end_point: type: string TrademarkSearch: type: object properties: id: type: string search_term: type: string classes: type: string registry_id: { } start_time: type: string end_time: type: string status: type: integer results: type: array items: { } TrademarkSearchDeleteResult: type: object properties: id: type: string message: type: string successful: type: boolean TrademarkSearchFilter: type: array items: required: - property_name - property_type - property_display_name - property_description - comparators_available - multiple - end_point type: object properties: property_name: type: string property_type: type: string property_display_name: type: string property_description: type: string comparators_available: type: array items: type: string multiple: type: boolean end_point: type: string TrademarkSearchSimplifedList: type: array items: required: - enable - id - search_term - classes - registry_id - start_time - end_time - status type: object properties: enable: type: boolean id: type: string search_term: type: string classes: { } registry_id: { } start_time: type: string end_time: type: string status: type: string TrademarkSearchStatus: type: object properties: status: type: integer status_text: type: string TrademarkTypeList: type: array items: required: - id - name - code type: object properties: id: type: string name: type: string code: type: integer TrademarkUpdate: type: object properties: id: type: string registry_id: type: string mark_text: type: string application_number: type: string application_date: type: string registration_number: type: integer registration_date: type: string status_date: type: string mark_feature: type: string status: type: string registration_type_id: type: string trademark_type_id: type: string expiry_date: type: string publication_date: type: string declaration_date: type: string office_action_date: type: string final_office_action_date: type: string grant_date: type: string client_agent_id: type: string publication_notes: type: string good_and_services: type: array items: required: - id - language_id - search_class_id - text type: object properties: id: type: string language_id: type: string search_class_id: type: string text: type: string image_url: type: string notes: type: string example: id: 677eeb82-99f7-4c68-a797-ab8400f6f701 registry_id: 783c0667-2884-4d0a-b93b-a6720147e45f mark_text: LawPanel application_number: '0303456' application_date: '2020-03-17T00:00:00Z' registration_number: 5230966 registration_date: '2020-03-17T00:00:00Z' status_date: '2020-03-17T00:00:00Z' mark_feature: mark status: Valid registration_type_id: 21b28699-8e12-4575-bb65-a99201173ed2 trademark_type_id: 6d374194-9df4-4a26-89dd-a992011744fd expiry_date: '2020-03-17T00:00:00Z' publication_date: '2020-03-17T00:00:00Z' declaration_date: '2020-03-17T00:00:00Z' office_action_date: '2020-03-17T00:00:00Z' final_office_action_date: '' grant_date: '2020-03-17T00:00:00Z' client_agent_id: a1c3e613-c9a5-49c5-91d9-aaaf009c09f1 publication_notes: Notes about publication good_and_services: - id: be4a9eb5-e20c-4f89-9809-ab8400f6f701 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 search_class_id: 5096b33b-2f52-456d-b306-a6720147e7fc text: 'Facilitating, administering, arranging and managing funding in relation to litigation [...]' - id: ae0a84f0-ebd5-4071-bd9e-ab8400f6f701 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 search_class_id: 777fe621-5eba-4985-966a-a6720147e7fc text: 'Design and development of computer hardware and software; software as a service [SaaS]; [...]' image_url: https://web.lawpanel.com/images/firm/logo-lawpanel-white.png notes:

Some extra notes

TrademarkUpdateResult: type: object properties: id: type: string message: type: string successful: type: boolean UpdateFeeItem: type: object properties: id: type: string product_name: type: string currency_id: type: string product_code: type: string product_name_public: type: string value: type: integer taxes: type: array items: required: - id type: object properties: id: type: string example: id: 69fdfe98-b0bc-447d-b760-aba8002d58f8 country_id: 3fa874af-5237-477d-badb-a67300008be3 email: bro@ther.com user_name: bro@ther.com first_name: Bro last_name: Ther language_id: 8246c1d0-b478-4320-8b1d-a6720147de22 password: '}D`WZN''OxlC307<[' phone_number: '+543875333953' user_type_id: '' claims_id: - 7c4fcc3e-1370-4efe-a2f5-a873002668dd UserTypeList: type: array items: required: - id - name - code type: object properties: id: type: string name: type: string code: type: integer WatchingFilter: type: array items: required: - property_name - property_type - property_display_name - property_description - comparators_available - multiple - end_point type: object properties: property_name: type: string property_type: type: string property_display_name: type: string property_description: type: string comparators_available: type: array items: type: string multiple: type: boolean end_point: type: string WatchingUpdate: type: object properties: id: type: string firm_portfolio_id: type: string user_id: type: string frequency_id: type: string sensitivity: type: integer example: id: 7ba96a95-6ae3-4cdd-a860-ab4a00d3ae7f firm_portfolio_id: 605366ae-6ba7-4f0c-acc4-ab4a00d38883 user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 frequency_id: c94a7d6d-83e1-4186-b3fe-a6720147e2d2 sensitivity: 20 WatchingUpdateResult: type: object properties: id: type: string message: type: string successful: type: boolean RegistrationType: type: object properties: id: type: string name: type: string code: type: integer TrademarkType: type: object properties: id: type: string name: type: string code: type: integer UserType: type: object properties: id: type: string name: type: string code: type: integer GetByIdsParam: type: array items: type: integer example: '[424804,424805]' FeeItemBundleReadParametersParam: type: object properties: public_name: type: string example: public_name: UK FeeItemBundleReadByParametersParam: type: object properties: public_name: type: string param_and_values: type: array items: required: - name - value type: object properties: name: type: string value: type: string example: public_name: Usa param_and_values: - name: Registers value: uspto - name: N° Classes value: '1' CreateCompany: type: object properties: client: type: object properties: name: type: string company_registration_number: type: string contact_name: type: string contact_email: type: string contact_number: type: string contact_address: type: object properties: line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string billing_address: type: object properties: line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string client_type_id: type: string example: client: name: Name of the Company company_registration_number: Registration Number contact_name: Contact name contact_email: contact@email.com contact_number: '+5493875333953' contact_address: line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 billing_address: line1: Dr. Adolfo Alsina 151 line2: '-' line3: '-' building: Torres de Alsina floor_level: 2nd postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 4576b6bc-936c-4879-a03c-a68900ad3722 client_type_id: 0a246949-d71d-49ae-a17b-a975001bdf45 CreateCompanyResponse: type: object properties: id: type: string name: type: string company_registration_number: type: string contact_name: type: string contact_email: type: string contact_number: type: string contact_address: type: object properties: enable: type: boolean id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: type: string billing_address: type: object properties: enable: type: boolean id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: type: string client_type: type: object properties: id: type: string code: type: integer name: type: string CurrencyList: type: array items: required: - id - name - name_short - symbol - enable type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string Currency: type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string TaxList: type: array items: required: - id - name - description - units - percent type: object properties: id: type: string name: type: string description: type: string units: type: integer percent: type: integer Tax: type: object properties: id: type: string name: type: string description: type: string units: type: integer percent: type: integer CountryList: type: array items: required: - id - name - short_name - weight_order type: object properties: id: type: string name: type: string short_name: type: string weight_order: type: integer LanguageList: type: array items: required: - id - name - short_name - is_available_for_ui type: object properties: id: type: string name: type: string short_name: type: string is_available_for_ui: type: boolean LanguageFilter: type: array items: required: - property_name - property_type - property_display_name - property_description - comparators_available - multiple - end_point type: object properties: property_name: type: string property_type: type: string property_display_name: type: string property_description: type: string comparators_available: type: array items: type: string multiple: type: boolean end_point: type: string CreateFeeItem: type: object properties: invoice_entity_id: type: string invoice_entity_type: type: string code: type: string name: type: string details: type: string currency_id: type: string quantity: type: integer currency_units: type: integer taxes: type: array items: type: string example: invoice_entity_id: 53620e77-5e3b-431b-9cb0-ac2800eaac75 invoice_entity_type: File code: '001' name: Item 001 details: This is a fee item for a Case currency_id: 14e294cf-7425-422f-83f2-a6b20003f5e3 quantity: 1 currency_units: 100 taxes: - 1db77783-9e48-4ddc-a665-a6b4002671c1 CreateInvoiceItemResponse: type: object properties: id: type: string code: type: string name: type: string product_type: type: object properties: id: type: string name: type: string currency: type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string currency_units: type: integer quantity: type: integer taxes: type: array items: required: - id - name - description - units - percent type: object properties: id: type: string name: type: string description: type: string units: type: integer percent: type: integer details: type: string paid_out: type: boolean invoice_entity_type: type: string invoice_entity_id: type: string FileAddNote: type: object properties: note: type: string send_communication: type: string communication_channel_id: type: string example: note:

Hello!

I am a note into the File.

send_communication: 'false' communication_channel_id: ICommunicationChannelEmail ReadManyCaseResponse: type: array items: required: - id - name - client - file_status_id - file_status_name - owner - other_supervisors - updated_at - payment_status - updated_by - tags - number - file_template - active type: object properties: id: type: string name: type: string client: type: object properties: id: type: string name: type: string company_registration_number: { } contact_name: type: string contact_email: type: string contact_number: { } contact_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: type: string billing_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: type: string client_type: type: string file_status_id: type: string file_status_name: type: string owner: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string other_supervisors: type: array items: required: - id - first_name - last_name - user_name - email - phone_number - language_id - language_name - country_id - country_name type: object properties: id: type: string first_name: type: string last_name: type: string user_name: { } email: { } phone_number: { } language_id: { } language_name: { } country_id: type: string country_name: type: string updated_at: type: string payment_status: type: string updated_by: type: string tags: type: array items: { } number: type: string file_template: type: object properties: id: type: string name: type: string file_template_components: type: array items: required: - id - name - description - definition - definition_type - entity_type - permissions - required - regex_to_validate - multiple_values - display_order - value_type type: object properties: id: type: string name: type: string description: type: string definition: { } definition_type: { } entity_type: type: string permissions: type: array items: { } required: type: boolean regex_to_validate: { } multiple_values: type: boolean display_order: type: integer value_type: { } is_base: type: boolean is_template_for_trademark_filing: type: boolean is_template_filing: type: boolean base_id: type: string ip_records: type: array items: { } active: type: boolean ReadCase: type: object properties: id: type: string name: type: string number: type: string folder: type: object properties: id: type: string name: type: string files: type: array items: required: - id - name - number - folder - tags - other_supervisors - client - user - file_status - file_template - components - created_by - updated_at - updated_by - firm_portfolio - active type: object properties: id: type: string name: type: string number: type: string folder: { } tags: type: array items: { } other_supervisors: type: array items: required: - id - first_name - last_name - user_name - email - phone_number - language_id - language_name - country_id - country_name type: object properties: id: type: string first_name: type: string last_name: type: string user_name: { } email: { } phone_number: { } language_id: { } language_name: { } country_id: type: string country_name: type: string client: type: object properties: id: type: string name: type: string company_registration_number: { } contact_name: type: string contact_email: type: string contact_number: { } contact_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: type: string billing_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: type: string client_type: type: string user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string file_status: type: object properties: id: type: string name: type: string initial_state: type: boolean file_template: type: object properties: id: type: string name: type: string file_template_components: type: array items: required: - id - name - description - definition - definition_type - entity_type - permissions - required - regex_to_validate - multiple_values - display_order - value_type type: object properties: id: type: string name: type: string description: type: string definition: { } definition_type: { } entity_type: type: string permissions: type: array items: { } required: type: boolean regex_to_validate: { } multiple_values: type: boolean display_order: type: integer value_type: { } is_base: type: boolean is_template_for_trademark_filing: type: boolean is_template_filing: type: boolean base_id: type: string ip_records: type: array items: { } components: { } created_by: type: string updated_at: type: string updated_by: type: string firm_portfolio: { } active: type: boolean tags: type: array items: { } other_supervisors: type: array items: required: - id - first_name - last_name - user_name - email - phone_number - language_id - language_name - country_id - country_name type: object properties: id: type: string first_name: type: string last_name: type: string user_name: { } email: { } phone_number: { } language_id: { } language_name: { } country_id: type: string country_name: type: string client: type: object properties: id: type: string name: type: string company_registration_number: { } contact_name: type: string contact_email: type: string contact_number: { } contact_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: { } billing_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: type: string client_type: { } user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string file_status: type: object properties: id: type: string name: type: string initial_state: type: boolean file_template: type: object properties: id: type: string name: type: string file_template_components: type: array items: required: - id - name - description - definition - definition_type - entity_type - permissions - required - regex_to_validate - multiple_values - display_order - value_type type: object properties: id: type: string name: type: string description: type: string definition: { } definition_type: { } entity_type: type: string permissions: type: array items: { } required: type: boolean regex_to_validate: { } multiple_values: type: boolean display_order: type: integer value_type: { } is_base: type: boolean is_template_for_trademark_filing: type: boolean is_template_filing: type: boolean base_id: type: string ip_records: type: array items: { } components: type: array items: { } created_by: type: string updated_at: type: string updated_by: type: string active: type: boolean ReadManyFilePortfolioRole: type: array items: required: - enable - id - code - name - is_own type: object properties: enable: type: boolean id: type: string code: type: integer name: type: string is_own: type: boolean CreateInvoice: type: object properties: invoice_items_ids: type: array items: type: string client_id: type: string date_time: type: integer date_time_due: type: integer invoice_type_id: type: string invoice_number: type: integer observations: type: string example: invoice_items_ids: - ce30d5d7-1ce9-498e-a386-ac31015949f1 client_id: 1c71c9bd-0603-4e95-8596-abb400efe5f3 date_time: 1599609600 date_time_due: 1599609600 invoice_type_id: de08d07a-b45b-4c53-8622-a7ec017b5dc1 invoice_number: 1 observations: Invoice notes InvoiceTypeReadManyResponse: type: array items: required: - id - name - code - description - leading_zeros - prefix type: object properties: id: type: string name: type: string code: type: integer description: type: string leading_zeros: type: string prefix: { } DeleteCompany: type: object properties: id: type: string message: type: string successful: type: boolean CreateCaseAttachment: type: object properties: comments: type: string file_id: type: string file_name: type: string url: type: string file_size: type: string example: comments: .... file_id: f71b5be6-5721-4aca-bede-abab0002dde2 file_name: image3.jpg url: https://image3 file_size: '125' DeleteCaseAttachment: type: object properties: id: type: string message: type: string successful: type: boolean ReadCaseAttachment: type: object properties: enable: type: boolean id: type: string file: type: object properties: id: type: string name: type: string number: type: string date_time: type: string file_name: type: string file_size: type: integer comments: type: string url: type: string ReadManyCaseAttachment: type: array items: required: - id - file - date_time - file_name - file_size - comments - url - user type: object properties: id: type: string file: type: object properties: id: type: string name: type: string number: type: string folder: { } tags: type: array items: required: - id - name - color_text - color_background - parent type: object properties: id: type: string name: type: string color_text: type: string color_background: type: string parent: { } other_supervisors: { } client: { } user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_yoti: type: boolean is_locked_out: type: boolean yoti_id: { } user_settings: { } claims: type: array items: { } user_type_id: type: string user_type_name: { } file_status: type: object properties: id: type: string name: type: string initial_state: type: boolean file_template: type: object properties: id: type: string name: type: string file_template_components: type: array items: required: - id - name - description - definition - definition_type - entity_type - permissions - required - regex_to_validate - multiple_values - display_order - value_type type: object properties: id: type: string name: type: string description: type: string definition: { } definition_type: { } entity_type: type: string permissions: type: array items: { } required: type: boolean regex_to_validate: { } multiple_values: type: boolean display_order: type: integer value_type: { } is_base: type: boolean is_template_for_trademark_filing: type: boolean is_template_filing: type: boolean base_id: type: string ip_records: type: array items: { } components: { } created_by: type: string updated_at: type: string updated_by: type: string firm_portfolio: { } active: type: boolean date_time: type: string file_name: type: string file_size: type: integer comments: type: string url: type: string user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_yoti: type: boolean is_locked_out: type: boolean yoti_id: { } user_settings: { } claims: type: array items: { } user_type_id: type: string user_type_name: { } ResponseCaseAttachment: type: object properties: id: type: string file_id: type: string date_time: type: string file_name: type: string file_size: type: integer comments: type: string url: type: string user_id: type: string CreateCaseLink: type: object properties: comments: type: string file_id: type: string url: type: string example: comments: ... file_id: c8650a60-cc9e-476c-bed9-ac3100f3db50 url: https://www.lawpanel.com ReadCaseLink: type: object properties: id: type: string file: type: object properties: id: type: string name: type: string number: type: string date_time: type: string comments: type: string url: type: string ReadManyCaseLink: type: array items: required: - id - file - date_time - comments - url type: object properties: id: type: string file: type: object properties: id: type: string name: type: string number: type: string date_time: type: string comments: type: string url: type: string DeleteCaseLink: type: object properties: id: type: string message: type: string successful: type: boolean ResponseCaseLink: type: object properties: id: type: string file: type: object properties: id: type: string name: type: string number: type: string date_time: type: string comments: type: string url: type: string PaymentProviderReadManyResponse: type: array items: required: - id - name - description - url - implementation - is_default type: object properties: id: type: string name: type: string description: type: string url: type: string implementation: { } is_default: type: boolean PaymentMethodReadManyResponse: type: array items: required: - id - code - name - description - payment_method_component_definitions - reusable type: object properties: id: type: string code: type: integer name: type: string description: type: string payment_method_component_definitions: type: array items: required: - id - payment_method - name - display_name - class_name - pattern - mask - required - select_from - disabled - max - max_length - min - read_only - step - place_holder - private - internal - display_order type: object properties: id: type: string name: type: string display_name: type: string class_name: type: string pattern: type: string mask: { } required: type: boolean select_from: { } disabled: type: boolean max: { } max_length: type: integer min: { } read_only: type: boolean step: { } place_holder: { } private: type: boolean internal: type: boolean display_order: type: integer reusable: type: boolean example: - id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 code: 1 name: Credit Card description: A credit card is a payment card issued to users (cardholders) to enable the cardholder to pay a merchant for goods and services. payment_method_component_definitions: - id: 7a3b5edd-b20e-499a-aeaa-a7e8000a2ccd name: card_name display_name: Name class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 1 - id: c1138c80-0ee2-4f67-b2da-a7cc00ffc389 name: address_line_one display_name: Address line one class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 2 - id: c1837a7a-3cc0-42ac-ad0d-a7cc00ffc504 name: address_line_two display_name: Address line two class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 3 - id: 3339089b-4535-4ec1-a9b9-a7e8000a3451 name: address_city display_name: City class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 4 - id: 136678f3-6827-4ea9-9a02-a7e8000a3748 name: address_state display_name: State class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 5 - id: 8f298718-3d17-450f-8871-a7e8000a3abc name: address_zip display_name: Zip class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 6 - id: 3bd795ba-adff-45af-8b2f-a7e8000a3cc3 name: address_country display_name: Country class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 254 min: read_only: false step: place_holder: private: false internal: false display_order: 7 - id: 2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6 name: observations display_name: Observations class_name: String pattern: '' mask: required: false select_from: disabled: false max: max_length: 1024 min: read_only: false step: place_holder: private: false internal: false display_order: 8 reusable: true - id: 0b655e83-d46f-432c-80d2-a7cc00ffd4d9 code: 2 name: Bank transfer description: 'Wire transfer, bank transfer or credit transfer is a method of electronic funds transfer from one person or entity to another.' payment_method_component_definitions: - id: b4a59072-0997-464f-a91a-a7e8000a41b8 name: transfer_date display_name: Transfer date class_name: DateTime pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 0 - id: daac72de-87c7-41db-91a4-a7e8000a4426 name: from_bank_name display_name: From bank class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 1 - id: a76af918-047e-4db6-80ad-a7e8000a46a9 name: from_account_number display_name: From account class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 2 - id: 0d6c92ad-3984-4536-b008-a7e8000a4929 name: account_owner display_name: Account owner class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 3 - id: 28d552f1-b005-4442-86bd-a7e8000a4b32 name: to_bank_name display_name: To bank class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 4 - id: b2cc3edb-4fdb-4d74-9e8e-a7e8000a4d3f name: to_account_number display_name: To account class_name: String pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 5 reusable: false - id: cc6120a1-b639-4746-8fa7-a86401891b45 code: 3 name: Other description: 'Other mechanism to receive payments. Manually, etc.' payment_method_component_definitions: - id: 617309ec-3d1c-46bb-b233-a86401891cc9 name: date display_name: Date class_name: DateTime pattern: '' mask: required: true select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 0 - id: edda0df3-8d47-47f7-b45a-a86401891ed1 name: comments display_name: Comments class_name: BigString pattern: '' mask: required: false select_from: disabled: false max: max_length: min: read_only: false step: place_holder: private: false internal: false display_order: 1 reusable: false PaymentMethodReadResponse: type: object properties: enable: type: boolean id: type: string code: type: integer name: type: string description: type: string payment_method_component_definitions: type: array items: required: - enable - id - payment_method - name - display_name - class_name - pattern - mask - required - select_from - disabled - max - max_length - min - read_only - step - place_holder - private - internal - display_order type: object properties: enable: type: boolean id: type: string payment_method: type: object properties: enable: type: boolean id: type: string code: type: integer name: type: string description: type: string payment_method_component_definitions: { } reusable: type: boolean name: type: string display_name: type: string class_name: type: string pattern: type: string mask: { } required: type: boolean select_from: { } disabled: type: boolean max: { } max_length: type: integer min: { } read_only: type: boolean step: { } place_holder: { } private: type: boolean internal: type: boolean display_order: type: integer reusable: type: boolean CreatePaymentResponse: type: object properties: id: type: string date_time: type: string payment_provider: type: object properties: id: type: string name: type: string description: type: string url: type: string implementation: type: string is_default: type: boolean payment_method: type: object properties: id: type: string code: type: integer name: type: string description: type: string payment_method_component_definitions: type: array items: required: - id - name - display_name - class_name - pattern - mask - required - select_from - disabled - max - max_length - min - read_only - step - place_holder - private - internal - display_order type: object properties: id: type: string name: type: string display_name: type: string class_name: type: string pattern: type: string mask: { } required: type: boolean select_from: { } disabled: type: boolean max: { } max_length: type: integer min: { } read_only: type: boolean step: { } place_holder: { } private: type: boolean internal: type: boolean display_order: type: integer reusable: type: boolean payment_method_details: type: string payment_method_component_instances: type: array items: required: - id - payment_method_component_definition - value type: object properties: id: type: string payment_method_component_definition: type: object properties: id: type: string name: type: string display_name: type: string class_name: type: string pattern: type: string mask: { } required: type: boolean select_from: { } disabled: type: boolean max: { } max_length: type: integer min: { } read_only: type: boolean step: { } place_holder: { } private: type: boolean internal: type: boolean display_order: type: integer value: type: string payment_status: type: object properties: id: type: string code: type: integer name: type: string description: type: string currency: type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string currency_units: type: integer payment_status_payment_transaction_types: type: array items: required: - id - payment_status - payment_transaction_type - payment_method_type - payment_amount type: object properties: id: type: string payment_status: type: object properties: id: type: string code: type: integer name: type: string description: type: string payment_transaction_type: type: object properties: id: type: string code: type: integer name: type: string description: type: string payment_method_type: type: string payment_amount: { } payment_transactions: type: array items: required: - id - payment_id - date_time - payment_transaction_status - payment_transaction_type - response - notes - payment_provider_transaction_id - amount type: object properties: id: type: string payment_id: type: string date_time: type: integer payment_transaction_status: type: object properties: id: type: string code: type: integer name: type: string description: type: string payment_transaction_type: type: object properties: id: type: string code: type: integer name: type: string description: type: string response: type: string notes: { } payment_provider_transaction_id: type: string amount: type: integer payment_provider_entity_id: type: string ReadManyInvoiceResponse: type: array items: required: - id - date_time - date_time_due - invoice_type - invoice_number - client - total_invoice_items - total_payments - user - currency - observations type: object properties: id: type: string date_time: type: string date_time_due: type: string invoice_type: type: object properties: id: type: string name: type: string code: type: integer description: type: string leading_zeros: type: string prefix: type: string invoice_number: type: integer client: type: object properties: id: type: string name: type: string company_registration_number: type: string contact_name: type: string contact_email: type: string contact_number: type: string contact_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: type: string billing_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: type: string client_type: type: object properties: id: type: string code: type: integer name: type: string total_invoice_items: type: integer total_payments: type: integer user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_locked_out: type: boolean user_settings: { } claims: type: array items: { } currency: type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string observations: type: string ReadInvoiceResponse: type: object properties: id: type: string date_time: type: string date_time_due: type: string invoice_type: type: object properties: id: type: string name: type: string code: type: integer description: type: string leading_zeros: type: string prefix: type: string invoice_number: type: integer client: type: object properties: id: type: string name: type: string company_registration_number: type: string contact_name: type: string contact_email: type: string contact_number: type: string contact_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: type: string billing_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: type: string client_type: type: object properties: id: type: string code: type: integer name: type: string invoice_items: type: array items: required: - id - code - name - product_type - currency - currency_units - quantity - taxes - details - paid_out - invoice_entity_type - invoice_entity_id type: object properties: id: type: string code: type: string name: type: string product_type: type: object properties: enable: type: boolean id: type: string name: type: string currency: type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string currency_units: type: integer quantity: type: integer taxes: type: array items: required: - id - name - description - units - percent type: object properties: id: type: string name: type: string description: type: string units: type: integer percent: type: integer details: type: string paid_out: type: boolean invoice_entity_type: type: string invoice_entity_id: type: string payments: type: array user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_yoti: type: boolean is_locked_out: type: boolean yoti_id: { } user_settings: { } claims: type: array user_type_id: type: string user_type_name: { } observations: type: string InvoiceItemReadManyResponse: type: array items: required: - id - code - name - product_type - currency - currency_units - quantity - taxes - details - total - invoice - invoice_entity_type - invoice_entity_id - invoice_entity_text type: object properties: id: type: string code: type: string name: type: string product_type: type: object properties: id: type: string name: type: string currency: type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string currency_units: type: integer quantity: type: integer taxes: type: integer details: type: string total: type: integer invoice: type: object properties: id: type: string date_time: type: string date_time_due: type: string invoice_type: type: object properties: id: type: string name: type: string code: type: integer description: type: string leading_zeros: type: string prefix: type: string invoice_number: type: integer client: type: object properties: id: type: string name: type: string company_registration_number: { } contact_name: { } contact_email: { } contact_number: { } contact_address: type: object properties: id: type: string line1: type: string line2: { } line3: { } building: { } floor_level: { } postal_code: type: string city: type: string state_province: { } region: { } country_id: type: string country_name: { } billing_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: { } client_type: type: object properties: id: type: string code: type: integer name: type: string invoice_items: type: array items: required: - id - code - name - product_type - currency - currency_units - quantity - taxes - details - paid_out - invoice_entity_type - invoice_entity_id type: object properties: id: type: string code: type: string name: type: string product_type: type: object properties: id: type: string name: type: string currency: type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string currency_units: type: integer quantity: type: integer taxes: type: array items: required: - id - name - description - units - percent type: object properties: id: type: string name: type: string description: type: string units: type: integer percent: type: integer details: type: string paid_out: type: boolean invoice_entity_type: type: string invoice_entity_id: type: string payments: type: array items: { } user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_locked_out: type: boolean user_settings: { } claims: type: array items: { } user_type_id: type: string user_type_name: { } observations: type: string invoice_entity_type: type: string invoice_entity_id: type: string invoice_entity_text: { } PaymentCreate: type: object properties: invoice_id: type: string description: type: string payment_provider_id: type: string payment_method_id: type: string payment_method_components: type: array items: required: - name - value type: object properties: name: type: string value: type: string currency_units: type: string capture: type: boolean save_current_payment_method_data: type: boolean impact_on_payment_provider: type: boolean example: invoice_id: ab88a885-f937-4ce8-9f5d-ac3100f0cb9e description: A little description for the payment. This is a sample of a payment created with a credit card. payment_provider_id: b9fcbbd8-f584-4e44-bf28-a7cc00ffed97 payment_method_id: 9fca11c1-bad6-4a14-bd96-a7cc00ffbdf4 payment_method_components: - name: payment_provider_token value: tok_1HPug6BekBiB2yVLoh0mrG66 - name: card_name value: Johann Sebastian Bach - name: address_line_one value: Frauenplan 21 - name: address_line_two value: '' - name: address_city value: Eisenach - name: address_state value: Thuringia - name: address_zip value: '' - name: address_country value: Germany - name: observations value: '' currency_units: '11.00' capture: true save_current_payment_method_data: true impact_on_payment_provider: true CaseStatusReadManyResponse: type: array items: required: - id - name - initial_state type: object properties: id: type: string name: type: string initial_state: type: boolean TagReadManyResponse: type: array items: required: - id - name - color_text - color_background - parent - files_count type: object properties: id: type: string name: type: string color_text: type: string color_background: type: string parent: { } files_count: type: integer CreateTag: type: object properties: name: type: string color_text: type: string color_background: type: string parent_id: type: string example: name: Tag D color_text: '#02404c' color_background: '#e2ebed' parent_id: '' CreateTagResponse: type: object properties: id: type: string name: type: string color_text: type: string color_background: type: string parent: { } UpdateCase: type: object properties: id: type: string name: type: string file_status_id: type: string file_client_id: { } tags: type: array items: type: string other_supervisors: type: array items: type: string user_id: type: string number: type: string components: type: array items: required: - id - file_template_component_id - entity_id - value type: object properties: file_template_component_id: type: string entity_id: type: string value: type: string active: type: string example: id: 53d2d270-4129-4a86-9123-ab4500df3da4 name: Yun Bey file_status_id: dbb513aa-58e3-4a70-a805-a74c00714768 file_client_id: tags: - da599d0b-1010-45ca-8ced-ac3600c3c1c7 - ' 5c9ced5e-c6c5-4dee-8fed-ac3600c3ca09' other_supervisors: - 03ce7827-aac0-477d-a01b-aad8012abc99 user_id: 03ce7827-aac0-477d-a01b-aad8012abc99 number: '0303456' components: - file_template_component_id: 03f91a9b-fa22-4e3f-b95d-aad8012abc45 entity_id: 00000000-0000-0000-0000-000000000000 value: Common Law Mark - file_template_component_id: 27cd665d-084b-45d2-a8dc-aad8012abc45 entity_id: 00000000-0000-0000-0000-000000000000 value: Opposed - file_template_component_id: 67d2da70-62ef-4a31-a665-aad8012abc45 entity_id: 00000000-0000-0000-0000-000000000000 value: '2020-09-14T00:00:00Z' - file_template_component_id: 78a1df77-bf30-4439-8dc7-aad8012abc4e entity_id: 00000000-0000-0000-0000-000000000000 value: This is the content for the property "Information" active: 'true' CaseTemplateReadResponse: type: object properties: id: type: string name: type: string file_template_components: type: array items: required: - id - name - description - definition - definition_type - entity_type - permissions - required - regex_to_validate - multiple_values - display_order - value_type type: object properties: id: type: string name: type: string description: type: string definition: type: string definition_type: type: string entity_type: type: string permissions: { } required: type: boolean regex_to_validate: { } multiple_values: type: boolean display_order: type: integer value_type: { } is_base: type: boolean is_template_for_trademark_filing: type: boolean is_template_filing: type: boolean base_id: type: string ip_records: type: array items: required: - id - code - name - human_readable_name - value type: object properties: id: type: string code: type: integer name: type: string human_readable_name: type: string value: type: string CompanyUserReadManyResponse: type: array items: required: - id - client - user type: object properties: id: type: string client: type: object properties: id: type: string name: type: string company_registration_number: { } contact_name: { } contact_email: { } contact_number: { } contact_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: { } billing_address: type: object properties: id: type: string line1: { } line2: { } line3: { } building: { } floor_level: { } postal_code: { } city: { } state_province: { } region: { } country_id: type: string country_name: { } client_type: type: object properties: id: type: string code: type: integer name: type: string user: type: object properties: id: type: string first_name: { } last_name: { } user_name: type: string email: type: string phone_number: { } language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: { } is_locked_out: type: boolean yoti_id: { } user_settings: { } user_type_id: type: string user_type_name: { } CreateOrderResponse: type: object properties: id: type: string success: type: boolean message: type: string url_to_redirect: type: string IsEmailAvailableToCreateOrderResponse: type: object properties: available: type: boolean message: type: string CompanyUserCreate: type: object properties: client_id: type: string user: type: object properties: user_name: type: string email: type: string password: type: string first_name: type: string last_name: type: string phone_number: type: string is_email_confirmed: type: boolean user_role: type: integer example: client_id: 1c8a8cf8-a58a-46b8-a172-ab440147061f user: user_name: user@domain.com email: user@domain.com password: '123456' first_name: John last_name: Doe phone_number: '+543875333953' is_email_confirmed: true user_role: 2 UpdateUser: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string password: type: string phone_number: type: string language_id: type: string country_id: type: string example: id: 52d3a0c6-8157-4b0b-b485-ac5a00bef873 first_name: Sebastian last_name: Guerrero user_name: client_email@domain.com email: client_email@domain.com password: '1234567' phone_number: 387-155 333 953 language_id: 8246c1d0-b008-4320-8b1d-a6720147de22 country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 IsEmailAvailableToCreateCompanyUser: type: object properties: available: type: boolean message: type: string GetMyDetailsResponse: type: object properties: user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_locked_out: type: boolean user_settings: type: object properties: urls_without_help_message: { } first_page_to_show: { } send_public_note_to_client: type: boolean claims: type: array firm: type: object properties: id: type: string name: type: string firm_settings: type: object properties: id: type: string header_logo_url: type: string secondary_logo_url: type: string header_color_left: type: string header_color_right: type: string hide_firm_name_on_header: type: boolean tenant_name: type: string email: { } phone_number: { } payment_provider: { } payment_provider_publishable_api_key: { } ReadManyCaseEvent: type: array items: required: - file_id - folder_id - user_id - firm_id - client_id - id - date_time - event_type - by - by_id - comments type: object properties: file_id: type: string folder_id: type: string user_id: type: string firm_id: type: string client_id: type: string id: type: string date_time: type: string event_type: type: string by: type: string by_id: type: string comments: type: string UpdateCompany: type: object properties: client: type: object properties: id: type: string name: type: string company_registration_number: type: string contact_name: type: string contact_email: type: string contact_number: type: string contact_address: type: object properties: line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string billing_address: type: object properties: line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string client_type_id: type: string example: client: id: 08053072-6b7a-4938-90d8-aad8012ad39e name: International Association for the Intellectual Property company_registration_number: '0303456' contact_name: John Doe contact_email: john@doe.com contact_number: '+543875333953' contact_address: line1: Los Crespones line2: '749' line3: Tres Cerritos building: Planta Baja floor_level: '-' postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 billing_address: line1: Alsina line2: '151' line3: Centro building: Torre A floor_level: '2' postal_code: '4400' city: Salta Capital state_province: Salta region: Noroeste Argentino country_id: 27cb8e50-0e8b-40cd-a656-a6720147e0a1 client_type_id: 604a3d85-5c5b-4364-b69c-a99201175b30 UpdateCompanyResponse: type: object properties: id: type: string message: type: string successful: type: boolean ReadManyCompanyUser: type: array items: required: - id - client - user - claims_id type: object properties: id: type: string client: type: object properties: id: type: string name: type: string company_registration_number: type: string contact_name: type: string contact_email: type: string contact_number: type: string contact_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: { } billing_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: { } client_type: type: object properties: id: type: string code: type: integer name: type: string user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: { } is_locked_out: type: boolean user_settings: { } claims: type: array user_type_id: type: string user_type_name: { } claims_id: type: array CompanyUserUpdate: type: object properties: id: type: string client_id: type: string user: type: object properties: id: type: string user_name: type: string email: type: string password: type: string first_name: type: string last_name: type: string phone_number: type: string claims_id: type: array example: id: 4d70a45d-a507-4ceb-94df-ac5a00bef87d client_id: 08053072-6b7a-4938-90d8-aad8012ad39e user: id: 52d3a0c6-8157-4b0b-b485-ac5a00bef873 user_name: chapeti+client_alsina_001@gmail.com email: chapeti+client_alsina_001@gmail.com password: '********' first_name: Sebastian last_name: Guerrero phone_number: 387-155 333 953 claims_id: [ ] ReadManyClaim: type: array items: required: - id - claim_target - code - name - description type: object properties: id: type: string claim_target: type: object properties: id: type: string code: type: integer name: type: string description: type: string code: type: integer name: type: string description: type: string ReadManyInvoiceOutstandingResponse: type: array items: required: - id - date_time - date_time_due - invoice_type - invoice_number - client - total_invoice_items - total_payments - user - currency - observations type: object properties: id: type: string date_time: type: string date_time_due: type: string invoice_type: type: object properties: id: type: string name: type: string code: type: integer description: type: string leading_zeros: type: string prefix: type: string invoice_number: type: integer client: type: object properties: id: type: string name: type: string company_registration_number: type: string contact_name: type: string contact_email: type: string contact_number: type: string contact_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: type: string billing_address: type: object properties: id: type: string line1: type: string line2: type: string line3: type: string building: type: string floor_level: type: string postal_code: type: string city: type: string state_province: type: string region: type: string country_id: type: string country_name: type: string client_type: type: object properties: id: type: string code: type: integer name: type: string total_invoice_items: type: integer total_payments: type: integer user: type: object properties: id: type: string first_name: type: string last_name: type: string user_name: type: string email: type: string phone_number: type: string language_id: type: string language_name: type: string country_id: type: string country_name: type: string user_role: type: string last_login_date: type: string is_yoti: type: boolean is_locked_out: type: boolean yoti_id: { } user_settings: { } claims: type: array user_type_id: type: string user_type_name: { } currency: type: object properties: id: type: string name: type: string name_short: type: string symbol: type: string observations: type: string CreateOrder: type: object properties: order_name: type: string order_number: type: string company_name: type: string company_user_email: type: string company_user_password: type: string file_template_id: type: string file_template_components: type: array items: required: - name - value type: object properties: name: type: string value: type: string payment_currency_id: type: string payment_items: type: array items: required: - description - amount - tax_id type: object properties: description: type: string amount: type: integer tax_id: type: string do_not_create_payment: type: boolean example: order_name: Order for trademark search "lawpanel". order_number: '1' company_name: Michael Jackson company_user_email: michael@jackson.com company_user_password: mj2020_ file_template_id: 96C4A417-7A0A-4241-AE84-AC3D011C40C8 file_template_components: - name: Search result value: 432db66d-467c-4835-bac6-ac3d00fa3af6 - name: Good and services value: Good and services contents - name: Website value: https://www.site.com - name: Are you already using the name value: 1 - 3 years - name: Series value: '{"option_id_selected":"PartOfSeriesTrademark","description":"This is the content for Series, second option selected with a description."}' - name: Previously registered value: '{"option_id_selected":"PreviouslyRegistered","description":"This is the contents for ''Previously registered'', second option."}' - name: SMS Notifications value: '{"selected":true,"description":"+5493875333953"}' - name: Order folder value: Abandoned - name: Order status value: On hold awaiting client - name: Country value: Argentina payment_currency_id: 95CE88B2-3229-4DD7-A35A-A6B20003F63B payment_items: - description: Registration fees 1 trademark on UK amount: 100 tax_id: 1DB77783-9E48-4DDC-A665-A6B4002671C1 - description: Our fees amount: 30 tax_id: do_not_create_payment: true UploaderUploadFileResponse: type: object properties: id: type: string url: type: string size: type: integer name: type: string ext: type: string mime_type: type: string securitySchemes: apiKeyHeader: type: apiKey name: subscription-key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ]