Return the details on the IPO for the trademark selected.
\n{ "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
Identify you at user level and returns the authentication cookie .Lawpanel.AuthCookie that you must include in subsequent requests.
\n\nThis cookie could be used in both: API and Web Site to identify the current user.
\n\nThis 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
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.
\nRemember 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.\nSome extra notes
", "do_not_create_file": false } } } }, "responses": { "201": { "description": "Returns the trademark created representation: \n\n\nSome 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": null, "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\nSome extra notes
", "do_not_create_file": false, "user_id": "77e2dd06-154c-4157-ad69-a6720147e652", "user_user_name": "johndoe@ipfirm.com", "trademark_url_on_ipo": null, "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\nCreate a new user for a Company.
\nCompany 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:\nI 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": "Return the details on the IPO for the trademark selected.
\nSome extra notes
", "do_not_create_file": false, "user_id": "77e2dd06-154c-4157-ad69-a6720147e652", "user_user_name": "johndoe@ipfirm.com", "trademark_url_on_ipo": null, "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\nSome 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\nCreates a new filter for a specific endpoint.
\nYou can use filters to apply them on endpoints in order to get sub-sets of entities.
\nFor 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.
\nPayload to create a filter for the example above would be very similar to:
\n\n\nSo, 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.
\nAnother 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\nNote that operator_next contains the nexus with next expression. On this sample an OR ( because we want trademarks from both: US or GB ).
\n\nThe example above is similar to create this filter on the web UI.
\n\nProperties 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
\nEach object should have these properties:
\n\n
\nEach object should have these properties:
\n\n
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": null, "claims": [ ], "user_type_id": "00000000-0000-0000-0000-000000000000", "user_type_name": null }, "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\nSome 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": null } }, "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": null }, { "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": null }, { "id": "dcc1815c-af91-40c5-9cbc-ab4500df4e63", "user_id": "03ce7827-aac0-477d-a01b-aad8012abc99", "user_name": "chapeti+alsina003@gmail.com", "sensitivity": 20, "firm_portfolio_id": null, "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": "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": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": 1024, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": 254, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": 254, "min": null, "read_only": false, "step": null, "place_holder": null, "private": false, "internal": false, "display_order": 3 }, { "id": "3339089b-4535-4ec1-a9b9-a7e8000a3451", "name": "address_city", "display_name": "City", "class_name": "String", "pattern": "", "mask": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": 254, "min": null, "read_only": false, "step": null, "place_holder": null, "private": false, "internal": false, "display_order": 4 }, { "id": "136678f3-6827-4ea9-9a02-a7e8000a3748", "name": "address_state", "display_name": "State", "class_name": "String", "pattern": "", "mask": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": 254, "min": null, "read_only": false, "step": null, "place_holder": null, "private": false, "internal": false, "display_order": 5 }, { "id": "8f298718-3d17-450f-8871-a7e8000a3abc", "name": "address_zip", "display_name": "Zip", "class_name": "String", "pattern": "", "mask": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": 254, "min": null, "read_only": false, "step": null, "place_holder": null, "private": false, "internal": false, "display_order": 6 }, { "id": "3bd795ba-adff-45af-8b2f-a7e8000a3cc3", "name": "address_country", "display_name": "Country", "class_name": "String", "pattern": "", "mask": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": 254, "min": null, "read_only": false, "step": null, "place_holder": null, "private": false, "internal": false, "display_order": 7 }, { "id": "2b3ea2a5-61c8-456b-8b88-a7e8000a3ec6", "name": "observations", "display_name": "Observations", "class_name": "String", "pattern": "", "mask": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": 1024, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": true, "select_from": null, "disabled": false, "max": null, "max_length": null, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": true, "select_from": null, "disabled": false, "max": null, "max_length": null, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": true, "select_from": null, "disabled": false, "max": null, "max_length": null, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": true, "select_from": null, "disabled": false, "max": null, "max_length": null, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": true, "select_from": null, "disabled": false, "max": null, "max_length": null, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": true, "select_from": null, "disabled": false, "max": null, "max_length": null, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "required": true, "select_from": null, "disabled": false, "max": null, "max_length": null, "min": null, "read_only": false, "step": null, "place_holder": null, "private": false, "internal": false, "display_order": 0 }, { "id": "edda0df3-8d47-47f7-b45a-a86401891ed1", "name": "comments", "display_name": "Comments", "class_name": "BigString", "pattern": "", "mask": null, "required": false, "select_from": null, "disabled": false, "max": null, "max_length": null, "min": null, "read_only": false, "step": null, "place_holder": null, "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": null, "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": null } ], "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": [ ] } ] }