{"swagger": "2.0", "info": {"title": "Legalsense API", "description": "## Authentication\n\nAuthentication is done using Token-based access method over https.\n\n## Registration\n\nTo connect to the API of Legalsense Online, you need to provide the\nfollowing headers:\n\n- `X-Legalsense-Api-Client-Identifier`\n- `X-Legalsense-Api-Client-Token`\n\nTo obtain a client identifier and client token to be used for the\nAPI, please contact Legalsense support at support@legalsense.nl.\n\nThese headers are used to identify your API client, and grant your API\nclient to access our API on all Legalsense Online installations. They do not\ngrant you access to the data inside those installations.\n\nTo get access to the data inside the installations, you also need to have\naccess to an account on that installation, and use the Login/Logout flow.\n\n## Login / Logout flow\n\nWe have two main endpoints related to the flow:\n\n1) `POST https:///api/v3/auth/login/` - it creates a token that lives\nuntil you call /auth/logout.\n\n We need to provide this information while doing request:\n\n ```\n POST https:///api/v3/auth/login/\n X-Legalsense-Api-Client-Identifier: your-identifier\n X-Legalsense-Api-Client-Token: your-token\n\n {\n \"username\": \"\",\n \"password\": \"\"\n }\n ```\n\n and we should get back:\n\n ```\n {\n \"auth_token\": \"ZZZ\"\n }\n ```\n\n which we need to attach in the form of a header, to the subsequent\n requests to the API:\n\n ```\n Authorization: Token ZZZ\n ```\n\n where `ZZZ` is \"auth_token\" value obtained from the response. For\n instance:\n\n ```\n GET https:///api/v3/me/\n X-Legalsense-Api-Client-Identifier: your-identifier\n X-Legalsense-Api-Client-Token: your-token\n Authorization: Token ZZZ\n ```\n\n Note: if the account you're connecting with has two-factor\n authentication enabled, you will also need to supply the TOTP-token as\n follows:\n\n ```\n POST https:///api/v3/auth/login/\n X-Legalsense-Api-Client-Identifier: your-identifier\n X-Legalsense-Api-Client-Token: your-token\n\n {\n \"username\": \"\",\n \"password\": \"\",\n \"token\": \"123456\"\n }\n ```\n\n where `123456` is the six-digit token generated by the TOTP-algorithm\n based on the shared secret.\n\n2) `POST https:///api/v3/auth/logout/` - which invalidates the token.\n\n No data is sent, only the `Authentication` header, as well as the\n `X-Legalsense-Api-Client-Identifier` and `X-Legalsense-Api-Client-Token`\n headers.\n\n This deactivates the token provided in the `Authentication` header.\n\n## General Information\n\n### Pagination\n\nList endpoints will return only a limited set of data, by default only 500\nrecords. To obtain more records, follow the `next` key in the record.\n\n```\n{\n \"count\": 1234,\n \"next\": \"https:///api/v3//?page=2\"\n \"previous\": null,\n \"results\": [\n ...\n ]\n}\n```\n\nTo fetch all the pages, follow `next` of each separate response until\nthe `next` value is `null`.\n\nIf a page size different from 500 is preferred, you can supply an alternate\npage size using `?page_size=N` with a page size of up to 1000.\n\n### Automatic numbering\n\nIt's applicable to resources that have field called `number` - it gets\neither the value passed or if `null` is provided explicitly, it gets next\navailable number for given object. Used in the endpoints `contacts`,\n`clients`, `matters`, `activities` and `matterarchiveinformation`.\n\n### Derived field\n\nDerived field is a type of field that can get its value from another\nplace as a fallback default value or one can provide value for it.\nThe derived field structure as JSON object consists of three keys:\n`internal`, `representation` and `is_derived`.\n\nWhile creating new resources through API there are two cases:\n\n- One is sending value for derived field as `{\"internal\": null}`\nthen should GET:\n\n ```\n {\n \"is_derived\": true,\n \"internal\": null,\n \"representation\": \"derived value\"\n }\n ```\n\n- One is sending value for derived field as `{\"internal\": \"value\"}`\nthen should GET:\n\n ```\n {\n \"is_derived\": false,\n \"internal\": \"value\",\n \"representation\": \"value\"\n }\n ```\n\nAnalogically we can update the resource by leveraging `internal` field\n(similar to above).\n\nExplanation of the sub-fields that derived field consists of:\n\n`is_derived` informs us whether the value is obtained from another\nplace or not (this field is read only)\n\nwith `internal` we can instruct the API whether to derive the value\nfrom other place (`null`) or use the value provided (anything except `null`)\n\n`representation` gives us the actual value.\n\nExample scenarios which explain the behavior:\n\n- `matters` endpoint returns `currency` field and it can derive its value\n from system wide reference value (which Client uses)\n\n- `contacts` endpoint returns `address_label_name` field which if derived,\n it has either organization name or natural person name depending on the\n type of the contact\n\n### Extra fields\n\nBy default, all list view endpoints return as little information as possible,\nmost often it will return fields such as `id`, `display_name` etc.\nHowever, we can get additional fields if needed (which mostly relate to what\nis returned in detail view for particular resource) for that endpoint using\n`extra_fields` query parameter.\n\n### Relations\n\nWhenever a field represents some relation to the other object (is used as\na foreign key internally), apart from taking the id value directly e.g.,\n`\"tax_country\": 1`, we can also pass what's often returned from GET\nendpoint for such fields:\n`\"tax_country\": {\"display_name\": \"Netherlands\", \"id\": 1, \"url\": \"...\"}`.\n\n### Translation\n\nFor some endpoints you can pass in `Accept-Language` HTTP header with\nthe language value (e.g.: `en-us`) in order to get the `display_name`\nin another language. Endpoints that are using it are connected with\nActivity, Branch, ContactKind, AddressKind.\n", "version": "v3"}, "host": "localhost:8000", "schemes": ["http"], "basePath": "/api/v3", "consumes": ["application/json"], "produces": ["application/json"], "securityDefinitions": {"Basic": {"type": "basic"}}, "security": [{"Basic": []}], "paths": {"/accounts/": {"get": {"operationId": "accounts_list", "summary": "This endpoint represents the trust accounting accounts.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `allow_settling`\n* `groups`\n* `suspense_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Account"}}}}}}, "tags": ["accounts"]}, "post": {"operationId": "accounts_create", "summary": "This endpoint represents the trust accounting accounts.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `allow_settling`\n* `groups`\n* `suspense_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Account"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Account"}}}, "tags": ["accounts"]}, "parameters": []}, "/accounts/{id}/": {"get": {"operationId": "accounts_read", "summary": "This endpoint represents the trust accounting accounts.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `allow_settling`\n* `groups`\n* `suspense_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Account"}}}, "tags": ["accounts"]}, "put": {"operationId": "accounts_update", "summary": "This endpoint represents the trust accounting accounts.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `allow_settling`\n* `groups`\n* `suspense_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Account"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Account"}}}, "tags": ["accounts"]}, "delete": {"operationId": "accounts_delete", "summary": "This endpoint represents the trust accounting accounts.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `allow_settling`\n* `groups`\n* `suspense_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["accounts"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/activities/": {"get": {"operationId": "activities_list", "summary": "This endpoint represents the activities.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `billable` - determines activity availability. If it's `true`, activity should be available only for billable\nmatters, if it's `false` it should be available only for non-billable matters, if it's `null` it should be always\navailable.\n* `is_active`\n* `is_default` - whether or not this is the default activity.\n* `name`\n* `number`\n* `rate`\n* `rate_factor` - factor to increase/decrease rate of time with this activity.\n* `separate_on_invoice`\n* `display_name`\n* `min_logline_description_length` - This field determines whether the description for a time entry becomes required\nwith the specified minimum number of characters. Set the value to 0 to not make the description required.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\n\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `name`\n * `number`\n * `min_logline_description_length`\n\n For instance: ?extra_fields=name,number", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- is_default\n- name\n- number\n- min_logline_description_length", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Activity"}}}}}}, "tags": ["activities"]}, "post": {"operationId": "activities_create", "summary": "This endpoint represents the activities.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `billable` - determines activity availability. If it's `true`, activity should be available only for billable\nmatters, if it's `false` it should be available only for non-billable matters, if it's `null` it should be always\navailable.\n* `is_active`\n* `is_default` - whether or not this is the default activity.\n* `name`\n* `number`\n* `rate`\n* `rate_factor` - factor to increase/decrease rate of time with this activity.\n* `separate_on_invoice`\n* `display_name`\n* `min_logline_description_length` - This field determines whether the description for a time entry becomes required\nwith the specified minimum number of characters. Set the value to 0 to not make the description required.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\n\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `name`\n * `number`\n * `min_logline_description_length`\n\n For instance: ?extra_fields=name,number", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Activity"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Activity"}}}, "tags": ["activities"]}, "parameters": []}, "/activities/{id}/": {"get": {"operationId": "activities_read", "summary": "This endpoint represents the activities.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `billable` - determines activity availability. If it's `true`, activity should be available only for billable\nmatters, if it's `false` it should be available only for non-billable matters, if it's `null` it should be always\navailable.\n* `is_active`\n* `is_default` - whether or not this is the default activity.\n* `name`\n* `number`\n* `rate`\n* `rate_factor` - factor to increase/decrease rate of time with this activity.\n* `separate_on_invoice`\n* `display_name`\n* `min_logline_description_length` - This field determines whether the description for a time entry becomes required\nwith the specified minimum number of characters. Set the value to 0 to not make the description required.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\n\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `name`\n * `number`\n * `min_logline_description_length`\n\n For instance: ?extra_fields=name,number", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Activity"}}}, "tags": ["activities"]}, "put": {"operationId": "activities_update", "summary": "This endpoint represents the activities.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `billable` - determines activity availability. If it's `true`, activity should be available only for billable\nmatters, if it's `false` it should be available only for non-billable matters, if it's `null` it should be always\navailable.\n* `is_active`\n* `is_default` - whether or not this is the default activity.\n* `name`\n* `number`\n* `rate`\n* `rate_factor` - factor to increase/decrease rate of time with this activity.\n* `separate_on_invoice`\n* `display_name`\n* `min_logline_description_length` - This field determines whether the description for a time entry becomes required\nwith the specified minimum number of characters. Set the value to 0 to not make the description required.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\n\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `name`\n * `number`\n * `min_logline_description_length`\n\n For instance: ?extra_fields=name,number", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Activity"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Activity"}}}, "tags": ["activities"]}, "delete": {"operationId": "activities_delete", "summary": "This endpoint represents the activities.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `billable` - determines activity availability. If it's `true`, activity should be available only for billable\nmatters, if it's `false` it should be available only for non-billable matters, if it's `null` it should be always\navailable.\n* `is_active`\n* `is_default` - whether or not this is the default activity.\n* `name`\n* `number`\n* `rate`\n* `rate_factor` - factor to increase/decrease rate of time with this activity.\n* `separate_on_invoice`\n* `display_name`\n* `min_logline_description_length` - This field determines whether the description for a time entry becomes required\nwith the specified minimum number of characters. Set the value to 0 to not make the description required.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\n\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `name`\n * `number`\n * `min_logline_description_length`\n\n For instance: ?extra_fields=name,number", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["activities"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/activitygroups/": {"get": {"operationId": "activitygroups_list", "summary": "This endpoint represents the activity groups.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `name`\n* `is_default`\n* `activities`\n\nBy using the list view, you can access fields:\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ActivityGroup"}}}}}}, "tags": ["activitygroups"]}, "post": {"operationId": "activitygroups_create", "summary": "This endpoint represents the activity groups.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `name`\n* `is_default`\n* `activities`\n\nBy using the list view, you can access fields:\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ActivityGroup"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ActivityGroup"}}}, "tags": ["activitygroups"]}, "parameters": []}, "/activitygroups/{id}/": {"get": {"operationId": "activitygroups_read", "summary": "This endpoint represents the activity groups.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `name`\n* `is_default`\n* `activities`\n\nBy using the list view, you can access fields:\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ActivityGroup"}}}, "tags": ["activitygroups"]}, "put": {"operationId": "activitygroups_update", "summary": "This endpoint represents the activity groups.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `name`\n* `is_default`\n* `activities`\n\nBy using the list view, you can access fields:\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ActivityGroup"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ActivityGroup"}}}, "tags": ["activitygroups"]}, "delete": {"operationId": "activitygroups_delete", "summary": "This endpoint represents the activity groups.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `name`\n* `is_default`\n* `activities`\n\nBy using the list view, you can access fields:\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["activitygroups"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/addresses/": {"get": {"operationId": "addresses_list", "summary": "This endpoint represents the addresses.", "description": "Using the detail view, you can access fields:\n\n * `created_date`\n * `modified_date`\n * `id`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template` - number, see list of choices below\n * `city`\n * `contact`\n * `country`\n * `department`\n * `display_name`\n * `normalized_country`\n * `url`\n * `zipcode`\n * `full_address`\n\nRequired fields note:\n\n* When `address_template == 1`, `full_address` is required. The use of 'full_address' is not recommended.\n* Otherwise, the required fields are: `contact`, `address`, `zipcode`, `city`, `country`.\n\nWhen the field `address_template` is not provided, then the default template will be used.\nAddress template accepts one of the following values (T.a.v. in Dutch means \"To the attention of\"):\n\n* `1` - `AT_SPECIFY_MANUALLY`\n* `2` - `AT_NL_TAV`\n* `3` - `AT_NL`\n* `4` - `AT_UK_ATTN`\n* `5` - `AT_UK`\n* `6` - `AT_DU_ZHD`\n* `7` - `AT_USA_ATTN`\n* `8` - `AT_USA`\n* `9` - `AT_CM`\n* `10` - `AT_CM_TAV`\n* `11` - `AT_NL_TAV_FIRSTNAME` - uses firstname with fallback to initials\n* `12` - `AT_CM_DEFAULT_SALUTATION`\n* `13` - `AT_INTERNATIONAL_ATTN`\n* `14` - `AT_SE_ATT` # Sweden\n* `15` - `AT_INTERNATIONAL_PERSON_FIRST` - display the contact person on first line (US-style)\n* `16` - `AT_DK_ATT` # Denmark\n* `17` - `AT_CM_WITHOUT_ATTN`\n* `18` - `AT_INTERNATIONAL_FIRSTNAME` - uses firstname with fallback to initials without Attn\n\n By using the list view, you can access fields:\n\n * `id`\n * `url`\n * `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `contact`, eg. `?contact=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `modified_date`\n * `created_date`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template`\n * `city`\n * `contact`\n * `country`\n * `department`\n * `full_address`\n * `normalized_country`\n * `zipcode`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "contact", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- address\n- address_kind\n- address_line_2\n- address_template\n- city\n- contact\n- country\n- department\n- full_address\n- normalized_country\n- zipcode", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Address"}}}}}}, "tags": ["addresses"]}, "post": {"operationId": "addresses_create", "summary": "This endpoint represents the addresses.", "description": "Using the detail view, you can access fields:\n\n * `created_date`\n * `modified_date`\n * `id`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template` - number, see list of choices below\n * `city`\n * `contact`\n * `country`\n * `department`\n * `display_name`\n * `normalized_country`\n * `url`\n * `zipcode`\n * `full_address`\n\nRequired fields note:\n\n* When `address_template == 1`, `full_address` is required. The use of 'full_address' is not recommended.\n* Otherwise, the required fields are: `contact`, `address`, `zipcode`, `city`, `country`.\n\nWhen the field `address_template` is not provided, then the default template will be used.\nAddress template accepts one of the following values (T.a.v. in Dutch means \"To the attention of\"):\n\n* `1` - `AT_SPECIFY_MANUALLY`\n* `2` - `AT_NL_TAV`\n* `3` - `AT_NL`\n* `4` - `AT_UK_ATTN`\n* `5` - `AT_UK`\n* `6` - `AT_DU_ZHD`\n* `7` - `AT_USA_ATTN`\n* `8` - `AT_USA`\n* `9` - `AT_CM`\n* `10` - `AT_CM_TAV`\n* `11` - `AT_NL_TAV_FIRSTNAME` - uses firstname with fallback to initials\n* `12` - `AT_CM_DEFAULT_SALUTATION`\n* `13` - `AT_INTERNATIONAL_ATTN`\n* `14` - `AT_SE_ATT` # Sweden\n* `15` - `AT_INTERNATIONAL_PERSON_FIRST` - display the contact person on first line (US-style)\n* `16` - `AT_DK_ATT` # Denmark\n* `17` - `AT_CM_WITHOUT_ATTN`\n* `18` - `AT_INTERNATIONAL_FIRSTNAME` - uses firstname with fallback to initials without Attn\n\n By using the list view, you can access fields:\n\n * `id`\n * `url`\n * `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `contact`, eg. `?contact=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `modified_date`\n * `created_date`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template`\n * `city`\n * `contact`\n * `country`\n * `department`\n * `full_address`\n * `normalized_country`\n * `zipcode`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Address"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Address"}}}, "tags": ["addresses"]}, "parameters": []}, "/addresses/{id}/": {"get": {"operationId": "addresses_read", "summary": "This endpoint represents the addresses.", "description": "Using the detail view, you can access fields:\n\n * `created_date`\n * `modified_date`\n * `id`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template` - number, see list of choices below\n * `city`\n * `contact`\n * `country`\n * `department`\n * `display_name`\n * `normalized_country`\n * `url`\n * `zipcode`\n * `full_address`\n\nRequired fields note:\n\n* When `address_template == 1`, `full_address` is required. The use of 'full_address' is not recommended.\n* Otherwise, the required fields are: `contact`, `address`, `zipcode`, `city`, `country`.\n\nWhen the field `address_template` is not provided, then the default template will be used.\nAddress template accepts one of the following values (T.a.v. in Dutch means \"To the attention of\"):\n\n* `1` - `AT_SPECIFY_MANUALLY`\n* `2` - `AT_NL_TAV`\n* `3` - `AT_NL`\n* `4` - `AT_UK_ATTN`\n* `5` - `AT_UK`\n* `6` - `AT_DU_ZHD`\n* `7` - `AT_USA_ATTN`\n* `8` - `AT_USA`\n* `9` - `AT_CM`\n* `10` - `AT_CM_TAV`\n* `11` - `AT_NL_TAV_FIRSTNAME` - uses firstname with fallback to initials\n* `12` - `AT_CM_DEFAULT_SALUTATION`\n* `13` - `AT_INTERNATIONAL_ATTN`\n* `14` - `AT_SE_ATT` # Sweden\n* `15` - `AT_INTERNATIONAL_PERSON_FIRST` - display the contact person on first line (US-style)\n* `16` - `AT_DK_ATT` # Denmark\n* `17` - `AT_CM_WITHOUT_ATTN`\n* `18` - `AT_INTERNATIONAL_FIRSTNAME` - uses firstname with fallback to initials without Attn\n\n By using the list view, you can access fields:\n\n * `id`\n * `url`\n * `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `contact`, eg. `?contact=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `modified_date`\n * `created_date`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template`\n * `city`\n * `contact`\n * `country`\n * `department`\n * `full_address`\n * `normalized_country`\n * `zipcode`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Address"}}}, "tags": ["addresses"]}, "put": {"operationId": "addresses_update", "summary": "This endpoint represents the addresses.", "description": "Using the detail view, you can access fields:\n\n * `created_date`\n * `modified_date`\n * `id`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template` - number, see list of choices below\n * `city`\n * `contact`\n * `country`\n * `department`\n * `display_name`\n * `normalized_country`\n * `url`\n * `zipcode`\n * `full_address`\n\nRequired fields note:\n\n* When `address_template == 1`, `full_address` is required. The use of 'full_address' is not recommended.\n* Otherwise, the required fields are: `contact`, `address`, `zipcode`, `city`, `country`.\n\nWhen the field `address_template` is not provided, then the default template will be used.\nAddress template accepts one of the following values (T.a.v. in Dutch means \"To the attention of\"):\n\n* `1` - `AT_SPECIFY_MANUALLY`\n* `2` - `AT_NL_TAV`\n* `3` - `AT_NL`\n* `4` - `AT_UK_ATTN`\n* `5` - `AT_UK`\n* `6` - `AT_DU_ZHD`\n* `7` - `AT_USA_ATTN`\n* `8` - `AT_USA`\n* `9` - `AT_CM`\n* `10` - `AT_CM_TAV`\n* `11` - `AT_NL_TAV_FIRSTNAME` - uses firstname with fallback to initials\n* `12` - `AT_CM_DEFAULT_SALUTATION`\n* `13` - `AT_INTERNATIONAL_ATTN`\n* `14` - `AT_SE_ATT` # Sweden\n* `15` - `AT_INTERNATIONAL_PERSON_FIRST` - display the contact person on first line (US-style)\n* `16` - `AT_DK_ATT` # Denmark\n* `17` - `AT_CM_WITHOUT_ATTN`\n* `18` - `AT_INTERNATIONAL_FIRSTNAME` - uses firstname with fallback to initials without Attn\n\n By using the list view, you can access fields:\n\n * `id`\n * `url`\n * `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `contact`, eg. `?contact=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `modified_date`\n * `created_date`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template`\n * `city`\n * `contact`\n * `country`\n * `department`\n * `full_address`\n * `normalized_country`\n * `zipcode`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Address"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Address"}}}, "tags": ["addresses"]}, "delete": {"operationId": "addresses_delete", "summary": "This endpoint represents the addresses.", "description": "Using the detail view, you can access fields:\n\n * `created_date`\n * `modified_date`\n * `id`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template` - number, see list of choices below\n * `city`\n * `contact`\n * `country`\n * `department`\n * `display_name`\n * `normalized_country`\n * `url`\n * `zipcode`\n * `full_address`\n\nRequired fields note:\n\n* When `address_template == 1`, `full_address` is required. The use of 'full_address' is not recommended.\n* Otherwise, the required fields are: `contact`, `address`, `zipcode`, `city`, `country`.\n\nWhen the field `address_template` is not provided, then the default template will be used.\nAddress template accepts one of the following values (T.a.v. in Dutch means \"To the attention of\"):\n\n* `1` - `AT_SPECIFY_MANUALLY`\n* `2` - `AT_NL_TAV`\n* `3` - `AT_NL`\n* `4` - `AT_UK_ATTN`\n* `5` - `AT_UK`\n* `6` - `AT_DU_ZHD`\n* `7` - `AT_USA_ATTN`\n* `8` - `AT_USA`\n* `9` - `AT_CM`\n* `10` - `AT_CM_TAV`\n* `11` - `AT_NL_TAV_FIRSTNAME` - uses firstname with fallback to initials\n* `12` - `AT_CM_DEFAULT_SALUTATION`\n* `13` - `AT_INTERNATIONAL_ATTN`\n* `14` - `AT_SE_ATT` # Sweden\n* `15` - `AT_INTERNATIONAL_PERSON_FIRST` - display the contact person on first line (US-style)\n* `16` - `AT_DK_ATT` # Denmark\n* `17` - `AT_CM_WITHOUT_ATTN`\n* `18` - `AT_INTERNATIONAL_FIRSTNAME` - uses firstname with fallback to initials without Attn\n\n By using the list view, you can access fields:\n\n * `id`\n * `url`\n * `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `contact`, eg. `?contact=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `modified_date`\n * `created_date`\n * `address`\n * `address_kind`\n * `address_line_2`\n * `address_template`\n * `city`\n * `contact`\n * `country`\n * `department`\n * `full_address`\n * `normalized_country`\n * `zipcode`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["addresses"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/addresskinds/": {"get": {"operationId": "addresskinds_list", "summary": "This endpoint represents the address kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `is_default`\n* `is_active`\n* `name`\n* `type_TWF` - Address type to use in Twinfield. You can use the following values:\n * `postal`\n * `invoice`\n * `contact`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AddressKind"}}}}}}, "tags": ["addresskinds"]}, "post": {"operationId": "addresskinds_create", "summary": "This endpoint represents the address kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `is_default`\n* `is_active`\n* `name`\n* `type_TWF` - Address type to use in Twinfield. You can use the following values:\n * `postal`\n * `invoice`\n * `contact`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AddressKind"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/AddressKind"}}}, "tags": ["addresskinds"]}, "parameters": []}, "/addresskinds/{id}/": {"get": {"operationId": "addresskinds_read", "summary": "This endpoint represents the address kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `is_default`\n* `is_active`\n* `name`\n* `type_TWF` - Address type to use in Twinfield. You can use the following values:\n * `postal`\n * `invoice`\n * `contact`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AddressKind"}}}, "tags": ["addresskinds"]}, "put": {"operationId": "addresskinds_update", "summary": "This endpoint represents the address kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `is_default`\n* `is_active`\n* `name`\n* `type_TWF` - Address type to use in Twinfield. You can use the following values:\n * `postal`\n * `invoice`\n * `contact`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/AddressKind"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AddressKind"}}}, "tags": ["addresskinds"]}, "delete": {"operationId": "addresskinds_delete", "summary": "This endpoint represents the address kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `is_default`\n* `is_active`\n* `name`\n* `type_TWF` - Address type to use in Twinfield. You can use the following values:\n * `postal`\n * `invoice`\n * `contact`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["addresskinds"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/advanceinvoicelines/": {"get": {"operationId": "advanceinvoicelines_list", "summary": "This endpoint represents the advanceinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to advanceinvoicelines:\n* `advance_invoice_line` - the invoiceline that this invoiceline is settled with\n* `is_credited`\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `advance_invoice_line`\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `is_credited`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `tax_percentage`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section\n- advance_invoice_line\n- is_credited\n- tax_percentage", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/AdvanceInvoiceline"}}}}}}, "tags": ["advanceinvoicelines"]}, "parameters": []}, "/advanceinvoicelines/{id}/": {"get": {"operationId": "advanceinvoicelines_read", "summary": "This endpoint represents the advanceinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to advanceinvoicelines:\n* `advance_invoice_line` - the invoiceline that this invoiceline is settled with\n* `is_credited`\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `advance_invoice_line`\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `is_credited`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `tax_percentage`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/AdvanceInvoiceline"}}}, "tags": ["advanceinvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/auth/": {"get": {"operationId": "auth_list", "description": "", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": ""}}, "tags": ["auth"]}, "parameters": []}, "/auth/login/": {"post": {"operationId": "auth_login_create", "summary": "Handle POST request to log in.", "description": "This is a security-critical part of Legalsense. It handles\nall login requests, both for UI and API v2/v3. Do not make\nchanges to this method.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LegalsenseLogin"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/LegalsenseLogin"}}}, "tags": ["auth"]}, "parameters": []}, "/auth/logout/": {"post": {"operationId": "auth_logout_create", "description": "", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "properties": {}}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"type": "object", "properties": {}}}}, "tags": ["auth"]}, "parameters": []}, "/branches/": {"get": {"operationId": "branches_list", "summary": "This endpoint represents the branches.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Branch"}}}}}}, "tags": ["branches"]}, "post": {"operationId": "branches_create", "summary": "This endpoint represents the branches.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Branch"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Branch"}}}, "tags": ["branches"]}, "parameters": []}, "/branches/{id}/": {"get": {"operationId": "branches_read", "summary": "This endpoint represents the branches.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Branch"}}}, "tags": ["branches"]}, "put": {"operationId": "branches_update", "summary": "This endpoint represents the branches.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Branch"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Branch"}}}, "tags": ["branches"]}, "delete": {"operationId": "branches_delete", "summary": "This endpoint represents the branches.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["branches"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/budgets/": {"get": {"operationId": "budgets_list", "summary": "This endpoint represents the budget irrespective of what subtype they are.\nOnly generic Budget data is available", "description": "By using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `object_type`, e.g. `?object_type=matterbudget`\n * `matterbudget`\n * `submatterbudget`\n * `clientbudget`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `begin_date`\n* `end_date`\n* `hours`\n* `kind`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "begin_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_from", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_until", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "amount", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "hours", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "kind", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_billing_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_supervising_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- begin_date\n- end_date\n- hours\n- kind\n- notify_billing_user\n- notify_supervising_user\n- notify_user\n- object_type", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Budget"}}}}}}, "tags": ["budgets"]}, "parameters": []}, "/budgets/{id}/": {"get": {"operationId": "budgets_read", "summary": "This endpoint represents the budget irrespective of what subtype they are.\nOnly generic Budget data is available", "description": "By using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `object_type`, e.g. `?object_type=matterbudget`\n * `matterbudget`\n * `submatterbudget`\n * `clientbudget`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `begin_date`\n* `end_date`\n* `hours`\n* `kind`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Budget"}}}, "tags": ["budgets"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/chargeables/": {"get": {"operationId": "chargeables_list", "summary": "This endpoint represents a list of chargeables.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed` - true when the chargeable is on a final invoice or billed elsewhere\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice` - the Expense object associated with this Chargeable\n* `billed_on_invoice` - the final invoice this chargeable is billed on (nested object)\n* `billed_on_invoice_draft` - the draft invoice this chargeable is on (nested object)\n* `billed_elsewhere` - the chargeable is billed outside Legalsense\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed`\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `billed_elsewhere`\n* `tax_percentage`\n\nFor instance: `?extra_fields=amount,matter,expense_type`.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `purchase_invoice`, eg. `?purchase_invoice=4`\n* `is_billed`, eg. `?is_billed=true`\n* `billed_elsewhere`, eg. `?billed_elsewhere=True`\n* `billed_on_invoice`, eg. `?billed_on_invoice=4`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=4`\n* `expense_type`, eg. `?expense_type=4`\n* `is_billable`, eg. `?is_billable=True`\n* `matter`, eg. `?matter=4`\n* `matter__isnull`, eg. `?matter__isnull=True`\n* `tax_percentage`, eg. `?tax_percentage=4`\n * note: this is the `id` of the `taxpercentage` object, not the value of the\n `taxpercentage` object.\n* `user`, eg `?user=4`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "billed_elsewhere", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billed_on_invoice", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billed_on_invoice_draft", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_billed", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "amount", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "amount_in_default_currency", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "expense_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_billable", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "purchase_invoice", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "tax_percentage", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- amount\n- description\n- expense_type\n- is_billed\n- include_expense_on_invoice\n- is_billable\n- kilometers\n- matter\n- purchase_invoice\n- tax_percentage\n- billed_on_invoice\n- billed_on_invoice_draft\n- billed_elsewhere", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Chargeable"}}}}}}, "tags": ["chargeables"]}, "post": {"operationId": "chargeables_create", "summary": "This endpoint represents a list of chargeables.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed` - true when the chargeable is on a final invoice or billed elsewhere\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice` - the Expense object associated with this Chargeable\n* `billed_on_invoice` - the final invoice this chargeable is billed on (nested object)\n* `billed_on_invoice_draft` - the draft invoice this chargeable is on (nested object)\n* `billed_elsewhere` - the chargeable is billed outside Legalsense\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed`\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `billed_elsewhere`\n* `tax_percentage`\n\nFor instance: `?extra_fields=amount,matter,expense_type`.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `purchase_invoice`, eg. `?purchase_invoice=4`\n* `is_billed`, eg. `?is_billed=true`\n* `billed_elsewhere`, eg. `?billed_elsewhere=True`\n* `billed_on_invoice`, eg. `?billed_on_invoice=4`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=4`\n* `expense_type`, eg. `?expense_type=4`\n* `is_billable`, eg. `?is_billable=True`\n* `matter`, eg. `?matter=4`\n* `matter__isnull`, eg. `?matter__isnull=True`\n* `tax_percentage`, eg. `?tax_percentage=4`\n * note: this is the `id` of the `taxpercentage` object, not the value of the\n `taxpercentage` object.\n* `user`, eg `?user=4`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Chargeable"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Chargeable"}}}, "tags": ["chargeables"]}, "parameters": []}, "/chargeables/{id}/": {"get": {"operationId": "chargeables_read", "summary": "This endpoint represents a list of chargeables.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed` - true when the chargeable is on a final invoice or billed elsewhere\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice` - the Expense object associated with this Chargeable\n* `billed_on_invoice` - the final invoice this chargeable is billed on (nested object)\n* `billed_on_invoice_draft` - the draft invoice this chargeable is on (nested object)\n* `billed_elsewhere` - the chargeable is billed outside Legalsense\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed`\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `billed_elsewhere`\n* `tax_percentage`\n\nFor instance: `?extra_fields=amount,matter,expense_type`.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `purchase_invoice`, eg. `?purchase_invoice=4`\n* `is_billed`, eg. `?is_billed=true`\n* `billed_elsewhere`, eg. `?billed_elsewhere=True`\n* `billed_on_invoice`, eg. `?billed_on_invoice=4`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=4`\n* `expense_type`, eg. `?expense_type=4`\n* `is_billable`, eg. `?is_billable=True`\n* `matter`, eg. `?matter=4`\n* `matter__isnull`, eg. `?matter__isnull=True`\n* `tax_percentage`, eg. `?tax_percentage=4`\n * note: this is the `id` of the `taxpercentage` object, not the value of the\n `taxpercentage` object.\n* `user`, eg `?user=4`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Chargeable"}}}, "tags": ["chargeables"]}, "put": {"operationId": "chargeables_update", "summary": "This endpoint represents a list of chargeables.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed` - true when the chargeable is on a final invoice or billed elsewhere\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice` - the Expense object associated with this Chargeable\n* `billed_on_invoice` - the final invoice this chargeable is billed on (nested object)\n* `billed_on_invoice_draft` - the draft invoice this chargeable is on (nested object)\n* `billed_elsewhere` - the chargeable is billed outside Legalsense\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed`\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `billed_elsewhere`\n* `tax_percentage`\n\nFor instance: `?extra_fields=amount,matter,expense_type`.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `purchase_invoice`, eg. `?purchase_invoice=4`\n* `is_billed`, eg. `?is_billed=true`\n* `billed_elsewhere`, eg. `?billed_elsewhere=True`\n* `billed_on_invoice`, eg. `?billed_on_invoice=4`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=4`\n* `expense_type`, eg. `?expense_type=4`\n* `is_billable`, eg. `?is_billable=True`\n* `matter`, eg. `?matter=4`\n* `matter__isnull`, eg. `?matter__isnull=True`\n* `tax_percentage`, eg. `?tax_percentage=4`\n * note: this is the `id` of the `taxpercentage` object, not the value of the\n `taxpercentage` object.\n* `user`, eg `?user=4`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Chargeable"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Chargeable"}}}, "tags": ["chargeables"]}, "delete": {"operationId": "chargeables_delete", "summary": "This endpoint represents a list of chargeables.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed` - true when the chargeable is on a final invoice or billed elsewhere\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice` - the Expense object associated with this Chargeable\n* `billed_on_invoice` - the final invoice this chargeable is billed on (nested object)\n* `billed_on_invoice_draft` - the draft invoice this chargeable is on (nested object)\n* `billed_elsewhere` - the chargeable is billed outside Legalsense\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `created_date`\n* `modified_date`\n* `amount`\n* `description`\n* `expense_type`\n* `is_billed`\n* `include_expense_on_invoice`\n* `is_billable`\n* `kilometers`\n* `matter`\n* `purchase_invoice`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `billed_elsewhere`\n* `tax_percentage`\n\nFor instance: `?extra_fields=amount,matter,expense_type`.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `purchase_invoice`, eg. `?purchase_invoice=4`\n* `is_billed`, eg. `?is_billed=true`\n* `billed_elsewhere`, eg. `?billed_elsewhere=True`\n* `billed_on_invoice`, eg. `?billed_on_invoice=4`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=4`\n* `expense_type`, eg. `?expense_type=4`\n* `is_billable`, eg. `?is_billable=True`\n* `matter`, eg. `?matter=4`\n* `matter__isnull`, eg. `?matter__isnull=True`\n* `tax_percentage`, eg. `?tax_percentage=4`\n * note: this is the `id` of the `taxpercentage` object, not the value of the\n `taxpercentage` object.\n* `user`, eg `?user=4`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["chargeables"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/clientbudgets/": {"get": {"operationId": "clientbudgets_list", "summary": "This endpoint represents the clientbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `add_future_matters`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the clientbudget period\n* `end_date` - end date of the clientbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, e.g. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, e.g. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5`\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=1`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, e.g. `?valid_from=2025-01-01`\n* `valid_until`, e.g. `?valid_until=2025-05-01`\n\nThis will return budgets linked to **any** of the specified matters.\n\n## Extra fields\n\nIt's possible to show the following fields in list view when requested\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `add_future_matters`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "begin_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_from", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_until", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "add_future_matters", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "amount", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "budget_status", "in": "query", "description": "Budget status", "required": false, "type": "string"}, {"name": "client", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "hours", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "kind", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_billing_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_supervising_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- begin_date\n- end_date\n- hours\n- kind\n- notify_billing_user\n- notify_supervising_user\n- notify_user\n- object_type\n- amount_used\n- hours_used\n- add_future_matters\n- client\n- matters", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ClientBudget"}}}}}}, "tags": ["clientbudgets"]}, "post": {"operationId": "clientbudgets_create", "summary": "This endpoint represents the clientbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `add_future_matters`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the clientbudget period\n* `end_date` - end date of the clientbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, e.g. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, e.g. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5`\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=1`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, e.g. `?valid_from=2025-01-01`\n* `valid_until`, e.g. `?valid_until=2025-05-01`\n\nThis will return budgets linked to **any** of the specified matters.\n\n## Extra fields\n\nIt's possible to show the following fields in list view when requested\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `add_future_matters`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ClientBudget"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ClientBudget"}}}, "tags": ["clientbudgets"]}, "parameters": []}, "/clientbudgets/{id}/": {"get": {"operationId": "clientbudgets_read", "summary": "This endpoint represents the clientbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `add_future_matters`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the clientbudget period\n* `end_date` - end date of the clientbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, e.g. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, e.g. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5`\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=1`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, e.g. `?valid_from=2025-01-01`\n* `valid_until`, e.g. `?valid_until=2025-05-01`\n\nThis will return budgets linked to **any** of the specified matters.\n\n## Extra fields\n\nIt's possible to show the following fields in list view when requested\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `add_future_matters`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ClientBudget"}}}, "tags": ["clientbudgets"]}, "put": {"operationId": "clientbudgets_update", "summary": "This endpoint represents the clientbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `add_future_matters`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the clientbudget period\n* `end_date` - end date of the clientbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, e.g. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, e.g. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5`\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=1`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, e.g. `?valid_from=2025-01-01`\n* `valid_until`, e.g. `?valid_until=2025-05-01`\n\nThis will return budgets linked to **any** of the specified matters.\n\n## Extra fields\n\nIt's possible to show the following fields in list view when requested\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `add_future_matters`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ClientBudget"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ClientBudget"}}}, "tags": ["clientbudgets"]}, "delete": {"operationId": "clientbudgets_delete", "summary": "This endpoint represents the clientbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `add_future_matters`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the clientbudget period\n* `end_date` - end date of the clientbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, e.g. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, e.g. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5`\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=1`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, e.g. `?valid_from=2025-01-01`\n* `valid_until`, e.g. `?valid_until=2025-05-01`\n\nThis will return budgets linked to **any** of the specified matters.\n\n## Extra fields\n\nIt's possible to show the following fields in list view when requested\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matters`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `add_future_matters`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["clientbudgets"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/clientcontributioninvoicelines/": {"get": {"operationId": "clientcontributioninvoicelines_list", "summary": "This endpoint represents the clientcontributioninvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to clientcontributioninvoicelines:\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `tax_percentage`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section\n- tax_percentage", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ClientContributionInvoiceline"}}}}}}, "tags": ["clientcontributioninvoicelines"]}, "parameters": []}, "/clientcontributioninvoicelines/{id}/": {"get": {"operationId": "clientcontributioninvoicelines_read", "summary": "This endpoint represents the clientcontributioninvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to clientcontributioninvoicelines:\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `tax_percentage`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ClientContributionInvoiceline"}}}, "tags": ["clientcontributioninvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/clientcustomfielddefinitions/": {"get": {"operationId": "clientcustomfielddefinitions_list", "summary": "This endpoint represents the client custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "excel_export", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "identifier", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "read_only", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "required", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ClientCustomFieldDefinition"}}}}}}, "tags": ["clientcustomfielddefinitions"]}, "post": {"operationId": "clientcustomfielddefinitions_create", "summary": "This endpoint represents the client custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ClientCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ClientCustomFieldDefinition"}}}, "tags": ["clientcustomfielddefinitions"]}, "parameters": []}, "/clientcustomfielddefinitions/{id}/": {"get": {"operationId": "clientcustomfielddefinitions_read", "summary": "This endpoint represents the client custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ClientCustomFieldDefinition"}}}, "tags": ["clientcustomfielddefinitions"]}, "put": {"operationId": "clientcustomfielddefinitions_update", "summary": "This endpoint represents the client custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ClientCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ClientCustomFieldDefinition"}}}, "tags": ["clientcustomfielddefinitions"]}, "delete": {"operationId": "clientcustomfielddefinitions_delete", "summary": "This endpoint represents the client custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["clientcustomfielddefinitions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/clients/": {"get": {"operationId": "clients_list", "summary": "This endpoint represents the link between clients.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `alternative_names`\n* `billing_instructions`\n* `branches` - list of ids\n* `contact` - contact id\n* `currency` - derived field (string)\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date`\n* `description`\n* `engagement_letter_status` - possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `is_billable`\n* `is_identified`\n* `name`\n* `number`\n* `office_expenses_rate` - derived field (decimal)\n* `originating_user` - user id\n* `parent_client` - client id\n* `reduction_rate`\n* `referrer` - referrer id\n* `sector` - sector id\n* `tags` - list of strings\n* `price_list` - price list id\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-08-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-08-01T15:30:15`\n* `contact`, eg. `?contact=1`\n* `name__icontains`, eg. `?name__icontains=de` (case insensitive substring search)\n* `number`, eg. `?number=1001`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `alternative_names`\n* `archived_date`\n* `branches`\n* `billing_instructions`\n* `client_status`\n* `contact`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `description`\n* `display_name`\n* `engagement_letter_status`\n* `id`\n* `is_billable`\n* `is_identified`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `originating_user`\n* `parent_client`\n* `price_list`\n* `reduction_rate`\n* `referrer`\n* `sector`\n* `softkill_status`\n* `tags`\n* `url`\n\n For instance: ?extra_fields=modified_date,number", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "softkill_status", "in": "query", "description": "softkill_status", "required": false, "type": "string"}, {"name": "tags", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "archived_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "archived_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "contact", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name__icontains", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- archived_date\n- tags\n- alternative_names\n- branches\n- billing_instructions\n- client_status\n- contact\n- currency\n- custom_fields\n- date\n- description\n- display_name\n- engagement_letter_status\n- id\n- is_billable\n- is_identified\n- name\n- number\n- office_expenses_rate\n- originating_user\n- parent_client\n- price_list\n- reduction_rate\n- referrer\n- sector\n- softkill_status\n- url", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Client"}}}}}}, "tags": ["clients"]}, "post": {"operationId": "clients_create", "summary": "This endpoint represents the link between clients.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `alternative_names`\n* `billing_instructions`\n* `branches` - list of ids\n* `contact` - contact id\n* `currency` - derived field (string)\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date`\n* `description`\n* `engagement_letter_status` - possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `is_billable`\n* `is_identified`\n* `name`\n* `number`\n* `office_expenses_rate` - derived field (decimal)\n* `originating_user` - user id\n* `parent_client` - client id\n* `reduction_rate`\n* `referrer` - referrer id\n* `sector` - sector id\n* `tags` - list of strings\n* `price_list` - price list id\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-08-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-08-01T15:30:15`\n* `contact`, eg. `?contact=1`\n* `name__icontains`, eg. `?name__icontains=de` (case insensitive substring search)\n* `number`, eg. `?number=1001`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `alternative_names`\n* `archived_date`\n* `branches`\n* `billing_instructions`\n* `client_status`\n* `contact`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `description`\n* `display_name`\n* `engagement_letter_status`\n* `id`\n* `is_billable`\n* `is_identified`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `originating_user`\n* `parent_client`\n* `price_list`\n* `reduction_rate`\n* `referrer`\n* `sector`\n* `softkill_status`\n* `tags`\n* `url`\n\n For instance: ?extra_fields=modified_date,number", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Client"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Client"}}}, "tags": ["clients"]}, "parameters": []}, "/clients/{id}/": {"get": {"operationId": "clients_read", "summary": "This endpoint represents the link between clients.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `alternative_names`\n* `billing_instructions`\n* `branches` - list of ids\n* `contact` - contact id\n* `currency` - derived field (string)\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date`\n* `description`\n* `engagement_letter_status` - possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `is_billable`\n* `is_identified`\n* `name`\n* `number`\n* `office_expenses_rate` - derived field (decimal)\n* `originating_user` - user id\n* `parent_client` - client id\n* `reduction_rate`\n* `referrer` - referrer id\n* `sector` - sector id\n* `tags` - list of strings\n* `price_list` - price list id\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-08-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-08-01T15:30:15`\n* `contact`, eg. `?contact=1`\n* `name__icontains`, eg. `?name__icontains=de` (case insensitive substring search)\n* `number`, eg. `?number=1001`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `alternative_names`\n* `archived_date`\n* `branches`\n* `billing_instructions`\n* `client_status`\n* `contact`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `description`\n* `display_name`\n* `engagement_letter_status`\n* `id`\n* `is_billable`\n* `is_identified`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `originating_user`\n* `parent_client`\n* `price_list`\n* `reduction_rate`\n* `referrer`\n* `sector`\n* `softkill_status`\n* `tags`\n* `url`\n\n For instance: ?extra_fields=modified_date,number", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Client"}}}, "tags": ["clients"]}, "put": {"operationId": "clients_update", "summary": "This endpoint represents the link between clients.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `alternative_names`\n* `billing_instructions`\n* `branches` - list of ids\n* `contact` - contact id\n* `currency` - derived field (string)\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date`\n* `description`\n* `engagement_letter_status` - possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `is_billable`\n* `is_identified`\n* `name`\n* `number`\n* `office_expenses_rate` - derived field (decimal)\n* `originating_user` - user id\n* `parent_client` - client id\n* `reduction_rate`\n* `referrer` - referrer id\n* `sector` - sector id\n* `tags` - list of strings\n* `price_list` - price list id\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-08-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-08-01T15:30:15`\n* `contact`, eg. `?contact=1`\n* `name__icontains`, eg. `?name__icontains=de` (case insensitive substring search)\n* `number`, eg. `?number=1001`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `alternative_names`\n* `archived_date`\n* `branches`\n* `billing_instructions`\n* `client_status`\n* `contact`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `description`\n* `display_name`\n* `engagement_letter_status`\n* `id`\n* `is_billable`\n* `is_identified`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `originating_user`\n* `parent_client`\n* `price_list`\n* `reduction_rate`\n* `referrer`\n* `sector`\n* `softkill_status`\n* `tags`\n* `url`\n\n For instance: ?extra_fields=modified_date,number", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Client"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Client"}}}, "tags": ["clients"]}, "delete": {"operationId": "clients_delete", "summary": "This endpoint represents the link between clients.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `alternative_names`\n* `billing_instructions`\n* `branches` - list of ids\n* `contact` - contact id\n* `currency` - derived field (string)\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date`\n* `description`\n* `engagement_letter_status` - possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `is_billable`\n* `is_identified`\n* `name`\n* `number`\n* `office_expenses_rate` - derived field (decimal)\n* `originating_user` - user id\n* `parent_client` - client id\n* `reduction_rate`\n* `referrer` - referrer id\n* `sector` - sector id\n* `tags` - list of strings\n* `price_list` - price list id\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-08-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-08-01T15:30:15`\n* `contact`, eg. `?contact=1`\n* `name__icontains`, eg. `?name__icontains=de` (case insensitive substring search)\n* `number`, eg. `?number=1001`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `alternative_names`\n* `archived_date`\n* `branches`\n* `billing_instructions`\n* `client_status`\n* `contact`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `description`\n* `display_name`\n* `engagement_letter_status`\n* `id`\n* `is_billable`\n* `is_identified`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `originating_user`\n* `parent_client`\n* `price_list`\n* `reduction_rate`\n* `referrer`\n* `sector`\n* `softkill_status`\n* `tags`\n* `url`\n\n For instance: ?extra_fields=modified_date,number", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["clients"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/clientstatuses/": {"get": {"operationId": "clientstatuses_list", "summary": "This endpoint represents the client statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ClientStatus"}}}}}}, "tags": ["clientstatuses"]}, "post": {"operationId": "clientstatuses_create", "summary": "This endpoint represents the client statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ClientStatus"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ClientStatus"}}}, "tags": ["clientstatuses"]}, "parameters": []}, "/clientstatuses/{id}/": {"get": {"operationId": "clientstatuses_read", "summary": "This endpoint represents the client statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ClientStatus"}}}, "tags": ["clientstatuses"]}, "put": {"operationId": "clientstatuses_update", "summary": "This endpoint represents the client statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ClientStatus"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ClientStatus"}}}, "tags": ["clientstatuses"]}, "delete": {"operationId": "clientstatuses_delete", "summary": "This endpoint represents the client statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["clientstatuses"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/contactcontacts/": {"get": {"operationId": "contactcontacts_list", "summary": "This endpoint represents the link between contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `default_address`\n* `is_primary_organization`\n* `job_description`\n* `organization`\n* `person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `organization`, eg. `?organization=11`\n* `person`, eg. `?person=2`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "organization", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "person", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ContactContact"}}}}}}, "tags": ["contactcontacts"]}, "post": {"operationId": "contactcontacts_create", "summary": "This endpoint represents the link between contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `default_address`\n* `is_primary_organization`\n* `job_description`\n* `organization`\n* `person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `organization`, eg. `?organization=11`\n* `person`, eg. `?person=2`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactContact"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ContactContact"}}}, "tags": ["contactcontacts"]}, "parameters": []}, "/contactcontacts/{id}/": {"get": {"operationId": "contactcontacts_read", "summary": "This endpoint represents the link between contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `default_address`\n* `is_primary_organization`\n* `job_description`\n* `organization`\n* `person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `organization`, eg. `?organization=11`\n* `person`, eg. `?person=2`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactContact"}}}, "tags": ["contactcontacts"]}, "put": {"operationId": "contactcontacts_update", "summary": "This endpoint represents the link between contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `default_address`\n* `is_primary_organization`\n* `job_description`\n* `organization`\n* `person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `organization`, eg. `?organization=11`\n* `person`, eg. `?person=2`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactContact"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactContact"}}}, "tags": ["contactcontacts"]}, "delete": {"operationId": "contactcontacts_delete", "summary": "This endpoint represents the link between contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `default_address`\n* `is_primary_organization`\n* `job_description`\n* `organization`\n* `person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `organization`, eg. `?organization=11`\n* `person`, eg. `?person=2`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["contactcontacts"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/contactcustomfielddefinitions/": {"get": {"operationId": "contactcustomfielddefinitions_list", "summary": "This endpoint represents the contact custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "excel_export", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "identifier", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "read_only", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "required", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ContactCustomFieldDefinition"}}}}}}, "tags": ["contactcustomfielddefinitions"]}, "post": {"operationId": "contactcustomfielddefinitions_create", "summary": "This endpoint represents the contact custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ContactCustomFieldDefinition"}}}, "tags": ["contactcustomfielddefinitions"]}, "parameters": []}, "/contactcustomfielddefinitions/{id}/": {"get": {"operationId": "contactcustomfielddefinitions_read", "summary": "This endpoint represents the contact custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactCustomFieldDefinition"}}}, "tags": ["contactcustomfielddefinitions"]}, "put": {"operationId": "contactcustomfielddefinitions_update", "summary": "This endpoint represents the contact custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactCustomFieldDefinition"}}}, "tags": ["contactcustomfielddefinitions"]}, "delete": {"operationId": "contactcustomfielddefinitions_delete", "summary": "This endpoint represents the contact custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["contactcustomfielddefinitions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/contactdetailkinds/": {"get": {"operationId": "contactdetailkinds_list", "summary": "This endpoint represents the Contact Detail Types (Kinds).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `name`\n* `identifier` - unique internal identifier (read-only, automatically generated).\n* `weight` - integer determining sorting order (read-only, automatically assigned).\n* `validation_method` - choices:\n * `email` (Email)\n * `url` (URL)\n * `text` (Text)\n* `icon` - choices:\n * `email`\n * `mobile_phone`\n * `phone`\n * `fax`\n * `website`\n * `other`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `identifier`, eg. `?identifier=social_linkedin`\n* `name__icontains`, eg. `?name__icontains=email`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `icon`\n * `identifier`\n * `name`\n * `validation_method`\n * `weight`\n\nFor instance: ?extra_fields=identifier,icon", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "identifier", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name__icontains", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- name\n- identifier\n- validation_method\n- weight\n- icon", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ContactDetailKind"}}}}}}, "tags": ["contactdetailkinds"]}, "post": {"operationId": "contactdetailkinds_create", "summary": "This endpoint represents the Contact Detail Types (Kinds).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `name`\n* `identifier` - unique internal identifier (read-only, automatically generated).\n* `weight` - integer determining sorting order (read-only, automatically assigned).\n* `validation_method` - choices:\n * `email` (Email)\n * `url` (URL)\n * `text` (Text)\n* `icon` - choices:\n * `email`\n * `mobile_phone`\n * `phone`\n * `fax`\n * `website`\n * `other`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `identifier`, eg. `?identifier=social_linkedin`\n* `name__icontains`, eg. `?name__icontains=email`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `icon`\n * `identifier`\n * `name`\n * `validation_method`\n * `weight`\n\nFor instance: ?extra_fields=identifier,icon", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactDetailKind"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ContactDetailKind"}}}, "tags": ["contactdetailkinds"]}, "parameters": []}, "/contactdetailkinds/{id}/": {"get": {"operationId": "contactdetailkinds_read", "summary": "This endpoint represents the Contact Detail Types (Kinds).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `name`\n* `identifier` - unique internal identifier (read-only, automatically generated).\n* `weight` - integer determining sorting order (read-only, automatically assigned).\n* `validation_method` - choices:\n * `email` (Email)\n * `url` (URL)\n * `text` (Text)\n* `icon` - choices:\n * `email`\n * `mobile_phone`\n * `phone`\n * `fax`\n * `website`\n * `other`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `identifier`, eg. `?identifier=social_linkedin`\n* `name__icontains`, eg. `?name__icontains=email`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `icon`\n * `identifier`\n * `name`\n * `validation_method`\n * `weight`\n\nFor instance: ?extra_fields=identifier,icon", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactDetailKind"}}}, "tags": ["contactdetailkinds"]}, "put": {"operationId": "contactdetailkinds_update", "summary": "This endpoint represents the Contact Detail Types (Kinds).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `name`\n* `identifier` - unique internal identifier (read-only, automatically generated).\n* `weight` - integer determining sorting order (read-only, automatically assigned).\n* `validation_method` - choices:\n * `email` (Email)\n * `url` (URL)\n * `text` (Text)\n* `icon` - choices:\n * `email`\n * `mobile_phone`\n * `phone`\n * `fax`\n * `website`\n * `other`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `identifier`, eg. `?identifier=social_linkedin`\n* `name__icontains`, eg. `?name__icontains=email`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `icon`\n * `identifier`\n * `name`\n * `validation_method`\n * `weight`\n\nFor instance: ?extra_fields=identifier,icon", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactDetailKind"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactDetailKind"}}}, "tags": ["contactdetailkinds"]}, "delete": {"operationId": "contactdetailkinds_delete", "summary": "This endpoint represents the Contact Detail Types (Kinds).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `name`\n* `identifier` - unique internal identifier (read-only, automatically generated).\n* `weight` - integer determining sorting order (read-only, automatically assigned).\n* `validation_method` - choices:\n * `email` (Email)\n * `url` (URL)\n * `text` (Text)\n* `icon` - choices:\n * `email`\n * `mobile_phone`\n * `phone`\n * `fax`\n * `website`\n * `other`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `identifier`, eg. `?identifier=social_linkedin`\n* `name__icontains`, eg. `?name__icontains=email`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `icon`\n * `identifier`\n * `name`\n * `validation_method`\n * `weight`\n\nFor instance: ?extra_fields=identifier,icon", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["contactdetailkinds"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/contactdetails/": {"get": {"operationId": "contactdetails_list", "summary": "This endpoint represents the read_only contact details.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `kind`\n* `value`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `contact`, eg. `?contact=1`\n* `kind`, eg. `?kind=1`\n* `value`, eg. `?value=test@email.com`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "contact", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "kind", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "value", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- contact\n- kind\n- value", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ContactDetail"}}}}}}, "tags": ["contactdetails"]}, "parameters": []}, "/contactdetails/{id}/": {"get": {"operationId": "contactdetails_read", "summary": "This endpoint represents the read_only contact details.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `kind`\n* `value`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `contact`, eg. `?contact=1`\n* `kind`, eg. `?kind=1`\n* `value`, eg. `?value=test@email.com`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactDetail"}}}, "tags": ["contactdetails"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/contactkinds/": {"get": {"operationId": "contactkinds_list", "summary": "This endpoint represents the contact kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ContactKind"}}}}}}, "tags": ["contactkinds"]}, "post": {"operationId": "contactkinds_create", "summary": "This endpoint represents the contact kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactKind"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ContactKind"}}}, "tags": ["contactkinds"]}, "parameters": []}, "/contactkinds/{id}/": {"get": {"operationId": "contactkinds_read", "summary": "This endpoint represents the contact kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactKind"}}}, "tags": ["contactkinds"]}, "put": {"operationId": "contactkinds_update", "summary": "This endpoint represents the contact kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactKind"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactKind"}}}, "tags": ["contactkinds"]}, "delete": {"operationId": "contactkinds_delete", "summary": "This endpoint represents the contact kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["contactkinds"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/contacts/": {"get": {"operationId": "contacts_list", "summary": "This endpoint represents the contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `url`\n* `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `account_manager_user`\n* `address_label_name` - derived field (string)\n* `default_billing_address` -\n on write (POST/PUT) accepts three shapes:\n * `null` - clears the field. Rejected when the contact is a debtor,\n since debtors require a billing address.\n * an integer PK referencing an existing Address. The address must\n either already belong to this contact (PUT) or be contact-less\n (POST/PUT, in which case it is adopted into the contact's\n `address_set`). Addresses owned by another contact are rejected.\n * an inline object that creates a new Address atomically, bound to\n the contact. Accepts the fields of the address endpoint, e.g.\n `{\"address\": \"Teststraat 1\", \"city\": \"Amsterdam\", \"zipcode\": \"1011 AA\", \"country\": \"Nederland\"}`.\n* `firm`\n* `notes`\n* `details` - list of objects. Single object has following structure:\n * `kind` - contact kind identifier\n * `value`\n * `is_billing_to_email` - applicable only for emails\n * `is_billing_cc_email` - applicable only for emails\n * `is_dunning_to_email` - applicable only for emails\n * `is_dunning_cc_email` - applicable only for emails\n* `is_debtor`\n* `is_organization`\n* `tags` - list of strings\n\nWhen `is_debtor` is true, following fields are available:\n\n* `add_payment_link` - derived field (boolean)\n* `bank_account_iban`\n* `bank_account_bic` - applicable when `bank_account_iban` is provided and is foreign country number\n* `has_dunning`\n* `invoice_attachment_type` - derived field\n* `invoice_language`\n* `invoice_send_method` - choices:\n snail mail = 1\n email = 2\n both = 3\n* `number` - leave empty to assign number automatically\n* `payment_deadline` - derived field (int)\n* `tax_scheme` - choices:\n national = 1\n ICP = 2\n non-ICP = 3\n no tax = 4\n international = 5\n* `vat_number`\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n\nWhen `is_organization` is true, following fields are available:\n* `organization_kind` - it refers to \"legal entity\", choices:\n domestic legal entity = 1\n foreign legal entity = 2\n partnership = 3\n trust = 4\n* `organization_kind_subtype` it refers to \"legal entity subtype\"\n* `organization_name`\n* `organization_number`\n* `default_contact_person`\n\nWhen `is_organization` is false, following fields are available:\n\n* `attention` - e.g. Attn., P/a. or send an empty string to use the default of the address template\n* `birthdate`\n* `identification_number`\n* `first_name`\n* `gender` - choices:\n male = 1\n female = 2\n neutral = 3\n* `last_name`\n* `initials`\n* `mailing_option`\n* `name_prefix`\n* `salutation`\n* `title`\n* `suffix_title`\n\nWhen `is_debtor` is true and `is_organization` is true, following fields are available:\n\n* `peppol_id`\n* `peppol_company_id`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-01-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-01-01T15:30:15`\n* `any_phone_number`, e.g. `?any_phone_number=12345`\n* `is_organization`, e.g. `?is_organization=true`\n* `name__icontains`, e.g. `?name__icontains=contact name`\n* `number`, e.g. `?number=1001`\n* `tags`, e.g. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `account_manager_user`, e.g. `?account_manager_user=123`\n* `address_label_name`, e.g. `?address_label_name=Main`\n* `attention`, e.g. `?attention=John`\n* `bank_account_iban`, e.g. `?bank_account_iban=NL00TEST0123456789`\n* `billing_cc_email`, e.g. `?billing_cc_email=test@example.com`\n* `billing_to_email`, e.g. `?billing_to_email=test@example.com`\n* `birthdate`, e.g. `?birthdate=1990-01-01`\n* `coc_number`, e.g. `?coc_number=12345678`\n* `default_billing_address`, e.g. `?default_billing_address=5`\n* `default_contact_person`, e.g. `?default_contact_person=42`\n* `dunning_to_email`, e.g. `?dunning_to_email=dunning@example.com`\n* `first_name`, e.g. `?first_name=Jane`\n* `gender`, e.g. `?gender=1`\n * `1` – Male\n * `2` – Female\n * `3` – Neutral/Other\n* `has_dunning`, e.g. `?has_dunning=true`\n* `identification_number`, e.g. `?identification_number=ID123`\n* `initials`, e.g. `?initials=J.D.`\n* `invoice_language`, e.g. `?invoice_language=nl`\n* `invoice_send_method`, e.g. `?invoice_send_method=2`\n * `1` – By regular mail\n * `2` – By email\n * `3` – By regular mail and email\n * `4` – E-billing\n* `is_debtor`, e.g. `?is_debtor=true`\n* `last_name`, e.g. `?last_name=Doe`\n* `name_prefix`, e.g. `?name_prefix=van`\n* `notes`, e.g. `?notes=VIP client`\n* `organization_name`, e.g. `?organization_name=Acme Corp`\n* `payment_deadline`, e.g. `?payment_deadline=30`\n* `salutation`, e.g. `?salutation=Mr.`\n* `tax_scheme`, e.g. `?tax_scheme=1`\n * `1` – Default\n * `2` – Intra-community (EU)\n * `3` – Outside of the EU\n * `4` – None\n * `5` – International\n* `title`, e.g. `?title=Dr.`\n* `vat_number`, e.g. `?vat_number=NL123456789B01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `account_manager_user`\n * `add_payment_link`\n * `address_label_name`\n * `archived_date`\n * `bank_account_bic`\n * `bank_account_iban`\n * `created_date`\n * `custom_fields`\n * `default_billing_address`\n * `default_contact_person`\n * `details`\n * `display_name`\n * `email`\n * `firm`\n * `first_name`\n * `gender`\n * `has_dunning`\n * `id`\n * `invoice_attachment_type`\n * `invoice_language`\n * `invoice_send_method`\n * `is_debtor`\n * `is_organization`\n * `last_name`\n * `modified_date`\n * `name_prefix`\n * `notes`\n * `number`\n * `organization_kind`\n * `organization_kind_subtype`\n * `organization_name`\n * `organization_number`\n * `payment_deadline`\n * `peppol_id`\n * `peppol_company_id`\n * `primary_organization`\n * `softkill_status`\n * `tags`\n * `tax_scheme`\n * `url`\n * `vat_number`\n\n For instance: ?extra_fields=modified_date\n\n **Usage with Permissions:**\n\n * To utilize the `extra_fields` feature, the requesting user must have `PERMIT_VIEW_CONTACT`.\n * The `extra_fields` parameter should not be present in the query parameters\n if the user does not have the appropriate permission.\n If the parameter is present without the required permission, access will be denied.", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "softkill_status", "in": "query", "description": "softkill_status", "required": false, "type": "string"}, {"name": "tags", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "account_manager_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "address_label_name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "archived_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "archived_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "attention", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "bank_account_iban", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billing_cc_email", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billing_to_email", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "birthdate", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "coc_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "default_billing_address", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "default_contact_person", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "dunning_to_email", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "first_name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "gender", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "has_dunning", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "identification_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "initials", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_language", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_send_method", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_debtor", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_organization", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "last_name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name__icontains", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name_prefix", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notes", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "organization_name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "payment_deadline", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "salutation", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "tax_scheme", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "title", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "vat_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "any_phone_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ContactList"}}}}}}, "tags": ["contacts"]}, "post": {"operationId": "contacts_create", "summary": "This endpoint represents the contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `url`\n* `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `account_manager_user`\n* `address_label_name` - derived field (string)\n* `default_billing_address` -\n on write (POST/PUT) accepts three shapes:\n * `null` - clears the field. Rejected when the contact is a debtor,\n since debtors require a billing address.\n * an integer PK referencing an existing Address. The address must\n either already belong to this contact (PUT) or be contact-less\n (POST/PUT, in which case it is adopted into the contact's\n `address_set`). Addresses owned by another contact are rejected.\n * an inline object that creates a new Address atomically, bound to\n the contact. Accepts the fields of the address endpoint, e.g.\n `{\"address\": \"Teststraat 1\", \"city\": \"Amsterdam\", \"zipcode\": \"1011 AA\", \"country\": \"Nederland\"}`.\n* `firm`\n* `notes`\n* `details` - list of objects. Single object has following structure:\n * `kind` - contact kind identifier\n * `value`\n * `is_billing_to_email` - applicable only for emails\n * `is_billing_cc_email` - applicable only for emails\n * `is_dunning_to_email` - applicable only for emails\n * `is_dunning_cc_email` - applicable only for emails\n* `is_debtor`\n* `is_organization`\n* `tags` - list of strings\n\nWhen `is_debtor` is true, following fields are available:\n\n* `add_payment_link` - derived field (boolean)\n* `bank_account_iban`\n* `bank_account_bic` - applicable when `bank_account_iban` is provided and is foreign country number\n* `has_dunning`\n* `invoice_attachment_type` - derived field\n* `invoice_language`\n* `invoice_send_method` - choices:\n snail mail = 1\n email = 2\n both = 3\n* `number` - leave empty to assign number automatically\n* `payment_deadline` - derived field (int)\n* `tax_scheme` - choices:\n national = 1\n ICP = 2\n non-ICP = 3\n no tax = 4\n international = 5\n* `vat_number`\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n\nWhen `is_organization` is true, following fields are available:\n* `organization_kind` - it refers to \"legal entity\", choices:\n domestic legal entity = 1\n foreign legal entity = 2\n partnership = 3\n trust = 4\n* `organization_kind_subtype` it refers to \"legal entity subtype\"\n* `organization_name`\n* `organization_number`\n* `default_contact_person`\n\nWhen `is_organization` is false, following fields are available:\n\n* `attention` - e.g. Attn., P/a. or send an empty string to use the default of the address template\n* `birthdate`\n* `identification_number`\n* `first_name`\n* `gender` - choices:\n male = 1\n female = 2\n neutral = 3\n* `last_name`\n* `initials`\n* `mailing_option`\n* `name_prefix`\n* `salutation`\n* `title`\n* `suffix_title`\n\nWhen `is_debtor` is true and `is_organization` is true, following fields are available:\n\n* `peppol_id`\n* `peppol_company_id`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-01-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-01-01T15:30:15`\n* `any_phone_number`, e.g. `?any_phone_number=12345`\n* `is_organization`, e.g. `?is_organization=true`\n* `name__icontains`, e.g. `?name__icontains=contact name`\n* `number`, e.g. `?number=1001`\n* `tags`, e.g. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `account_manager_user`, e.g. `?account_manager_user=123`\n* `address_label_name`, e.g. `?address_label_name=Main`\n* `attention`, e.g. `?attention=John`\n* `bank_account_iban`, e.g. `?bank_account_iban=NL00TEST0123456789`\n* `billing_cc_email`, e.g. `?billing_cc_email=test@example.com`\n* `billing_to_email`, e.g. `?billing_to_email=test@example.com`\n* `birthdate`, e.g. `?birthdate=1990-01-01`\n* `coc_number`, e.g. `?coc_number=12345678`\n* `default_billing_address`, e.g. `?default_billing_address=5`\n* `default_contact_person`, e.g. `?default_contact_person=42`\n* `dunning_to_email`, e.g. `?dunning_to_email=dunning@example.com`\n* `first_name`, e.g. `?first_name=Jane`\n* `gender`, e.g. `?gender=1`\n * `1` – Male\n * `2` – Female\n * `3` – Neutral/Other\n* `has_dunning`, e.g. `?has_dunning=true`\n* `identification_number`, e.g. `?identification_number=ID123`\n* `initials`, e.g. `?initials=J.D.`\n* `invoice_language`, e.g. `?invoice_language=nl`\n* `invoice_send_method`, e.g. `?invoice_send_method=2`\n * `1` – By regular mail\n * `2` – By email\n * `3` – By regular mail and email\n * `4` – E-billing\n* `is_debtor`, e.g. `?is_debtor=true`\n* `last_name`, e.g. `?last_name=Doe`\n* `name_prefix`, e.g. `?name_prefix=van`\n* `notes`, e.g. `?notes=VIP client`\n* `organization_name`, e.g. `?organization_name=Acme Corp`\n* `payment_deadline`, e.g. `?payment_deadline=30`\n* `salutation`, e.g. `?salutation=Mr.`\n* `tax_scheme`, e.g. `?tax_scheme=1`\n * `1` – Default\n * `2` – Intra-community (EU)\n * `3` – Outside of the EU\n * `4` – None\n * `5` – International\n* `title`, e.g. `?title=Dr.`\n* `vat_number`, e.g. `?vat_number=NL123456789B01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `account_manager_user`\n * `add_payment_link`\n * `address_label_name`\n * `archived_date`\n * `bank_account_bic`\n * `bank_account_iban`\n * `created_date`\n * `custom_fields`\n * `default_billing_address`\n * `default_contact_person`\n * `details`\n * `display_name`\n * `email`\n * `firm`\n * `first_name`\n * `gender`\n * `has_dunning`\n * `id`\n * `invoice_attachment_type`\n * `invoice_language`\n * `invoice_send_method`\n * `is_debtor`\n * `is_organization`\n * `last_name`\n * `modified_date`\n * `name_prefix`\n * `notes`\n * `number`\n * `organization_kind`\n * `organization_kind_subtype`\n * `organization_name`\n * `organization_number`\n * `payment_deadline`\n * `peppol_id`\n * `peppol_company_id`\n * `primary_organization`\n * `softkill_status`\n * `tags`\n * `tax_scheme`\n * `url`\n * `vat_number`\n\n For instance: ?extra_fields=modified_date\n\n **Usage with Permissions:**\n\n * To utilize the `extra_fields` feature, the requesting user must have `PERMIT_VIEW_CONTACT`.\n * The `extra_fields` parameter should not be present in the query parameters\n if the user does not have the appropriate permission.\n If the parameter is present without the required permission, access will be denied.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactDebtorPerson"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ContactDebtorPerson"}}}, "tags": ["contacts"]}, "parameters": []}, "/contacts/{id}/": {"get": {"operationId": "contacts_read", "summary": "This endpoint represents the contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `url`\n* `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `account_manager_user`\n* `address_label_name` - derived field (string)\n* `default_billing_address` -\n on write (POST/PUT) accepts three shapes:\n * `null` - clears the field. Rejected when the contact is a debtor,\n since debtors require a billing address.\n * an integer PK referencing an existing Address. The address must\n either already belong to this contact (PUT) or be contact-less\n (POST/PUT, in which case it is adopted into the contact's\n `address_set`). Addresses owned by another contact are rejected.\n * an inline object that creates a new Address atomically, bound to\n the contact. Accepts the fields of the address endpoint, e.g.\n `{\"address\": \"Teststraat 1\", \"city\": \"Amsterdam\", \"zipcode\": \"1011 AA\", \"country\": \"Nederland\"}`.\n* `firm`\n* `notes`\n* `details` - list of objects. Single object has following structure:\n * `kind` - contact kind identifier\n * `value`\n * `is_billing_to_email` - applicable only for emails\n * `is_billing_cc_email` - applicable only for emails\n * `is_dunning_to_email` - applicable only for emails\n * `is_dunning_cc_email` - applicable only for emails\n* `is_debtor`\n* `is_organization`\n* `tags` - list of strings\n\nWhen `is_debtor` is true, following fields are available:\n\n* `add_payment_link` - derived field (boolean)\n* `bank_account_iban`\n* `bank_account_bic` - applicable when `bank_account_iban` is provided and is foreign country number\n* `has_dunning`\n* `invoice_attachment_type` - derived field\n* `invoice_language`\n* `invoice_send_method` - choices:\n snail mail = 1\n email = 2\n both = 3\n* `number` - leave empty to assign number automatically\n* `payment_deadline` - derived field (int)\n* `tax_scheme` - choices:\n national = 1\n ICP = 2\n non-ICP = 3\n no tax = 4\n international = 5\n* `vat_number`\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n\nWhen `is_organization` is true, following fields are available:\n* `organization_kind` - it refers to \"legal entity\", choices:\n domestic legal entity = 1\n foreign legal entity = 2\n partnership = 3\n trust = 4\n* `organization_kind_subtype` it refers to \"legal entity subtype\"\n* `organization_name`\n* `organization_number`\n* `default_contact_person`\n\nWhen `is_organization` is false, following fields are available:\n\n* `attention` - e.g. Attn., P/a. or send an empty string to use the default of the address template\n* `birthdate`\n* `identification_number`\n* `first_name`\n* `gender` - choices:\n male = 1\n female = 2\n neutral = 3\n* `last_name`\n* `initials`\n* `mailing_option`\n* `name_prefix`\n* `salutation`\n* `title`\n* `suffix_title`\n\nWhen `is_debtor` is true and `is_organization` is true, following fields are available:\n\n* `peppol_id`\n* `peppol_company_id`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-01-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-01-01T15:30:15`\n* `any_phone_number`, e.g. `?any_phone_number=12345`\n* `is_organization`, e.g. `?is_organization=true`\n* `name__icontains`, e.g. `?name__icontains=contact name`\n* `number`, e.g. `?number=1001`\n* `tags`, e.g. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `account_manager_user`, e.g. `?account_manager_user=123`\n* `address_label_name`, e.g. `?address_label_name=Main`\n* `attention`, e.g. `?attention=John`\n* `bank_account_iban`, e.g. `?bank_account_iban=NL00TEST0123456789`\n* `billing_cc_email`, e.g. `?billing_cc_email=test@example.com`\n* `billing_to_email`, e.g. `?billing_to_email=test@example.com`\n* `birthdate`, e.g. `?birthdate=1990-01-01`\n* `coc_number`, e.g. `?coc_number=12345678`\n* `default_billing_address`, e.g. `?default_billing_address=5`\n* `default_contact_person`, e.g. `?default_contact_person=42`\n* `dunning_to_email`, e.g. `?dunning_to_email=dunning@example.com`\n* `first_name`, e.g. `?first_name=Jane`\n* `gender`, e.g. `?gender=1`\n * `1` – Male\n * `2` – Female\n * `3` – Neutral/Other\n* `has_dunning`, e.g. `?has_dunning=true`\n* `identification_number`, e.g. `?identification_number=ID123`\n* `initials`, e.g. `?initials=J.D.`\n* `invoice_language`, e.g. `?invoice_language=nl`\n* `invoice_send_method`, e.g. `?invoice_send_method=2`\n * `1` – By regular mail\n * `2` – By email\n * `3` – By regular mail and email\n * `4` – E-billing\n* `is_debtor`, e.g. `?is_debtor=true`\n* `last_name`, e.g. `?last_name=Doe`\n* `name_prefix`, e.g. `?name_prefix=van`\n* `notes`, e.g. `?notes=VIP client`\n* `organization_name`, e.g. `?organization_name=Acme Corp`\n* `payment_deadline`, e.g. `?payment_deadline=30`\n* `salutation`, e.g. `?salutation=Mr.`\n* `tax_scheme`, e.g. `?tax_scheme=1`\n * `1` – Default\n * `2` – Intra-community (EU)\n * `3` – Outside of the EU\n * `4` – None\n * `5` – International\n* `title`, e.g. `?title=Dr.`\n* `vat_number`, e.g. `?vat_number=NL123456789B01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `account_manager_user`\n * `add_payment_link`\n * `address_label_name`\n * `archived_date`\n * `bank_account_bic`\n * `bank_account_iban`\n * `created_date`\n * `custom_fields`\n * `default_billing_address`\n * `default_contact_person`\n * `details`\n * `display_name`\n * `email`\n * `firm`\n * `first_name`\n * `gender`\n * `has_dunning`\n * `id`\n * `invoice_attachment_type`\n * `invoice_language`\n * `invoice_send_method`\n * `is_debtor`\n * `is_organization`\n * `last_name`\n * `modified_date`\n * `name_prefix`\n * `notes`\n * `number`\n * `organization_kind`\n * `organization_kind_subtype`\n * `organization_name`\n * `organization_number`\n * `payment_deadline`\n * `peppol_id`\n * `peppol_company_id`\n * `primary_organization`\n * `softkill_status`\n * `tags`\n * `tax_scheme`\n * `url`\n * `vat_number`\n\n For instance: ?extra_fields=modified_date\n\n **Usage with Permissions:**\n\n * To utilize the `extra_fields` feature, the requesting user must have `PERMIT_VIEW_CONTACT`.\n * The `extra_fields` parameter should not be present in the query parameters\n if the user does not have the appropriate permission.\n If the parameter is present without the required permission, access will be denied.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactDebtorPerson"}}}, "tags": ["contacts"]}, "put": {"operationId": "contacts_update", "summary": "This endpoint represents the contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `url`\n* `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `account_manager_user`\n* `address_label_name` - derived field (string)\n* `default_billing_address` -\n on write (POST/PUT) accepts three shapes:\n * `null` - clears the field. Rejected when the contact is a debtor,\n since debtors require a billing address.\n * an integer PK referencing an existing Address. The address must\n either already belong to this contact (PUT) or be contact-less\n (POST/PUT, in which case it is adopted into the contact's\n `address_set`). Addresses owned by another contact are rejected.\n * an inline object that creates a new Address atomically, bound to\n the contact. Accepts the fields of the address endpoint, e.g.\n `{\"address\": \"Teststraat 1\", \"city\": \"Amsterdam\", \"zipcode\": \"1011 AA\", \"country\": \"Nederland\"}`.\n* `firm`\n* `notes`\n* `details` - list of objects. Single object has following structure:\n * `kind` - contact kind identifier\n * `value`\n * `is_billing_to_email` - applicable only for emails\n * `is_billing_cc_email` - applicable only for emails\n * `is_dunning_to_email` - applicable only for emails\n * `is_dunning_cc_email` - applicable only for emails\n* `is_debtor`\n* `is_organization`\n* `tags` - list of strings\n\nWhen `is_debtor` is true, following fields are available:\n\n* `add_payment_link` - derived field (boolean)\n* `bank_account_iban`\n* `bank_account_bic` - applicable when `bank_account_iban` is provided and is foreign country number\n* `has_dunning`\n* `invoice_attachment_type` - derived field\n* `invoice_language`\n* `invoice_send_method` - choices:\n snail mail = 1\n email = 2\n both = 3\n* `number` - leave empty to assign number automatically\n* `payment_deadline` - derived field (int)\n* `tax_scheme` - choices:\n national = 1\n ICP = 2\n non-ICP = 3\n no tax = 4\n international = 5\n* `vat_number`\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n\nWhen `is_organization` is true, following fields are available:\n* `organization_kind` - it refers to \"legal entity\", choices:\n domestic legal entity = 1\n foreign legal entity = 2\n partnership = 3\n trust = 4\n* `organization_kind_subtype` it refers to \"legal entity subtype\"\n* `organization_name`\n* `organization_number`\n* `default_contact_person`\n\nWhen `is_organization` is false, following fields are available:\n\n* `attention` - e.g. Attn., P/a. or send an empty string to use the default of the address template\n* `birthdate`\n* `identification_number`\n* `first_name`\n* `gender` - choices:\n male = 1\n female = 2\n neutral = 3\n* `last_name`\n* `initials`\n* `mailing_option`\n* `name_prefix`\n* `salutation`\n* `title`\n* `suffix_title`\n\nWhen `is_debtor` is true and `is_organization` is true, following fields are available:\n\n* `peppol_id`\n* `peppol_company_id`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-01-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-01-01T15:30:15`\n* `any_phone_number`, e.g. `?any_phone_number=12345`\n* `is_organization`, e.g. `?is_organization=true`\n* `name__icontains`, e.g. `?name__icontains=contact name`\n* `number`, e.g. `?number=1001`\n* `tags`, e.g. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `account_manager_user`, e.g. `?account_manager_user=123`\n* `address_label_name`, e.g. `?address_label_name=Main`\n* `attention`, e.g. `?attention=John`\n* `bank_account_iban`, e.g. `?bank_account_iban=NL00TEST0123456789`\n* `billing_cc_email`, e.g. `?billing_cc_email=test@example.com`\n* `billing_to_email`, e.g. `?billing_to_email=test@example.com`\n* `birthdate`, e.g. `?birthdate=1990-01-01`\n* `coc_number`, e.g. `?coc_number=12345678`\n* `default_billing_address`, e.g. `?default_billing_address=5`\n* `default_contact_person`, e.g. `?default_contact_person=42`\n* `dunning_to_email`, e.g. `?dunning_to_email=dunning@example.com`\n* `first_name`, e.g. `?first_name=Jane`\n* `gender`, e.g. `?gender=1`\n * `1` – Male\n * `2` – Female\n * `3` – Neutral/Other\n* `has_dunning`, e.g. `?has_dunning=true`\n* `identification_number`, e.g. `?identification_number=ID123`\n* `initials`, e.g. `?initials=J.D.`\n* `invoice_language`, e.g. `?invoice_language=nl`\n* `invoice_send_method`, e.g. `?invoice_send_method=2`\n * `1` – By regular mail\n * `2` – By email\n * `3` – By regular mail and email\n * `4` – E-billing\n* `is_debtor`, e.g. `?is_debtor=true`\n* `last_name`, e.g. `?last_name=Doe`\n* `name_prefix`, e.g. `?name_prefix=van`\n* `notes`, e.g. `?notes=VIP client`\n* `organization_name`, e.g. `?organization_name=Acme Corp`\n* `payment_deadline`, e.g. `?payment_deadline=30`\n* `salutation`, e.g. `?salutation=Mr.`\n* `tax_scheme`, e.g. `?tax_scheme=1`\n * `1` – Default\n * `2` – Intra-community (EU)\n * `3` – Outside of the EU\n * `4` – None\n * `5` – International\n* `title`, e.g. `?title=Dr.`\n* `vat_number`, e.g. `?vat_number=NL123456789B01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `account_manager_user`\n * `add_payment_link`\n * `address_label_name`\n * `archived_date`\n * `bank_account_bic`\n * `bank_account_iban`\n * `created_date`\n * `custom_fields`\n * `default_billing_address`\n * `default_contact_person`\n * `details`\n * `display_name`\n * `email`\n * `firm`\n * `first_name`\n * `gender`\n * `has_dunning`\n * `id`\n * `invoice_attachment_type`\n * `invoice_language`\n * `invoice_send_method`\n * `is_debtor`\n * `is_organization`\n * `last_name`\n * `modified_date`\n * `name_prefix`\n * `notes`\n * `number`\n * `organization_kind`\n * `organization_kind_subtype`\n * `organization_name`\n * `organization_number`\n * `payment_deadline`\n * `peppol_id`\n * `peppol_company_id`\n * `primary_organization`\n * `softkill_status`\n * `tags`\n * `tax_scheme`\n * `url`\n * `vat_number`\n\n For instance: ?extra_fields=modified_date\n\n **Usage with Permissions:**\n\n * To utilize the `extra_fields` feature, the requesting user must have `PERMIT_VIEW_CONTACT`.\n * The `extra_fields` parameter should not be present in the query parameters\n if the user does not have the appropriate permission.\n If the parameter is present without the required permission, access will be denied.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ContactDebtorPerson"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ContactDebtorPerson"}}}, "tags": ["contacts"]}, "delete": {"operationId": "contacts_delete", "summary": "This endpoint represents the contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `url`\n* `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `account_manager_user`\n* `address_label_name` - derived field (string)\n* `default_billing_address` -\n on write (POST/PUT) accepts three shapes:\n * `null` - clears the field. Rejected when the contact is a debtor,\n since debtors require a billing address.\n * an integer PK referencing an existing Address. The address must\n either already belong to this contact (PUT) or be contact-less\n (POST/PUT, in which case it is adopted into the contact's\n `address_set`). Addresses owned by another contact are rejected.\n * an inline object that creates a new Address atomically, bound to\n the contact. Accepts the fields of the address endpoint, e.g.\n `{\"address\": \"Teststraat 1\", \"city\": \"Amsterdam\", \"zipcode\": \"1011 AA\", \"country\": \"Nederland\"}`.\n* `firm`\n* `notes`\n* `details` - list of objects. Single object has following structure:\n * `kind` - contact kind identifier\n * `value`\n * `is_billing_to_email` - applicable only for emails\n * `is_billing_cc_email` - applicable only for emails\n * `is_dunning_to_email` - applicable only for emails\n * `is_dunning_cc_email` - applicable only for emails\n* `is_debtor`\n* `is_organization`\n* `tags` - list of strings\n\nWhen `is_debtor` is true, following fields are available:\n\n* `add_payment_link` - derived field (boolean)\n* `bank_account_iban`\n* `bank_account_bic` - applicable when `bank_account_iban` is provided and is foreign country number\n* `has_dunning`\n* `invoice_attachment_type` - derived field\n* `invoice_language`\n* `invoice_send_method` - choices:\n snail mail = 1\n email = 2\n both = 3\n* `number` - leave empty to assign number automatically\n* `payment_deadline` - derived field (int)\n* `tax_scheme` - choices:\n national = 1\n ICP = 2\n non-ICP = 3\n no tax = 4\n international = 5\n* `vat_number`\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n\nWhen `is_organization` is true, following fields are available:\n* `organization_kind` - it refers to \"legal entity\", choices:\n domestic legal entity = 1\n foreign legal entity = 2\n partnership = 3\n trust = 4\n* `organization_kind_subtype` it refers to \"legal entity subtype\"\n* `organization_name`\n* `organization_number`\n* `default_contact_person`\n\nWhen `is_organization` is false, following fields are available:\n\n* `attention` - e.g. Attn., P/a. or send an empty string to use the default of the address template\n* `birthdate`\n* `identification_number`\n* `first_name`\n* `gender` - choices:\n male = 1\n female = 2\n neutral = 3\n* `last_name`\n* `initials`\n* `mailing_option`\n* `name_prefix`\n* `salutation`\n* `title`\n* `suffix_title`\n\nWhen `is_debtor` is true and `is_organization` is true, following fields are available:\n\n* `peppol_id`\n* `peppol_company_id`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `archived_date__lte`, archived_date less than eg. `?archived_date__lte=2025-01-01T15:30:15`\n* `archived_date__gte`, archived_date greater than eg. `?archived_date__gte=2025-01-01T15:30:15`\n* `any_phone_number`, e.g. `?any_phone_number=12345`\n* `is_organization`, e.g. `?is_organization=true`\n* `name__icontains`, e.g. `?name__icontains=contact name`\n* `number`, e.g. `?number=1001`\n* `tags`, e.g. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `account_manager_user`, e.g. `?account_manager_user=123`\n* `address_label_name`, e.g. `?address_label_name=Main`\n* `attention`, e.g. `?attention=John`\n* `bank_account_iban`, e.g. `?bank_account_iban=NL00TEST0123456789`\n* `billing_cc_email`, e.g. `?billing_cc_email=test@example.com`\n* `billing_to_email`, e.g. `?billing_to_email=test@example.com`\n* `birthdate`, e.g. `?birthdate=1990-01-01`\n* `coc_number`, e.g. `?coc_number=12345678`\n* `default_billing_address`, e.g. `?default_billing_address=5`\n* `default_contact_person`, e.g. `?default_contact_person=42`\n* `dunning_to_email`, e.g. `?dunning_to_email=dunning@example.com`\n* `first_name`, e.g. `?first_name=Jane`\n* `gender`, e.g. `?gender=1`\n * `1` – Male\n * `2` – Female\n * `3` – Neutral/Other\n* `has_dunning`, e.g. `?has_dunning=true`\n* `identification_number`, e.g. `?identification_number=ID123`\n* `initials`, e.g. `?initials=J.D.`\n* `invoice_language`, e.g. `?invoice_language=nl`\n* `invoice_send_method`, e.g. `?invoice_send_method=2`\n * `1` – By regular mail\n * `2` – By email\n * `3` – By regular mail and email\n * `4` – E-billing\n* `is_debtor`, e.g. `?is_debtor=true`\n* `last_name`, e.g. `?last_name=Doe`\n* `name_prefix`, e.g. `?name_prefix=van`\n* `notes`, e.g. `?notes=VIP client`\n* `organization_name`, e.g. `?organization_name=Acme Corp`\n* `payment_deadline`, e.g. `?payment_deadline=30`\n* `salutation`, e.g. `?salutation=Mr.`\n* `tax_scheme`, e.g. `?tax_scheme=1`\n * `1` – Default\n * `2` – Intra-community (EU)\n * `3` – Outside of the EU\n * `4` – None\n * `5` – International\n* `title`, e.g. `?title=Dr.`\n* `vat_number`, e.g. `?vat_number=NL123456789B01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `account_manager_user`\n * `add_payment_link`\n * `address_label_name`\n * `archived_date`\n * `bank_account_bic`\n * `bank_account_iban`\n * `created_date`\n * `custom_fields`\n * `default_billing_address`\n * `default_contact_person`\n * `details`\n * `display_name`\n * `email`\n * `firm`\n * `first_name`\n * `gender`\n * `has_dunning`\n * `id`\n * `invoice_attachment_type`\n * `invoice_language`\n * `invoice_send_method`\n * `is_debtor`\n * `is_organization`\n * `last_name`\n * `modified_date`\n * `name_prefix`\n * `notes`\n * `number`\n * `organization_kind`\n * `organization_kind_subtype`\n * `organization_name`\n * `organization_number`\n * `payment_deadline`\n * `peppol_id`\n * `peppol_company_id`\n * `primary_organization`\n * `softkill_status`\n * `tags`\n * `tax_scheme`\n * `url`\n * `vat_number`\n\n For instance: ?extra_fields=modified_date\n\n **Usage with Permissions:**\n\n * To utilize the `extra_fields` feature, the requesting user must have `PERMIT_VIEW_CONTACT`.\n * The `extra_fields` parameter should not be present in the query parameters\n if the user does not have the appropriate permission.\n If the parameter is present without the required permission, access will be denied.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["contacts"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/creditinvoicelines/": {"get": {"operationId": "creditinvoicelines_list", "summary": "This endpoint represents the creditinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to creditinvoicelines:\n* `credited_section`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `credited_section`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section\n- credited_section", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CreditInvoiceline"}}}}}}, "tags": ["creditinvoicelines"]}, "parameters": []}, "/creditinvoicelines/{id}/": {"get": {"operationId": "creditinvoicelines_read", "summary": "This endpoint represents the creditinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to creditinvoicelines:\n* `credited_section`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `credited_section`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CreditInvoiceline"}}}, "tags": ["creditinvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/creditors/": {"get": {"operationId": "creditors_list", "summary": "This endpoint represents a list of creditors.", "description": "Do you have to provide a 'creditor' when entering expenses (disbursements) into Legalsense?\nNot having to means less work, but also makes it impossible to e.g. sync w/ Twinfield\n(which means that turning on Twinfield depends on both this feature being turned on,\nand on retro-actively dreaming up 'fake creditors)\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `bank_account_bic`\n* `bank_account_iban`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `name`, eg. `?name=test`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Creditor"}}}}}}, "tags": ["creditors"]}, "post": {"operationId": "creditors_create", "summary": "This endpoint represents a list of creditors.", "description": "Do you have to provide a 'creditor' when entering expenses (disbursements) into Legalsense?\nNot having to means less work, but also makes it impossible to e.g. sync w/ Twinfield\n(which means that turning on Twinfield depends on both this feature being turned on,\nand on retro-actively dreaming up 'fake creditors)\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `bank_account_bic`\n* `bank_account_iban`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `name`, eg. `?name=test`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Creditor"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Creditor"}}}, "tags": ["creditors"]}, "parameters": []}, "/creditors/{id}/": {"get": {"operationId": "creditors_read", "summary": "This endpoint represents a list of creditors.", "description": "Do you have to provide a 'creditor' when entering expenses (disbursements) into Legalsense?\nNot having to means less work, but also makes it impossible to e.g. sync w/ Twinfield\n(which means that turning on Twinfield depends on both this feature being turned on,\nand on retro-actively dreaming up 'fake creditors)\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `bank_account_bic`\n* `bank_account_iban`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `name`, eg. `?name=test`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Creditor"}}}, "tags": ["creditors"]}, "put": {"operationId": "creditors_update", "summary": "This endpoint represents a list of creditors.", "description": "Do you have to provide a 'creditor' when entering expenses (disbursements) into Legalsense?\nNot having to means less work, but also makes it impossible to e.g. sync w/ Twinfield\n(which means that turning on Twinfield depends on both this feature being turned on,\nand on retro-actively dreaming up 'fake creditors)\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `bank_account_bic`\n* `bank_account_iban`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `name`, eg. `?name=test`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Creditor"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Creditor"}}}, "tags": ["creditors"]}, "delete": {"operationId": "creditors_delete", "summary": "This endpoint represents a list of creditors.", "description": "Do you have to provide a 'creditor' when entering expenses (disbursements) into Legalsense?\nNot having to means less work, but also makes it impossible to e.g. sync w/ Twinfield\n(which means that turning on Twinfield depends on both this feature being turned on,\nand on retro-actively dreaming up 'fake creditors)\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `bank_account_bic`\n* `bank_account_iban`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `name`, eg. `?name=test`\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["creditors"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/custominvoicelines/": {"get": {"operationId": "custominvoicelines_list", "summary": "This endpoint represents the custominvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to custominvoicelines:\n* `custom_ledger_account`\n* `office_expenses_rate`\n* `page_1_kind`\n* `tax_percentage`\n* `type`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `custom_ledger_account`\n* `description`\n* `no_details`\n* `object_type`\n* `office_expenses_rate`\n* `page_1_kind`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `tax_percentage`\n* `type`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section\n- custom_ledger_account\n- office_expenses_rate\n- page_1_kind\n- tax_percentage\n- type", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CustomInvoiceline"}}}}}}, "tags": ["custominvoicelines"]}, "parameters": []}, "/custominvoicelines/{id}/": {"get": {"operationId": "custominvoicelines_read", "summary": "This endpoint represents the custominvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to custominvoicelines:\n* `custom_ledger_account`\n* `office_expenses_rate`\n* `page_1_kind`\n* `tax_percentage`\n* `type`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `custom_ledger_account`\n* `description`\n* `no_details`\n* `object_type`\n* `office_expenses_rate`\n* `page_1_kind`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `tax_percentage`\n* `type`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CustomInvoiceline"}}}, "tags": ["custominvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/custominvoicelinetypes/": {"get": {"operationId": "custominvoicelinetypes_list", "summary": "This endpoint represents the custom invoiceline field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active` - boolean\n* `name`\n* `custom_ledger_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/CustomInvoicelineType"}}}}}}, "tags": ["custominvoicelinetypes"]}, "parameters": []}, "/custominvoicelinetypes/{id}/": {"get": {"operationId": "custominvoicelinetypes_read", "summary": "This endpoint represents the custom invoiceline field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active` - boolean\n* `name`\n* `custom_ledger_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/CustomInvoicelineType"}}}, "tags": ["custominvoicelinetypes"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/documents/": {"get": {"operationId": "documents_list", "summary": "This endpoint represents the documents.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `document_type`\n* `modified_by`\n* `content_object`\n* `comment`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Document"}}}}}}, "tags": ["documents"]}, "parameters": []}, "/documents/{id}/": {"get": {"operationId": "documents_read", "summary": "This endpoint represents the documents.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `document_type`\n* `modified_by`\n* `content_object`\n* `comment`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Document"}}}, "tags": ["documents"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/documenttypes/": {"get": {"operationId": "documenttypes_list", "summary": "This endpoint represents the document types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `kind`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/DocumentType"}}}}}}, "tags": ["documenttypes"]}, "post": {"operationId": "documenttypes_create", "summary": "This endpoint represents the document types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `kind`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/DocumentType"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/DocumentType"}}}, "tags": ["documenttypes"]}, "parameters": []}, "/documenttypes/{id}/": {"get": {"operationId": "documenttypes_read", "summary": "This endpoint represents the document types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `kind`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/DocumentType"}}}, "tags": ["documenttypes"]}, "put": {"operationId": "documenttypes_update", "summary": "This endpoint represents the document types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `kind`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/DocumentType"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/DocumentType"}}}, "tags": ["documenttypes"]}, "delete": {"operationId": "documenttypes_delete", "summary": "This endpoint represents the document types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `kind`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["documenttypes"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/draftloglines/": {"get": {"operationId": "draftloglines_list", "summary": "This endpoint represents the draft loglines.", "description": "DraftLoglines are temporary time entries that require approval or additional input\nbefore becoming actual Loglines.\n\n## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `activity`\n* `approved_at` - Date when the DraftLogline was approved.\n* `comment`\n* `created_by`\n* `created_date`\n* `date`\n* `description`\n* `is_approved` - Boolean indicating if the draft has been converted to a logline.\n* `logline` - The resulting Logline after approval (read-only).\n* `matter`\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `reviewer` - The user responsible for reviewing/approving this draft.\n* `source` - The origin of the draft (e.g., Voice, User, External).\n* `submatter`\n* `timekeeper` - The fee earner the time is allocated to.\n\n## Actions\n\n* `approve`: POST /draftloglines/{id}/approve/\n Approves the draft and creates a Logline. Returns the new Logline object.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `timekeeper`, eg. `?timekeeper=1`\n* `reviewer`, eg. `?reviewer=2`\n* `matter`, eg. `?matter=5`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `date__isnull`, eg. `?date__isnull=true`\n* `approved_at__lte` / `__gte`\n* `approved_at__isnull`, eg. `?approved_at__isnull=true` (useful for finding pending drafts)\n* `created_date__lte` / `__gte`\n* `created_by`\n* `is_approved`, eg. `?is_approved=true` / `?is_approved=false` / `?is_approved=all`\n* `approvable_by_me`, eg. `?approvable_by_me=true`\n * `true` returns drafts the requesting user can approve\n * `false` returns drafts the requesting user is reviewer of but\n cannot approve (e.g., due to missing permits).\n * absent (default) — no additional constraint\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,description,source`.", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "activity", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "approvable_by_me", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_by", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "logline", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "recofa_category", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "reviewer", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "source", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "submatter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "timekeeper", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "approved_at", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "approved_at__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "approved_at__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "approved_at__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_approved", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "timekeeper__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "submatter__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "recofa__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "logline__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- approved_at\n- date\n- comment\n- created_by\n- description\n- logline\n- recofa_category\n- source\n- submatter", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/DraftLogline"}}}}}}, "tags": ["draftloglines"]}, "post": {"operationId": "draftloglines_create", "summary": "This endpoint represents the draft loglines.", "description": "DraftLoglines are temporary time entries that require approval or additional input\nbefore becoming actual Loglines.\n\n## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `activity`\n* `approved_at` - Date when the DraftLogline was approved.\n* `comment`\n* `created_by`\n* `created_date`\n* `date`\n* `description`\n* `is_approved` - Boolean indicating if the draft has been converted to a logline.\n* `logline` - The resulting Logline after approval (read-only).\n* `matter`\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `reviewer` - The user responsible for reviewing/approving this draft.\n* `source` - The origin of the draft (e.g., Voice, User, External).\n* `submatter`\n* `timekeeper` - The fee earner the time is allocated to.\n\n## Actions\n\n* `approve`: POST /draftloglines/{id}/approve/\n Approves the draft and creates a Logline. Returns the new Logline object.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `timekeeper`, eg. `?timekeeper=1`\n* `reviewer`, eg. `?reviewer=2`\n* `matter`, eg. `?matter=5`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `date__isnull`, eg. `?date__isnull=true`\n* `approved_at__lte` / `__gte`\n* `approved_at__isnull`, eg. `?approved_at__isnull=true` (useful for finding pending drafts)\n* `created_date__lte` / `__gte`\n* `created_by`\n* `is_approved`, eg. `?is_approved=true` / `?is_approved=false` / `?is_approved=all`\n* `approvable_by_me`, eg. `?approvable_by_me=true`\n * `true` returns drafts the requesting user can approve\n * `false` returns drafts the requesting user is reviewer of but\n cannot approve (e.g., due to missing permits).\n * absent (default) — no additional constraint\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,description,source`.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/DraftLogline"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/DraftLogline"}}}, "tags": ["draftloglines"]}, "parameters": []}, "/draftloglines/{id}/": {"get": {"operationId": "draftloglines_read", "summary": "This endpoint represents the draft loglines.", "description": "DraftLoglines are temporary time entries that require approval or additional input\nbefore becoming actual Loglines.\n\n## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `activity`\n* `approved_at` - Date when the DraftLogline was approved.\n* `comment`\n* `created_by`\n* `created_date`\n* `date`\n* `description`\n* `is_approved` - Boolean indicating if the draft has been converted to a logline.\n* `logline` - The resulting Logline after approval (read-only).\n* `matter`\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `reviewer` - The user responsible for reviewing/approving this draft.\n* `source` - The origin of the draft (e.g., Voice, User, External).\n* `submatter`\n* `timekeeper` - The fee earner the time is allocated to.\n\n## Actions\n\n* `approve`: POST /draftloglines/{id}/approve/\n Approves the draft and creates a Logline. Returns the new Logline object.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `timekeeper`, eg. `?timekeeper=1`\n* `reviewer`, eg. `?reviewer=2`\n* `matter`, eg. `?matter=5`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `date__isnull`, eg. `?date__isnull=true`\n* `approved_at__lte` / `__gte`\n* `approved_at__isnull`, eg. `?approved_at__isnull=true` (useful for finding pending drafts)\n* `created_date__lte` / `__gte`\n* `created_by`\n* `is_approved`, eg. `?is_approved=true` / `?is_approved=false` / `?is_approved=all`\n* `approvable_by_me`, eg. `?approvable_by_me=true`\n * `true` returns drafts the requesting user can approve\n * `false` returns drafts the requesting user is reviewer of but\n cannot approve (e.g., due to missing permits).\n * absent (default) — no additional constraint\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,description,source`.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/DraftLogline"}}}, "tags": ["draftloglines"]}, "put": {"operationId": "draftloglines_update", "summary": "This endpoint represents the draft loglines.", "description": "DraftLoglines are temporary time entries that require approval or additional input\nbefore becoming actual Loglines.\n\n## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `activity`\n* `approved_at` - Date when the DraftLogline was approved.\n* `comment`\n* `created_by`\n* `created_date`\n* `date`\n* `description`\n* `is_approved` - Boolean indicating if the draft has been converted to a logline.\n* `logline` - The resulting Logline after approval (read-only).\n* `matter`\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `reviewer` - The user responsible for reviewing/approving this draft.\n* `source` - The origin of the draft (e.g., Voice, User, External).\n* `submatter`\n* `timekeeper` - The fee earner the time is allocated to.\n\n## Actions\n\n* `approve`: POST /draftloglines/{id}/approve/\n Approves the draft and creates a Logline. Returns the new Logline object.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `timekeeper`, eg. `?timekeeper=1`\n* `reviewer`, eg. `?reviewer=2`\n* `matter`, eg. `?matter=5`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `date__isnull`, eg. `?date__isnull=true`\n* `approved_at__lte` / `__gte`\n* `approved_at__isnull`, eg. `?approved_at__isnull=true` (useful for finding pending drafts)\n* `created_date__lte` / `__gte`\n* `created_by`\n* `is_approved`, eg. `?is_approved=true` / `?is_approved=false` / `?is_approved=all`\n* `approvable_by_me`, eg. `?approvable_by_me=true`\n * `true` returns drafts the requesting user can approve\n * `false` returns drafts the requesting user is reviewer of but\n cannot approve (e.g., due to missing permits).\n * absent (default) — no additional constraint\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,description,source`.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/DraftLogline"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/DraftLogline"}}}, "tags": ["draftloglines"]}, "delete": {"operationId": "draftloglines_delete", "summary": "This endpoint represents the draft loglines.", "description": "DraftLoglines are temporary time entries that require approval or additional input\nbefore becoming actual Loglines.\n\n## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `activity`\n* `approved_at` - Date when the DraftLogline was approved.\n* `comment`\n* `created_by`\n* `created_date`\n* `date`\n* `description`\n* `is_approved` - Boolean indicating if the draft has been converted to a logline.\n* `logline` - The resulting Logline after approval (read-only).\n* `matter`\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `reviewer` - The user responsible for reviewing/approving this draft.\n* `source` - The origin of the draft (e.g., Voice, User, External).\n* `submatter`\n* `timekeeper` - The fee earner the time is allocated to.\n\n## Actions\n\n* `approve`: POST /draftloglines/{id}/approve/\n Approves the draft and creates a Logline. Returns the new Logline object.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `timekeeper`, eg. `?timekeeper=1`\n* `reviewer`, eg. `?reviewer=2`\n* `matter`, eg. `?matter=5`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `date__isnull`, eg. `?date__isnull=true`\n* `approved_at__lte` / `__gte`\n* `approved_at__isnull`, eg. `?approved_at__isnull=true` (useful for finding pending drafts)\n* `created_date__lte` / `__gte`\n* `created_by`\n* `is_approved`, eg. `?is_approved=true` / `?is_approved=false` / `?is_approved=all`\n* `approvable_by_me`, eg. `?approvable_by_me=true`\n * `true` returns drafts the requesting user can approve\n * `false` returns drafts the requesting user is reviewer of but\n cannot approve (e.g., due to missing permits).\n * absent (default) — no additional constraint\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,description,source`.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["draftloglines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/draftloglines/{id}/approve/": {"post": {"operationId": "draftloglines_approve", "description": "Approves the draft and creates a Logline. Returns the new Logline object.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/DraftLogline"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/DraftLogline"}}}, "tags": ["draftloglines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/dynamic-reports/": {"post": {"operationId": "dynamic-reports_create", "summary": "Endpoint used for querying new report.", "description": "The endpoint accepts following data:\n\n* `report_type` (required)\n * Type can be either `billed_amounts` or `time_and_fees`\n* `columns` list of dictionaries with following fields\n * `name` name of the column as returned from `columns` endpoint\n* `groupers` list of dictionaries with following fields\n * `identifier` identifier of the field as returned from `groupers` endpoint\n* `filters` list of dictionaries with following fields\n * `identifier` identifier of the field as returned from `filters` endpoint\n * `operator` one of the operators available for the field as returned from `filters` endpoint\n * `value` value by which the report rows are to be filtered.\n\n## Example request body:\n```\n{\n \"report_type\": \"time_and_fees\",\n \"columns\": [{\"name\": \"minutes\"}, {\"name\": \"client_count\"}, {\"name\": \"last_logline_date\"}],\n \"filters\": [{\"identifier\": \"matter\", \"operator\": \"Eq\", \"value\": 1}],\n \"groupers\": [{\"identifier\": \"client\"}, {\"identifier\": \"matter\"}]\n}\n```", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": ""}}, "tags": ["dynamic-reports"]}, "parameters": []}, "/dynamic-reports/columns/": {"get": {"operationId": "dynamic-reports_columns", "summary": "Read-only endpoint that returns list of dictionaries that contain\navailable columns for the reporting.", "description": "Column dictionary contains following fields:\n\n* `name`\n* `label`\n* `unit`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": ""}}, "tags": ["dynamic-reports"]}, "parameters": []}, "/dynamic-reports/filters/": {"get": {"operationId": "dynamic-reports_filters", "summary": "Read-only endpoint that returns list of dictionaries that contain\navailable filters for the reporting.", "description": "Filter dictionary contains following fields:\n\n* `id`\n* `name`\n* `identifier`\n* `operators`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": ""}}, "tags": ["dynamic-reports"]}, "parameters": []}, "/dynamic-reports/groupers/": {"get": {"operationId": "dynamic-reports_groupers", "summary": "Read-only endpoint that returns list of dictionaries that contain\navailable groupers for the reporting.", "description": "Grouper dictionary contains following fields:\n\n* `id`\n* `name`\n* `identifier`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": ""}}, "tags": ["dynamic-reports"]}, "parameters": []}, "/expenseinvoicelines/": {"get": {"operationId": "expenseinvoicelines_list", "summary": "This endpoint represents the expenseinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to expenseinvoicelines:\n* `chargeable_ids` - a list of chargeable id's related to this expenseinvoiceline\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ExpenseInvoiceline"}}}}}}, "tags": ["expenseinvoicelines"]}, "parameters": []}, "/expenseinvoicelines/{id}/": {"get": {"operationId": "expenseinvoicelines_read", "summary": "This endpoint represents the expenseinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to expenseinvoicelines:\n* `chargeable_ids` - a list of chargeable id's related to this expenseinvoiceline\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExpenseInvoiceline"}}}, "tags": ["expenseinvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/expenses/": {"get": {"operationId": "expenses_list", "summary": "This endpoint represents a list of expenses.", "description": "An expense in Legalsense is the 'purchase invoice' that could be a 'disbursement'\n(e.g. court fees) or more general costs like 'travel expenses'.\nThe purchase invoice (Expense) can be billed on multiple matters in Legalsense by\nadding multiple chargeables.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `creditor`\n* `currency`\n* `date`\n* `description`\n* `firm`\n* `invoice_number` - the purchase invoice number\n* `is_purchase` - whether the expense is a purchase invoice or is a cost that does not have an invoice/receipt\n* `number`\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=amount,firm,invoice_number`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- amount\n- creditor\n- currency\n- date\n- description\n- firm\n- invoice_number\n- is_purchase\n- number", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Expense"}}}}}}, "tags": ["expenses"]}, "post": {"operationId": "expenses_create", "summary": "This endpoint represents a list of expenses.", "description": "An expense in Legalsense is the 'purchase invoice' that could be a 'disbursement'\n(e.g. court fees) or more general costs like 'travel expenses'.\nThe purchase invoice (Expense) can be billed on multiple matters in Legalsense by\nadding multiple chargeables.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `creditor`\n* `currency`\n* `date`\n* `description`\n* `firm`\n* `invoice_number` - the purchase invoice number\n* `is_purchase` - whether the expense is a purchase invoice or is a cost that does not have an invoice/receipt\n* `number`\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=amount,firm,invoice_number`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Expense"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Expense"}}}, "tags": ["expenses"]}, "parameters": []}, "/expenses/{id}/": {"get": {"operationId": "expenses_read", "summary": "This endpoint represents a list of expenses.", "description": "An expense in Legalsense is the 'purchase invoice' that could be a 'disbursement'\n(e.g. court fees) or more general costs like 'travel expenses'.\nThe purchase invoice (Expense) can be billed on multiple matters in Legalsense by\nadding multiple chargeables.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `creditor`\n* `currency`\n* `date`\n* `description`\n* `firm`\n* `invoice_number` - the purchase invoice number\n* `is_purchase` - whether the expense is a purchase invoice or is a cost that does not have an invoice/receipt\n* `number`\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=amount,firm,invoice_number`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Expense"}}}, "tags": ["expenses"]}, "put": {"operationId": "expenses_update", "summary": "This endpoint represents a list of expenses.", "description": "An expense in Legalsense is the 'purchase invoice' that could be a 'disbursement'\n(e.g. court fees) or more general costs like 'travel expenses'.\nThe purchase invoice (Expense) can be billed on multiple matters in Legalsense by\nadding multiple chargeables.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `creditor`\n* `currency`\n* `date`\n* `description`\n* `firm`\n* `invoice_number` - the purchase invoice number\n* `is_purchase` - whether the expense is a purchase invoice or is a cost that does not have an invoice/receipt\n* `number`\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=amount,firm,invoice_number`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Expense"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Expense"}}}, "tags": ["expenses"]}, "delete": {"operationId": "expenses_delete", "summary": "This endpoint represents a list of expenses.", "description": "An expense in Legalsense is the 'purchase invoice' that could be a 'disbursement'\n(e.g. court fees) or more general costs like 'travel expenses'.\nThe purchase invoice (Expense) can be billed on multiple matters in Legalsense by\nadding multiple chargeables.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `created_date`\n* `modified_date`\n* `amount`\n* `creditor`\n* `currency`\n* `date`\n* `description`\n* `firm`\n* `invoice_number` - the purchase invoice number\n* `is_purchase` - whether the expense is a purchase invoice or is a cost that does not have an invoice/receipt\n* `number`\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=amount,firm,invoice_number`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["expenses"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/expensetypes/": {"get": {"operationId": "expensetypes_list", "summary": "This endpoint represents a list of expenses types.", "description": "Expense type is a required field for an Expense Chargeable. If expense types are not used by a firm.\nA default expense type (e.g. 'Misc') is still added and always needs to be set when adding an\nExpense + chargeable(s).\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `ledes_code`\n* `one_on_one_vat` - a disbursement is usually billed with the same VAT as the purchase invoice,\n other 'costs' are usually billed with this set to false so that costs without VAT are billed in Legalsense\n with VAT\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ExpenseType"}}}}}}, "tags": ["expensetypes"]}, "post": {"operationId": "expensetypes_create", "summary": "This endpoint represents a list of expenses types.", "description": "Expense type is a required field for an Expense Chargeable. If expense types are not used by a firm.\nA default expense type (e.g. 'Misc') is still added and always needs to be set when adding an\nExpense + chargeable(s).\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `ledes_code`\n* `one_on_one_vat` - a disbursement is usually billed with the same VAT as the purchase invoice,\n other 'costs' are usually billed with this set to false so that costs without VAT are billed in Legalsense\n with VAT\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExpenseType"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/ExpenseType"}}}, "tags": ["expensetypes"]}, "parameters": []}, "/expensetypes/{id}/": {"get": {"operationId": "expensetypes_read", "summary": "This endpoint represents a list of expenses types.", "description": "Expense type is a required field for an Expense Chargeable. If expense types are not used by a firm.\nA default expense type (e.g. 'Misc') is still added and always needs to be set when adding an\nExpense + chargeable(s).\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `ledes_code`\n* `one_on_one_vat` - a disbursement is usually billed with the same VAT as the purchase invoice,\n other 'costs' are usually billed with this set to false so that costs without VAT are billed in Legalsense\n with VAT\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExpenseType"}}}, "tags": ["expensetypes"]}, "put": {"operationId": "expensetypes_update", "summary": "This endpoint represents a list of expenses types.", "description": "Expense type is a required field for an Expense Chargeable. If expense types are not used by a firm.\nA default expense type (e.g. 'Misc') is still added and always needs to be set when adding an\nExpense + chargeable(s).\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `ledes_code`\n* `one_on_one_vat` - a disbursement is usually billed with the same VAT as the purchase invoice,\n other 'costs' are usually billed with this set to false so that costs without VAT are billed in Legalsense\n with VAT\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ExpenseType"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ExpenseType"}}}, "tags": ["expensetypes"]}, "delete": {"operationId": "expensetypes_delete", "summary": "This endpoint represents a list of expenses types.", "description": "Expense type is a required field for an Expense Chargeable. If expense types are not used by a firm.\nA default expense type (e.g. 'Misc') is still added and always needs to be set when adding an\nExpense + chargeable(s).\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n* `name`\n* `ledes_code`\n* `one_on_one_vat` - a disbursement is usually billed with the same VAT as the purchase invoice,\n other 'costs' are usually billed with this set to false so that costs without VAT are billed in Legalsense\n with VAT\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["expensetypes"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/firms/": {"get": {"operationId": "firms_list", "summary": "This endpoint represents the firms.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `address`\n* `address_line_1`\n* `address_line_2`\n* `bank_account`\n* `city`\n* `country`\n* `email`\n* `name`\n* `organization_number`\n* `phone`\n* `tax_country` - tax country id\n* `vat_number`\n* `zipcode`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Firm"}}}}}}, "tags": ["firms"]}, "post": {"operationId": "firms_create", "summary": "This endpoint represents the firms.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `address`\n* `address_line_1`\n* `address_line_2`\n* `bank_account`\n* `city`\n* `country`\n* `email`\n* `name`\n* `organization_number`\n* `phone`\n* `tax_country` - tax country id\n* `vat_number`\n* `zipcode`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Firm"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Firm"}}}, "tags": ["firms"]}, "parameters": []}, "/firms/{id}/": {"get": {"operationId": "firms_read", "summary": "This endpoint represents the firms.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `address`\n* `address_line_1`\n* `address_line_2`\n* `bank_account`\n* `city`\n* `country`\n* `email`\n* `name`\n* `organization_number`\n* `phone`\n* `tax_country` - tax country id\n* `vat_number`\n* `zipcode`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Firm"}}}, "tags": ["firms"]}, "put": {"operationId": "firms_update", "summary": "This endpoint represents the firms.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n* `address`\n* `address_line_1`\n* `address_line_2`\n* `bank_account`\n* `city`\n* `country`\n* `email`\n* `name`\n* `organization_number`\n* `phone`\n* `tax_country` - tax country id\n* `vat_number`\n* `zipcode`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Firm"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Firm"}}}, "tags": ["firms"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/functions/": {"get": {"operationId": "functions_list", "summary": "This endpoint represents the functions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `display_name`\n* `is_active`\n* `name`\n* `rates` - rates within date ranges. Dates ranges should not overlap\nand there should not be any date range without rate specified.\n* `url`\n* `variable_cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `weight`\n* `ledes_classification` - only used when feature LEDES is turned on.\n\nRates for specified date range:\nOmitted date range ends means infinity or -infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `cost_rates`\n * `external_name`\n * `ledes_classification`\n * `name`\n * `rates`\n * `variable_cost_rates`\n * `weight`\n\nFor instance: ?extra_fields=cost_rates,external_name", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- cost_rates\n- external_name\n- ledes_classification\n- name\n- rates\n- variable_cost_rates\n- weight", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Function"}}}}}}, "tags": ["functions"]}, "post": {"operationId": "functions_create", "summary": "This endpoint represents the functions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `display_name`\n* `is_active`\n* `name`\n* `rates` - rates within date ranges. Dates ranges should not overlap\nand there should not be any date range without rate specified.\n* `url`\n* `variable_cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `weight`\n* `ledes_classification` - only used when feature LEDES is turned on.\n\nRates for specified date range:\nOmitted date range ends means infinity or -infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `cost_rates`\n * `external_name`\n * `ledes_classification`\n * `name`\n * `rates`\n * `variable_cost_rates`\n * `weight`\n\nFor instance: ?extra_fields=cost_rates,external_name", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Function"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Function"}}}, "tags": ["functions"]}, "parameters": []}, "/functions/{id}/": {"get": {"operationId": "functions_read", "summary": "This endpoint represents the functions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `display_name`\n* `is_active`\n* `name`\n* `rates` - rates within date ranges. Dates ranges should not overlap\nand there should not be any date range without rate specified.\n* `url`\n* `variable_cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `weight`\n* `ledes_classification` - only used when feature LEDES is turned on.\n\nRates for specified date range:\nOmitted date range ends means infinity or -infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `cost_rates`\n * `external_name`\n * `ledes_classification`\n * `name`\n * `rates`\n * `variable_cost_rates`\n * `weight`\n\nFor instance: ?extra_fields=cost_rates,external_name", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Function"}}}, "tags": ["functions"]}, "put": {"operationId": "functions_update", "summary": "This endpoint represents the functions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `display_name`\n* `is_active`\n* `name`\n* `rates` - rates within date ranges. Dates ranges should not overlap\nand there should not be any date range without rate specified.\n* `url`\n* `variable_cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `weight`\n* `ledes_classification` - only used when feature LEDES is turned on.\n\nRates for specified date range:\nOmitted date range ends means infinity or -infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `cost_rates`\n * `external_name`\n * `ledes_classification`\n * `name`\n * `rates`\n * `variable_cost_rates`\n * `weight`\n\nFor instance: ?extra_fields=cost_rates,external_name", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Function"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Function"}}}, "tags": ["functions"]}, "delete": {"operationId": "functions_delete", "summary": "This endpoint represents the functions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `display_name`\n* `is_active`\n* `name`\n* `rates` - rates within date ranges. Dates ranges should not overlap\nand there should not be any date range without rate specified.\n* `url`\n* `variable_cost_rates` - rates within date ranges. Dates ranges should not overlap.\n* `weight`\n* `ledes_classification` - only used when feature LEDES is turned on.\n\nRates for specified date range:\nOmitted date range ends means infinity or -infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `cost_rates`\n * `external_name`\n * `ledes_classification`\n * `name`\n * `rates`\n * `variable_cost_rates`\n * `weight`\n\nFor instance: ?extra_fields=cost_rates,external_name", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["functions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/groups/": {"get": {"operationId": "groups_list", "summary": "This endpoint represents the groups.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `members`\n* `name`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Group"}}}}}}, "tags": ["groups"]}, "parameters": []}, "/groups/{id}/": {"get": {"operationId": "groups_read", "summary": "This endpoint represents the groups.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `members`\n* `name`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["groups"]}, "put": {"operationId": "groups_update", "summary": "This endpoint represents the groups.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `members`\n* `name`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Group"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Group"}}}, "tags": ["groups"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/invoicecustomfielddefinitions/": {"get": {"operationId": "invoicecustomfielddefinitions_list", "summary": "This endpoint represents the invoice custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "excel_export", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "identifier", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "read_only", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "required", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InvoiceCustomFieldDefinition"}}}}}}, "tags": ["invoicecustomfielddefinitions"]}, "post": {"operationId": "invoicecustomfielddefinitions_create", "summary": "This endpoint represents the invoice custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InvoiceCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/InvoiceCustomFieldDefinition"}}}, "tags": ["invoicecustomfielddefinitions"]}, "parameters": []}, "/invoicecustomfielddefinitions/{id}/": {"get": {"operationId": "invoicecustomfielddefinitions_read", "summary": "This endpoint represents the invoice custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InvoiceCustomFieldDefinition"}}}, "tags": ["invoicecustomfielddefinitions"]}, "put": {"operationId": "invoicecustomfielddefinitions_update", "summary": "This endpoint represents the invoice custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/InvoiceCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InvoiceCustomFieldDefinition"}}}, "tags": ["invoicecustomfielddefinitions"]}, "delete": {"operationId": "invoicecustomfielddefinitions_delete", "summary": "This endpoint represents the invoice custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["invoicecustomfielddefinitions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/invoicelines/": {"get": {"operationId": "invoicelines_list", "summary": "This endpoint represents the invoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `object_type`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Invoiceline"}}}}}}, "tags": ["invoicelines"]}, "parameters": []}, "/invoicelines/{id}/": {"get": {"operationId": "invoicelines_read", "summary": "This endpoint represents the invoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `object_type`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Invoiceline"}}}, "tags": ["invoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/invoices/": {"get": {"operationId": "invoices_list", "summary": "This endpoint represents the invoices.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name` - number of the invoice\n* `url`\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date` - begin date of the invoice period\n* `billed_elsewhere`\n* `billed_on_invoice` - id of the invoice a credit invoice is billed on\n* `billed_on_invoice_draft` - id of the draft invoice a credit invoice is billed on\n* `cc_emails`\n* `child_invoice_ids` - id's of partially paid invoices linked to this invoice\n* `client` - the id of the client for this invoice\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date` - the datetime the invoice was created in the system\n* `credit_comments`\n* `currency` - invoice currency\n* `date` - invoice date\n* `debtor` - the contact (id) in Legalsense that is teh debtor for this invoice\n* `debtor_address` - using the debtor_address_id should be cross-referenced to the receiver address as the\n address connected to the debtor_address_id might have changed in the meantime\n* `do_not_sync`\n* `end_date` - end date of the invoice period\n* `exchange_rate` - exchange rate from invoice currency to main currency.\n* `finalized_at` - the datetime the invoice was finalized in the system\n* `firm`\n* `is_creditable` - boolean to indicate if the invoice is creditable\n* `is_credit_invoice` - boolean to indicate if the invoice is a credit invoice\n* `invoicesection_set` - sections on the invoice\n* `kind` - invoice template used for the invoice\n* `language` - language of the invoice\n* `modified_date` - the datetime the invoice was last modified in the system\n* `number` - number of the invoice\n* `paid_amount` - paid amount\n* `parent_invoice_id` - id of the parent invoice when this is a partially paid invoice\n* `payment_deadline` - payment deadline in days\n* `payment_status` - choices:\n 11. Not paid\n 12. Paid\n 13. Ignore payments\n 14. Uncollectable\n* `receiver_address` - the address (of the debtor) on this invoice\n* `rounding_precision` - The 'cash rounding' precision used (0.01 or 1.00).\n* `sender_address`\n* `send_method` - choices:\n 1. By regular mail\n 2. By email\n 3. By regular mail and email\n 4. E-billing\n* `status` - choices:\n 1. Draft invoice\n 2. Final invoice\n* `tax_scheme` - choices:\n 1. National\n 2. Intra-community (EU)\n 3. Outside of the EU\n 4. None\n 5. International\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2024-01-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2024-01-01`\n* `valid_from`, eg. `?valid_from=2024-12-31`\n* `valid_until`, eg. `?valid_until=2025-12-31`\n* `date`, eg. `?date=2024-01-01`\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2024-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2024-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2024-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2024-01-01T15:30:15`\n* `number`, eg. `?number=20240021`\n* `status`, 1=draft, 2=final, eg. `?status=1`\n* `payment_status`, 11=not paid, 12=paid, 13=ignore payments, 14=uncollectable, eg. `?payment_status=11`\n* `billed_on_invoice` - only for credit invoice, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft` - only for credit invoice, eg. `?billed_on_invoice_draft=1`\n* `tags`, e.g. `?tags=lorem`\n* `created_by` - user id, eg. `?created_by=1`\n\nWhen using `valid_from` and `valid_until` all ranges that at least partially\noverlap the range defined by the selected dates will be returned. If using\nonly one of `valid_from` and `valid_until`, an open-ended range is used to\ncheck for (partial) overlap.\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date`\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `cc_emails`\n* `child_invoice_ids`\n* `client`\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date`\n* `credit_comments`\n* `credited_invoice_id`\n* `currency`\n* `date`\n* `debtor`\n* `debtor_address`\n* `do_not_sync`\n* `end_date`\n* `exchange_rate`\n* `finalized_at`\n* `finalized_by`\n* `firm`\n* `invoicesection_set`\n* `is_credit_invoice`\n* `is_creditable`\n* `kind`\n* `language`\n* `modified_date`\n* `number`\n* `paid_amount`\n* `parent_invoice_id`\n* `payment_deadline`\n* `payment_status`\n* `receiver_address`\n* `rounding_precision`\n* `rvr_kind`\n* `send_method`\n* `sender_address`\n* `status`\n* `tax_scheme`\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nFor instance: ?extra_fields=amount,debtor", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "begin_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_from", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_until", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "begin_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billed_elsewhere", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billed_on_invoice", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billed_on_invoice_draft", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_by", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "finalized_at__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "finalized_at__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "payment_status", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "status", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "tags", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- accounting_date\n- add_payment_link\n- amount\n- amount_ex_tax\n- amount_in_default_currency\n- begin_date\n- billed_elsewhere\n- billed_on_invoice\n- billed_on_invoice_draft\n- cc_emails\n- child_invoice_ids\n- client\n- comments\n- contact_person\n- created_by\n- created_date\n- credited_invoice_id\n- credit_comments\n- currency\n- date\n- debtor\n- debtor_address\n- do_not_sync\n- end_date\n- exchange_rate\n- finalized_at\n- finalized_by\n- firm\n- is_creditable\n- is_credit_invoice\n- invoicesection_set\n- kind\n- language\n- modified_date\n- number\n- paid_amount\n- parent_invoice_id\n- payment_deadline\n- payment_status\n- receiver_address\n- rounding_precision\n- rvr_kind\n- sender_address\n- send_method\n- status\n- tax_scheme\n- to_emails\n- vat_correction_amount\n- vat_number", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Invoice"}}}}}}, "tags": ["invoices"]}, "parameters": []}, "/invoices/{id}/": {"get": {"operationId": "invoices_read", "summary": "This endpoint represents the invoices.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name` - number of the invoice\n* `url`\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date` - begin date of the invoice period\n* `billed_elsewhere`\n* `billed_on_invoice` - id of the invoice a credit invoice is billed on\n* `billed_on_invoice_draft` - id of the draft invoice a credit invoice is billed on\n* `cc_emails`\n* `child_invoice_ids` - id's of partially paid invoices linked to this invoice\n* `client` - the id of the client for this invoice\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date` - the datetime the invoice was created in the system\n* `credit_comments`\n* `currency` - invoice currency\n* `date` - invoice date\n* `debtor` - the contact (id) in Legalsense that is teh debtor for this invoice\n* `debtor_address` - using the debtor_address_id should be cross-referenced to the receiver address as the\n address connected to the debtor_address_id might have changed in the meantime\n* `do_not_sync`\n* `end_date` - end date of the invoice period\n* `exchange_rate` - exchange rate from invoice currency to main currency.\n* `finalized_at` - the datetime the invoice was finalized in the system\n* `firm`\n* `is_creditable` - boolean to indicate if the invoice is creditable\n* `is_credit_invoice` - boolean to indicate if the invoice is a credit invoice\n* `invoicesection_set` - sections on the invoice\n* `kind` - invoice template used for the invoice\n* `language` - language of the invoice\n* `modified_date` - the datetime the invoice was last modified in the system\n* `number` - number of the invoice\n* `paid_amount` - paid amount\n* `parent_invoice_id` - id of the parent invoice when this is a partially paid invoice\n* `payment_deadline` - payment deadline in days\n* `payment_status` - choices:\n 11. Not paid\n 12. Paid\n 13. Ignore payments\n 14. Uncollectable\n* `receiver_address` - the address (of the debtor) on this invoice\n* `rounding_precision` - The 'cash rounding' precision used (0.01 or 1.00).\n* `sender_address`\n* `send_method` - choices:\n 1. By regular mail\n 2. By email\n 3. By regular mail and email\n 4. E-billing\n* `status` - choices:\n 1. Draft invoice\n 2. Final invoice\n* `tax_scheme` - choices:\n 1. National\n 2. Intra-community (EU)\n 3. Outside of the EU\n 4. None\n 5. International\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2024-01-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2024-01-01`\n* `valid_from`, eg. `?valid_from=2024-12-31`\n* `valid_until`, eg. `?valid_until=2025-12-31`\n* `date`, eg. `?date=2024-01-01`\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2024-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2024-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2024-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2024-01-01T15:30:15`\n* `number`, eg. `?number=20240021`\n* `status`, 1=draft, 2=final, eg. `?status=1`\n* `payment_status`, 11=not paid, 12=paid, 13=ignore payments, 14=uncollectable, eg. `?payment_status=11`\n* `billed_on_invoice` - only for credit invoice, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft` - only for credit invoice, eg. `?billed_on_invoice_draft=1`\n* `tags`, e.g. `?tags=lorem`\n* `created_by` - user id, eg. `?created_by=1`\n\nWhen using `valid_from` and `valid_until` all ranges that at least partially\noverlap the range defined by the selected dates will be returned. If using\nonly one of `valid_from` and `valid_until`, an open-ended range is used to\ncheck for (partial) overlap.\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date`\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `cc_emails`\n* `child_invoice_ids`\n* `client`\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date`\n* `credit_comments`\n* `credited_invoice_id`\n* `currency`\n* `date`\n* `debtor`\n* `debtor_address`\n* `do_not_sync`\n* `end_date`\n* `exchange_rate`\n* `finalized_at`\n* `finalized_by`\n* `firm`\n* `invoicesection_set`\n* `is_credit_invoice`\n* `is_creditable`\n* `kind`\n* `language`\n* `modified_date`\n* `number`\n* `paid_amount`\n* `parent_invoice_id`\n* `payment_deadline`\n* `payment_status`\n* `receiver_address`\n* `rounding_precision`\n* `rvr_kind`\n* `send_method`\n* `sender_address`\n* `status`\n* `tax_scheme`\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nFor instance: ?extra_fields=amount,debtor", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Invoice"}}}, "tags": ["invoices"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/invoices/{id}/pdf/": {"get": {"operationId": "invoices_pdf", "summary": "This endpoint represents the invoices.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name` - number of the invoice\n* `url`\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date` - begin date of the invoice period\n* `billed_elsewhere`\n* `billed_on_invoice` - id of the invoice a credit invoice is billed on\n* `billed_on_invoice_draft` - id of the draft invoice a credit invoice is billed on\n* `cc_emails`\n* `child_invoice_ids` - id's of partially paid invoices linked to this invoice\n* `client` - the id of the client for this invoice\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date` - the datetime the invoice was created in the system\n* `credit_comments`\n* `currency` - invoice currency\n* `date` - invoice date\n* `debtor` - the contact (id) in Legalsense that is teh debtor for this invoice\n* `debtor_address` - using the debtor_address_id should be cross-referenced to the receiver address as the\n address connected to the debtor_address_id might have changed in the meantime\n* `do_not_sync`\n* `end_date` - end date of the invoice period\n* `exchange_rate` - exchange rate from invoice currency to main currency.\n* `finalized_at` - the datetime the invoice was finalized in the system\n* `firm`\n* `is_creditable` - boolean to indicate if the invoice is creditable\n* `is_credit_invoice` - boolean to indicate if the invoice is a credit invoice\n* `invoicesection_set` - sections on the invoice\n* `kind` - invoice template used for the invoice\n* `language` - language of the invoice\n* `modified_date` - the datetime the invoice was last modified in the system\n* `number` - number of the invoice\n* `paid_amount` - paid amount\n* `parent_invoice_id` - id of the parent invoice when this is a partially paid invoice\n* `payment_deadline` - payment deadline in days\n* `payment_status` - choices:\n 11. Not paid\n 12. Paid\n 13. Ignore payments\n 14. Uncollectable\n* `receiver_address` - the address (of the debtor) on this invoice\n* `rounding_precision` - The 'cash rounding' precision used (0.01 or 1.00).\n* `sender_address`\n* `send_method` - choices:\n 1. By regular mail\n 2. By email\n 3. By regular mail and email\n 4. E-billing\n* `status` - choices:\n 1. Draft invoice\n 2. Final invoice\n* `tax_scheme` - choices:\n 1. National\n 2. Intra-community (EU)\n 3. Outside of the EU\n 4. None\n 5. International\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2024-01-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2024-01-01`\n* `valid_from`, eg. `?valid_from=2024-12-31`\n* `valid_until`, eg. `?valid_until=2025-12-31`\n* `date`, eg. `?date=2024-01-01`\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2024-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2024-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2024-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2024-01-01T15:30:15`\n* `number`, eg. `?number=20240021`\n* `status`, 1=draft, 2=final, eg. `?status=1`\n* `payment_status`, 11=not paid, 12=paid, 13=ignore payments, 14=uncollectable, eg. `?payment_status=11`\n* `billed_on_invoice` - only for credit invoice, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft` - only for credit invoice, eg. `?billed_on_invoice_draft=1`\n* `tags`, e.g. `?tags=lorem`\n* `created_by` - user id, eg. `?created_by=1`\n\nWhen using `valid_from` and `valid_until` all ranges that at least partially\noverlap the range defined by the selected dates will be returned. If using\nonly one of `valid_from` and `valid_until`, an open-ended range is used to\ncheck for (partial) overlap.\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date`\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `cc_emails`\n* `child_invoice_ids`\n* `client`\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date`\n* `credit_comments`\n* `credited_invoice_id`\n* `currency`\n* `date`\n* `debtor`\n* `debtor_address`\n* `do_not_sync`\n* `end_date`\n* `exchange_rate`\n* `finalized_at`\n* `finalized_by`\n* `firm`\n* `invoicesection_set`\n* `is_credit_invoice`\n* `is_creditable`\n* `kind`\n* `language`\n* `modified_date`\n* `number`\n* `paid_amount`\n* `parent_invoice_id`\n* `payment_deadline`\n* `payment_status`\n* `receiver_address`\n* `rounding_precision`\n* `rvr_kind`\n* `send_method`\n* `sender_address`\n* `status`\n* `tax_scheme`\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nFor instance: ?extra_fields=amount,debtor", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Invoice"}}}, "tags": ["invoices"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/invoices/{id}/specification_pdf/": {"get": {"operationId": "invoices_specification_pdf", "summary": "This endpoint represents the invoices.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name` - number of the invoice\n* `url`\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date` - begin date of the invoice period\n* `billed_elsewhere`\n* `billed_on_invoice` - id of the invoice a credit invoice is billed on\n* `billed_on_invoice_draft` - id of the draft invoice a credit invoice is billed on\n* `cc_emails`\n* `child_invoice_ids` - id's of partially paid invoices linked to this invoice\n* `client` - the id of the client for this invoice\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date` - the datetime the invoice was created in the system\n* `credit_comments`\n* `currency` - invoice currency\n* `date` - invoice date\n* `debtor` - the contact (id) in Legalsense that is teh debtor for this invoice\n* `debtor_address` - using the debtor_address_id should be cross-referenced to the receiver address as the\n address connected to the debtor_address_id might have changed in the meantime\n* `do_not_sync`\n* `end_date` - end date of the invoice period\n* `exchange_rate` - exchange rate from invoice currency to main currency.\n* `finalized_at` - the datetime the invoice was finalized in the system\n* `firm`\n* `is_creditable` - boolean to indicate if the invoice is creditable\n* `is_credit_invoice` - boolean to indicate if the invoice is a credit invoice\n* `invoicesection_set` - sections on the invoice\n* `kind` - invoice template used for the invoice\n* `language` - language of the invoice\n* `modified_date` - the datetime the invoice was last modified in the system\n* `number` - number of the invoice\n* `paid_amount` - paid amount\n* `parent_invoice_id` - id of the parent invoice when this is a partially paid invoice\n* `payment_deadline` - payment deadline in days\n* `payment_status` - choices:\n 11. Not paid\n 12. Paid\n 13. Ignore payments\n 14. Uncollectable\n* `receiver_address` - the address (of the debtor) on this invoice\n* `rounding_precision` - The 'cash rounding' precision used (0.01 or 1.00).\n* `sender_address`\n* `send_method` - choices:\n 1. By regular mail\n 2. By email\n 3. By regular mail and email\n 4. E-billing\n* `status` - choices:\n 1. Draft invoice\n 2. Final invoice\n* `tax_scheme` - choices:\n 1. National\n 2. Intra-community (EU)\n 3. Outside of the EU\n 4. None\n 5. International\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2024-01-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2024-01-01`\n* `valid_from`, eg. `?valid_from=2024-12-31`\n* `valid_until`, eg. `?valid_until=2025-12-31`\n* `date`, eg. `?date=2024-01-01`\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2024-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2024-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2024-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2024-01-01T15:30:15`\n* `number`, eg. `?number=20240021`\n* `status`, 1=draft, 2=final, eg. `?status=1`\n* `payment_status`, 11=not paid, 12=paid, 13=ignore payments, 14=uncollectable, eg. `?payment_status=11`\n* `billed_on_invoice` - only for credit invoice, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft` - only for credit invoice, eg. `?billed_on_invoice_draft=1`\n* `tags`, e.g. `?tags=lorem`\n* `created_by` - user id, eg. `?created_by=1`\n\nWhen using `valid_from` and `valid_until` all ranges that at least partially\noverlap the range defined by the selected dates will be returned. If using\nonly one of `valid_from` and `valid_until`, an open-ended range is used to\ncheck for (partial) overlap.\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date`\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `cc_emails`\n* `child_invoice_ids`\n* `client`\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date`\n* `credit_comments`\n* `credited_invoice_id`\n* `currency`\n* `date`\n* `debtor`\n* `debtor_address`\n* `do_not_sync`\n* `end_date`\n* `exchange_rate`\n* `finalized_at`\n* `finalized_by`\n* `firm`\n* `invoicesection_set`\n* `is_credit_invoice`\n* `is_creditable`\n* `kind`\n* `language`\n* `modified_date`\n* `number`\n* `paid_amount`\n* `parent_invoice_id`\n* `payment_deadline`\n* `payment_status`\n* `receiver_address`\n* `rounding_precision`\n* `rvr_kind`\n* `send_method`\n* `sender_address`\n* `status`\n* `tax_scheme`\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nFor instance: ?extra_fields=amount,debtor", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Invoice"}}}, "tags": ["invoices"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/invoices/{id}/ubl/": {"get": {"operationId": "invoices_ubl", "summary": "This endpoint represents the invoices.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name` - number of the invoice\n* `url`\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date` - begin date of the invoice period\n* `billed_elsewhere`\n* `billed_on_invoice` - id of the invoice a credit invoice is billed on\n* `billed_on_invoice_draft` - id of the draft invoice a credit invoice is billed on\n* `cc_emails`\n* `child_invoice_ids` - id's of partially paid invoices linked to this invoice\n* `client` - the id of the client for this invoice\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date` - the datetime the invoice was created in the system\n* `credit_comments`\n* `currency` - invoice currency\n* `date` - invoice date\n* `debtor` - the contact (id) in Legalsense that is teh debtor for this invoice\n* `debtor_address` - using the debtor_address_id should be cross-referenced to the receiver address as the\n address connected to the debtor_address_id might have changed in the meantime\n* `do_not_sync`\n* `end_date` - end date of the invoice period\n* `exchange_rate` - exchange rate from invoice currency to main currency.\n* `finalized_at` - the datetime the invoice was finalized in the system\n* `firm`\n* `is_creditable` - boolean to indicate if the invoice is creditable\n* `is_credit_invoice` - boolean to indicate if the invoice is a credit invoice\n* `invoicesection_set` - sections on the invoice\n* `kind` - invoice template used for the invoice\n* `language` - language of the invoice\n* `modified_date` - the datetime the invoice was last modified in the system\n* `number` - number of the invoice\n* `paid_amount` - paid amount\n* `parent_invoice_id` - id of the parent invoice when this is a partially paid invoice\n* `payment_deadline` - payment deadline in days\n* `payment_status` - choices:\n 11. Not paid\n 12. Paid\n 13. Ignore payments\n 14. Uncollectable\n* `receiver_address` - the address (of the debtor) on this invoice\n* `rounding_precision` - The 'cash rounding' precision used (0.01 or 1.00).\n* `sender_address`\n* `send_method` - choices:\n 1. By regular mail\n 2. By email\n 3. By regular mail and email\n 4. E-billing\n* `status` - choices:\n 1. Draft invoice\n 2. Final invoice\n* `tax_scheme` - choices:\n 1. National\n 2. Intra-community (EU)\n 3. Outside of the EU\n 4. None\n 5. International\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2024-01-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2024-01-01`\n* `valid_from`, eg. `?valid_from=2024-12-31`\n* `valid_until`, eg. `?valid_until=2025-12-31`\n* `date`, eg. `?date=2024-01-01`\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2024-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2024-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2024-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2024-01-01T15:30:15`\n* `number`, eg. `?number=20240021`\n* `status`, 1=draft, 2=final, eg. `?status=1`\n* `payment_status`, 11=not paid, 12=paid, 13=ignore payments, 14=uncollectable, eg. `?payment_status=11`\n* `billed_on_invoice` - only for credit invoice, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft` - only for credit invoice, eg. `?billed_on_invoice_draft=1`\n* `tags`, e.g. `?tags=lorem`\n* `created_by` - user id, eg. `?created_by=1`\n\nWhen using `valid_from` and `valid_until` all ranges that at least partially\noverlap the range defined by the selected dates will be returned. If using\nonly one of `valid_from` and `valid_until`, an open-ended range is used to\ncheck for (partial) overlap.\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `accounting_date`\n* `add_payment_link`\n* `amount`\n* `amount_ex_tax`\n* `amount_in_default_currency`\n* `begin_date`\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `cc_emails`\n* `child_invoice_ids`\n* `client`\n* `comments`\n* `contact_person`\n* `created_by`\n* `created_date`\n* `credit_comments`\n* `credited_invoice_id`\n* `currency`\n* `date`\n* `debtor`\n* `debtor_address`\n* `do_not_sync`\n* `end_date`\n* `exchange_rate`\n* `finalized_at`\n* `finalized_by`\n* `firm`\n* `invoicesection_set`\n* `is_credit_invoice`\n* `is_creditable`\n* `kind`\n* `language`\n* `modified_date`\n* `number`\n* `paid_amount`\n* `parent_invoice_id`\n* `payment_deadline`\n* `payment_status`\n* `receiver_address`\n* `rounding_precision`\n* `rvr_kind`\n* `send_method`\n* `sender_address`\n* `status`\n* `tax_scheme`\n* `to_emails`\n* `vat_correction_amount`\n* `vat_number`\n\nFor instance: ?extra_fields=amount,debtor", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Invoice"}}}, "tags": ["invoices"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/invoicesections/": {"get": {"operationId": "invoicesections_list", "summary": "This endpoint represents the invoice sections.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `activity_amount`\n* `advance_amount`\n* `billing_reference`\n* `client_contribution_amount` - specific to Legal Aid support in the Netherlands\n* `created_date` - the datetime the invoicesection was created in the system\n* `custom_activity_amount`\n* `custom_expense_amount`\n* `expense_amount`\n* `invoice`\n* `invoiceline_set`- the invoicelines on this invoicesection\n* `matter` - the matter that this invoicesection belongs to\n* `miscellaneous_amount`\n* `modified_date` - the datetime the invoicesection was last modified in the system\n* `netdocuments_identifier`\n* `office_expenses_amount`\n* `paid_amount`\n* `pricing_scheme` - choices:\n 1. Fixed price\n 2. Fixed rate\n 3. User\n 4. Activity\n 5. Legal Aid\n 7. User activity\n 8. Fixed rate activity\n 9. User month\n 10. Function\n 11. Capped price\n 12. Fixed rate user lines\n 13. Recofa\n* `product_amount`\n* `tax_amount`\n* `total_amount`\n* `trustaccounting_amount`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n ## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `matter`, matter id eg. `?matter=12`\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2024-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2024-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2024-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2024-01-01T15:30:15`\n* `invoice_date`, eg. `?invoice_date=2024-01-01`\n* `invoice_date__gte`, eg. `?invoice_date__gte=2024-01-01`\n* `invoice_date__lte`, eg. `?invoice_date__lte=2024-01-01`\n* `invoice_tags_name`, eg. `?invoice_tags_name=lorem`\n* `invoice_number`, eg. `?invoice_number=1`\n* `invoice_status`, 1=draft, 2=final, eg. `?invoice_status=1`\n* `invoice_payment_status`, 11=not paid, 12=paid, 13=ignore payments, 14=uncollectable,\n eg. `?invoice_payment_status=11`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_date", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_payment_status", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_status", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_tags_name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/InvoiceSection"}}}}}}, "tags": ["invoicesections"]}, "parameters": []}, "/invoicesections/{id}/": {"get": {"operationId": "invoicesections_read", "summary": "This endpoint represents the invoice sections.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `activity_amount`\n* `advance_amount`\n* `billing_reference`\n* `client_contribution_amount` - specific to Legal Aid support in the Netherlands\n* `created_date` - the datetime the invoicesection was created in the system\n* `custom_activity_amount`\n* `custom_expense_amount`\n* `expense_amount`\n* `invoice`\n* `invoiceline_set`- the invoicelines on this invoicesection\n* `matter` - the matter that this invoicesection belongs to\n* `miscellaneous_amount`\n* `modified_date` - the datetime the invoicesection was last modified in the system\n* `netdocuments_identifier`\n* `office_expenses_amount`\n* `paid_amount`\n* `pricing_scheme` - choices:\n 1. Fixed price\n 2. Fixed rate\n 3. User\n 4. Activity\n 5. Legal Aid\n 7. User activity\n 8. Fixed rate activity\n 9. User month\n 10. Function\n 11. Capped price\n 12. Fixed rate user lines\n 13. Recofa\n* `product_amount`\n* `tax_amount`\n* `total_amount`\n* `trustaccounting_amount`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n ## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `matter`, matter id eg. `?matter=12`\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2024-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2024-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2024-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2024-01-01T15:30:15`\n* `invoice_date`, eg. `?invoice_date=2024-01-01`\n* `invoice_date__gte`, eg. `?invoice_date__gte=2024-01-01`\n* `invoice_date__lte`, eg. `?invoice_date__lte=2024-01-01`\n* `invoice_tags_name`, eg. `?invoice_tags_name=lorem`\n* `invoice_number`, eg. `?invoice_number=1`\n* `invoice_status`, 1=draft, 2=final, eg. `?invoice_status=1`\n* `invoice_payment_status`, 11=not paid, 12=paid, 13=ignore payments, 14=uncollectable,\n eg. `?invoice_payment_status=11`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/InvoiceSection"}}}, "tags": ["invoicesections"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/leverageteams/": {"get": {"operationId": "leverageteams_list", "summary": "This endpoint represents the leverage teams.", "description": "This endpoint requires \"leverage_team\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `name`\n* `team_leader` - id of user\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/LeverageTeam"}}}}}}, "tags": ["leverageteams"]}, "post": {"operationId": "leverageteams_create", "summary": "This endpoint represents the leverage teams.", "description": "This endpoint requires \"leverage_team\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `name`\n* `team_leader` - id of user\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LeverageTeam"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/LeverageTeam"}}}, "tags": ["leverageteams"]}, "parameters": []}, "/leverageteams/{id}/": {"get": {"operationId": "leverageteams_read", "summary": "This endpoint represents the leverage teams.", "description": "This endpoint requires \"leverage_team\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `name`\n* `team_leader` - id of user\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/LeverageTeam"}}}, "tags": ["leverageteams"]}, "put": {"operationId": "leverageteams_update", "summary": "This endpoint represents the leverage teams.", "description": "This endpoint requires \"leverage_team\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `name`\n* `team_leader` - id of user\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LeverageTeam"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/LeverageTeam"}}}, "tags": ["leverageteams"]}, "delete": {"operationId": "leverageteams_delete", "summary": "This endpoint represents the leverage teams.", "description": "This endpoint requires \"leverage_team\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `name`\n* `team_leader` - id of user\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["leverageteams"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/loglineinvoicelines/": {"get": {"operationId": "loglineinvoicelines_list", "summary": "This endpoint represents the loglineinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to loglineinvoicelines:\n* `billable_minutes`\n* `invoice_price_key`\n* `minutes`\n* `office_expenses_rate`\n* `original_price_value`\n* `points`\n* `price`\n* `rate`\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billable_minutes`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `invoice_price_key`\n* `minutes`\n* `no_details`\n* `object_type`\n* `office_expenses_rate`\n* `original_price_value`\n* `paid_amount`\n* `points`\n* `price`\n* `rate`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `tax_percentage`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section\n- billable_minutes\n- invoice_price_key\n- minutes\n- office_expenses_rate\n- original_price_value\n- points\n- price\n- rate\n- tax_percentage", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/LoglineInvoiceline"}}}}}}, "tags": ["loglineinvoicelines"]}, "parameters": []}, "/loglineinvoicelines/{id}/": {"get": {"operationId": "loglineinvoicelines_read", "summary": "This endpoint represents the loglineinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to loglineinvoicelines:\n* `billable_minutes`\n* `invoice_price_key`\n* `minutes`\n* `office_expenses_rate`\n* `original_price_value`\n* `points`\n* `price`\n* `rate`\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billable_minutes`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `invoice_price_key`\n* `minutes`\n* `no_details`\n* `object_type`\n* `office_expenses_rate`\n* `original_price_value`\n* `paid_amount`\n* `points`\n* `price`\n* `rate`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `tax_percentage`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/LoglineInvoiceline"}}}, "tags": ["loglineinvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/loglines/": {"get": {"operationId": "loglines_list", "summary": "This endpoint represents the loglines (time entries).", "description": "## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active` - boolean\n* `activity`\n* `billable_minutes`\n* `billable_status` - The available options are:\n * `W` - Written off\n * `D` - Billed\n * `C` - On draft invoice\n * `0` - Zero rate\n * `B` - Billable\n * `PW` - Partially written off\n * `ED` - Billed elsewhere\n * `NB` - Non-billable\n * `0PW`- Zero rate / Partially written off\n* `is_billed_anywhere` - true when the logline is on a final or draft invoice;\n user should not be able to edit/delete billed logline\n* `is_billed` - true when the logline is on a final invoice or billed elsewhere\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `comment` - internal comment of time entry\n* `created_by` - who created the time entry\n* `created_date` - when the time entry was created\n* `date` - date of work\n* `description` - description of time entry.\n* `expense`\n* `is_billable` - read-only field determined by `type` (matter_billable_type).\n* `is_zero_rate` - read-only field determined by `type` (matter_billable_type).\n* `matter` - the matter to which time has been allocated.\n* `type` - matter_billable_type, used by the mobile app. This field acts as a helper that determines the values of\n `is_billable` and `is_zero_rate`.\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `submatter`\n* `user` - the fee earner that the time is allocated to\n* `writeoff_line`\n* `written_off_minutes`\n* `...amount` fields. All amounts are in the reference currency of the system.\n * `amount` - The monetary value of the logline.\n * `expected_amount` - the \"expected\" amount of the logline. Only non-zero when\n not on an invoice.\n * `draft_amount` - the \"draft\" amount of the logline. Only non-zero if the time\n entry is on a draft invoice.\n * `billed_amount` - the \"billed\" amount of the logline. Only non-zero if the time\n entry is actually billed.\n * `paid_amount` - how much of the time entry has been paid.\n * `original_amount` - only set for time-entries originating from a different\n system, on initial data conversion.\n * `billed_office_expenses_amount`\n * `cost_rate_amount`\n * `expected_below_cap_amount`\n * `expected_client_rate_amount`\n * `expected_hourly_rate_amount`\n * `expected_ignoring_writeoffs_amount`\n * `expected_office_expenses_amount`\n * `expected_office_expenses_ignoring_writeoffs_amount`\n * `expected_reduced_ignoring_writeoffs_amount`\n * `tax_amount`\n * `variable_cost_rate_amount`\n\nWhen creating `loglines` the `other_timekeepers` field is also available. The accepted format\nfor this field is a list of user ids.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01`\n* `user`, eg. `?user=1`\n* `matter`, eg. `?matter=1`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `billed_on_invoice`, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=1`\n* `billed_elsewhere`, eg. `?billed_elsewhere=true`\n* `is_billed`, eg. `?is_billed=true` (true returns final or elsewhere; false includes not billed and draft-only)\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,recofa_category,is_billed`.", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "billed_elsewhere", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billed_on_invoice", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "billed_on_invoice_draft", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_billed", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- activity\n- amount\n- billable_minutes\n- billable_status\n- billed_amount\n- billed_elsewhere\n- billed_office_expenses_amount\n- billed_on_invoice\n- billed_on_invoice_draft\n- comment\n- cost_rate_amount\n- created_by\n- created_date\n- description\n- draft_amount\n- expected_amount\n- expected_below_cap_amount\n- expected_client_rate_amount\n- expected_hourly_rate_amount\n- expected_ignoring_writeoffs_amount\n- expected_office_expenses_amount\n- expected_office_expenses_ignoring_writeoffs_amount\n- expected_reduced_ignoring_writeoffs_amount\n- expense\n- is_billable\n- is_billed_anywhere\n- is_billed\n- is_zero_rate\n- modified_date\n- original_amount\n- paid_amount\n- recofa_category\n- submatter\n- tax_amount\n- type\n- variable_cost_rate_amount\n- writeoff_line\n- written_off_minutes", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Logline"}}}}}}, "tags": ["loglines"]}, "post": {"operationId": "loglines_create", "summary": "This endpoint represents the loglines (time entries).", "description": "## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active` - boolean\n* `activity`\n* `billable_minutes`\n* `billable_status` - The available options are:\n * `W` - Written off\n * `D` - Billed\n * `C` - On draft invoice\n * `0` - Zero rate\n * `B` - Billable\n * `PW` - Partially written off\n * `ED` - Billed elsewhere\n * `NB` - Non-billable\n * `0PW`- Zero rate / Partially written off\n* `is_billed_anywhere` - true when the logline is on a final or draft invoice;\n user should not be able to edit/delete billed logline\n* `is_billed` - true when the logline is on a final invoice or billed elsewhere\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `comment` - internal comment of time entry\n* `created_by` - who created the time entry\n* `created_date` - when the time entry was created\n* `date` - date of work\n* `description` - description of time entry.\n* `expense`\n* `is_billable` - read-only field determined by `type` (matter_billable_type).\n* `is_zero_rate` - read-only field determined by `type` (matter_billable_type).\n* `matter` - the matter to which time has been allocated.\n* `type` - matter_billable_type, used by the mobile app. This field acts as a helper that determines the values of\n `is_billable` and `is_zero_rate`.\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `submatter`\n* `user` - the fee earner that the time is allocated to\n* `writeoff_line`\n* `written_off_minutes`\n* `...amount` fields. All amounts are in the reference currency of the system.\n * `amount` - The monetary value of the logline.\n * `expected_amount` - the \"expected\" amount of the logline. Only non-zero when\n not on an invoice.\n * `draft_amount` - the \"draft\" amount of the logline. Only non-zero if the time\n entry is on a draft invoice.\n * `billed_amount` - the \"billed\" amount of the logline. Only non-zero if the time\n entry is actually billed.\n * `paid_amount` - how much of the time entry has been paid.\n * `original_amount` - only set for time-entries originating from a different\n system, on initial data conversion.\n * `billed_office_expenses_amount`\n * `cost_rate_amount`\n * `expected_below_cap_amount`\n * `expected_client_rate_amount`\n * `expected_hourly_rate_amount`\n * `expected_ignoring_writeoffs_amount`\n * `expected_office_expenses_amount`\n * `expected_office_expenses_ignoring_writeoffs_amount`\n * `expected_reduced_ignoring_writeoffs_amount`\n * `tax_amount`\n * `variable_cost_rate_amount`\n\nWhen creating `loglines` the `other_timekeepers` field is also available. The accepted format\nfor this field is a list of user ids.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01`\n* `user`, eg. `?user=1`\n* `matter`, eg. `?matter=1`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `billed_on_invoice`, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=1`\n* `billed_elsewhere`, eg. `?billed_elsewhere=true`\n* `is_billed`, eg. `?is_billed=true` (true returns final or elsewhere; false includes not billed and draft-only)\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,recofa_category,is_billed`.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Logline"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Logline"}}}, "tags": ["loglines"]}, "parameters": []}, "/loglines/{id}/": {"get": {"operationId": "loglines_read", "summary": "This endpoint represents the loglines (time entries).", "description": "## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active` - boolean\n* `activity`\n* `billable_minutes`\n* `billable_status` - The available options are:\n * `W` - Written off\n * `D` - Billed\n * `C` - On draft invoice\n * `0` - Zero rate\n * `B` - Billable\n * `PW` - Partially written off\n * `ED` - Billed elsewhere\n * `NB` - Non-billable\n * `0PW`- Zero rate / Partially written off\n* `is_billed_anywhere` - true when the logline is on a final or draft invoice;\n user should not be able to edit/delete billed logline\n* `is_billed` - true when the logline is on a final invoice or billed elsewhere\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `comment` - internal comment of time entry\n* `created_by` - who created the time entry\n* `created_date` - when the time entry was created\n* `date` - date of work\n* `description` - description of time entry.\n* `expense`\n* `is_billable` - read-only field determined by `type` (matter_billable_type).\n* `is_zero_rate` - read-only field determined by `type` (matter_billable_type).\n* `matter` - the matter to which time has been allocated.\n* `type` - matter_billable_type, used by the mobile app. This field acts as a helper that determines the values of\n `is_billable` and `is_zero_rate`.\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `submatter`\n* `user` - the fee earner that the time is allocated to\n* `writeoff_line`\n* `written_off_minutes`\n* `...amount` fields. All amounts are in the reference currency of the system.\n * `amount` - The monetary value of the logline.\n * `expected_amount` - the \"expected\" amount of the logline. Only non-zero when\n not on an invoice.\n * `draft_amount` - the \"draft\" amount of the logline. Only non-zero if the time\n entry is on a draft invoice.\n * `billed_amount` - the \"billed\" amount of the logline. Only non-zero if the time\n entry is actually billed.\n * `paid_amount` - how much of the time entry has been paid.\n * `original_amount` - only set for time-entries originating from a different\n system, on initial data conversion.\n * `billed_office_expenses_amount`\n * `cost_rate_amount`\n * `expected_below_cap_amount`\n * `expected_client_rate_amount`\n * `expected_hourly_rate_amount`\n * `expected_ignoring_writeoffs_amount`\n * `expected_office_expenses_amount`\n * `expected_office_expenses_ignoring_writeoffs_amount`\n * `expected_reduced_ignoring_writeoffs_amount`\n * `tax_amount`\n * `variable_cost_rate_amount`\n\nWhen creating `loglines` the `other_timekeepers` field is also available. The accepted format\nfor this field is a list of user ids.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01`\n* `user`, eg. `?user=1`\n* `matter`, eg. `?matter=1`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `billed_on_invoice`, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=1`\n* `billed_elsewhere`, eg. `?billed_elsewhere=true`\n* `is_billed`, eg. `?is_billed=true` (true returns final or elsewhere; false includes not billed and draft-only)\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,recofa_category,is_billed`.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Logline"}}}, "tags": ["loglines"]}, "put": {"operationId": "loglines_update", "summary": "This endpoint represents the loglines (time entries).", "description": "## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active` - boolean\n* `activity`\n* `billable_minutes`\n* `billable_status` - The available options are:\n * `W` - Written off\n * `D` - Billed\n * `C` - On draft invoice\n * `0` - Zero rate\n * `B` - Billable\n * `PW` - Partially written off\n * `ED` - Billed elsewhere\n * `NB` - Non-billable\n * `0PW`- Zero rate / Partially written off\n* `is_billed_anywhere` - true when the logline is on a final or draft invoice;\n user should not be able to edit/delete billed logline\n* `is_billed` - true when the logline is on a final invoice or billed elsewhere\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `comment` - internal comment of time entry\n* `created_by` - who created the time entry\n* `created_date` - when the time entry was created\n* `date` - date of work\n* `description` - description of time entry.\n* `expense`\n* `is_billable` - read-only field determined by `type` (matter_billable_type).\n* `is_zero_rate` - read-only field determined by `type` (matter_billable_type).\n* `matter` - the matter to which time has been allocated.\n* `type` - matter_billable_type, used by the mobile app. This field acts as a helper that determines the values of\n `is_billable` and `is_zero_rate`.\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `submatter`\n* `user` - the fee earner that the time is allocated to\n* `writeoff_line`\n* `written_off_minutes`\n* `...amount` fields. All amounts are in the reference currency of the system.\n * `amount` - The monetary value of the logline.\n * `expected_amount` - the \"expected\" amount of the logline. Only non-zero when\n not on an invoice.\n * `draft_amount` - the \"draft\" amount of the logline. Only non-zero if the time\n entry is on a draft invoice.\n * `billed_amount` - the \"billed\" amount of the logline. Only non-zero if the time\n entry is actually billed.\n * `paid_amount` - how much of the time entry has been paid.\n * `original_amount` - only set for time-entries originating from a different\n system, on initial data conversion.\n * `billed_office_expenses_amount`\n * `cost_rate_amount`\n * `expected_below_cap_amount`\n * `expected_client_rate_amount`\n * `expected_hourly_rate_amount`\n * `expected_ignoring_writeoffs_amount`\n * `expected_office_expenses_amount`\n * `expected_office_expenses_ignoring_writeoffs_amount`\n * `expected_reduced_ignoring_writeoffs_amount`\n * `tax_amount`\n * `variable_cost_rate_amount`\n\nWhen creating `loglines` the `other_timekeepers` field is also available. The accepted format\nfor this field is a list of user ids.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01`\n* `user`, eg. `?user=1`\n* `matter`, eg. `?matter=1`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `billed_on_invoice`, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=1`\n* `billed_elsewhere`, eg. `?billed_elsewhere=true`\n* `is_billed`, eg. `?is_billed=true` (true returns final or elsewhere; false includes not billed and draft-only)\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,recofa_category,is_billed`.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Logline"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Logline"}}}, "tags": ["loglines"]}, "delete": {"operationId": "loglines_delete", "summary": "This endpoint represents the loglines (time entries).", "description": "## Fields\n\nThe following fields are available:\n\n* `id`\n* `display_name`\n* `url`\n* `is_active` - boolean\n* `activity`\n* `billable_minutes`\n* `billable_status` - The available options are:\n * `W` - Written off\n * `D` - Billed\n * `C` - On draft invoice\n * `0` - Zero rate\n * `B` - Billable\n * `PW` - Partially written off\n * `ED` - Billed elsewhere\n * `NB` - Non-billable\n * `0PW`- Zero rate / Partially written off\n* `is_billed_anywhere` - true when the logline is on a final or draft invoice;\n user should not be able to edit/delete billed logline\n* `is_billed` - true when the logline is on a final invoice or billed elsewhere\n* `billed_elsewhere`\n* `billed_on_invoice`\n* `billed_on_invoice_draft`\n* `comment` - internal comment of time entry\n* `created_by` - who created the time entry\n* `created_date` - when the time entry was created\n* `date` - date of work\n* `description` - description of time entry.\n* `expense`\n* `is_billable` - read-only field determined by `type` (matter_billable_type).\n* `is_zero_rate` - read-only field determined by `type` (matter_billable_type).\n* `matter` - the matter to which time has been allocated.\n* `type` - matter_billable_type, used by the mobile app. This field acts as a helper that determines the values of\n `is_billable` and `is_zero_rate`.\n* `minutes`\n* `modified_date`\n* `recofa_category`\n* `submatter`\n* `user` - the fee earner that the time is allocated to\n* `writeoff_line`\n* `written_off_minutes`\n* `...amount` fields. All amounts are in the reference currency of the system.\n * `amount` - The monetary value of the logline.\n * `expected_amount` - the \"expected\" amount of the logline. Only non-zero when\n not on an invoice.\n * `draft_amount` - the \"draft\" amount of the logline. Only non-zero if the time\n entry is on a draft invoice.\n * `billed_amount` - the \"billed\" amount of the logline. Only non-zero if the time\n entry is actually billed.\n * `paid_amount` - how much of the time entry has been paid.\n * `original_amount` - only set for time-entries originating from a different\n system, on initial data conversion.\n * `billed_office_expenses_amount`\n * `cost_rate_amount`\n * `expected_below_cap_amount`\n * `expected_client_rate_amount`\n * `expected_hourly_rate_amount`\n * `expected_ignoring_writeoffs_amount`\n * `expected_office_expenses_amount`\n * `expected_office_expenses_ignoring_writeoffs_amount`\n * `expected_reduced_ignoring_writeoffs_amount`\n * `tax_amount`\n * `variable_cost_rate_amount`\n\nWhen creating `loglines` the `other_timekeepers` field is also available. The accepted format\nfor this field is a list of user ids.\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01`\n* `user`, eg. `?user=1`\n* `matter`, eg. `?matter=1`\n* `date`, eg. `?date=2020-01-01`\n* `date__lte`, eg. `?date__lte=2020-01-01`\n* `date__gte`, eg. `?date__gte=2020-01-01`\n* `billed_on_invoice`, eg. `?billed_on_invoice=1`\n* `billed_on_invoice_draft`, eg. `?billed_on_invoice_draft=1`\n* `billed_elsewhere`, eg. `?billed_elsewhere=true`\n* `is_billed`, eg. `?is_billed=true` (true returns final or elsewhere; false includes not billed and draft-only)\n\n## Extra fields\n\nAll fields that are present in the detail view can be requested in the list view.\nFor instance: `?extra_fields=activity,recofa_category,is_billed`.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["loglines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/matterarchiveinformation/": {"get": {"operationId": "matterarchiveinformation_list", "summary": "This endpoint represents the matter archive information.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `check_out_date`\n* `checked_out_by`\n* `check_out_comments`\n* `matter` - matter id\n* `notes`\n* `number` - type `null` to assign a new number automatically.\n* `retention_end_date` - readonly\n* `retention_period`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterArchiveInformation"}}}}}}, "tags": ["matterarchiveinformation"]}, "post": {"operationId": "matterarchiveinformation_create", "summary": "This endpoint represents the matter archive information.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `check_out_date`\n* `checked_out_by`\n* `check_out_comments`\n* `matter` - matter id\n* `notes`\n* `number` - type `null` to assign a new number automatically.\n* `retention_end_date` - readonly\n* `retention_period`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterArchiveInformation"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterArchiveInformation"}}}, "tags": ["matterarchiveinformation"]}, "parameters": []}, "/matterarchiveinformation/{id}/": {"get": {"operationId": "matterarchiveinformation_read", "summary": "This endpoint represents the matter archive information.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `check_out_date`\n* `checked_out_by`\n* `check_out_comments`\n* `matter` - matter id\n* `notes`\n* `number` - type `null` to assign a new number automatically.\n* `retention_end_date` - readonly\n* `retention_period`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterArchiveInformation"}}}, "tags": ["matterarchiveinformation"]}, "put": {"operationId": "matterarchiveinformation_update", "summary": "This endpoint represents the matter archive information.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `check_out_date`\n* `checked_out_by`\n* `check_out_comments`\n* `matter` - matter id\n* `notes`\n* `number` - type `null` to assign a new number automatically.\n* `retention_end_date` - readonly\n* `retention_period`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterArchiveInformation"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterArchiveInformation"}}}, "tags": ["matterarchiveinformation"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/matterbudgets/": {"get": {"operationId": "matterbudgets_list", "summary": "This endpoint represents the matterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the matterbudget period\n* `end_date` - end date of the matterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "begin_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_from", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_until", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "amount", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "budget_status", "in": "query", "description": "Budget status", "required": false, "type": "string"}, {"name": "client", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "hours", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "kind", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_billing_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_supervising_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- begin_date\n- end_date\n- hours\n- kind\n- notify_billing_user\n- notify_supervising_user\n- notify_user\n- object_type\n- amount_used\n- hours_used\n- matter\n- client", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterBudget"}}}}}}, "tags": ["matterbudgets"]}, "post": {"operationId": "matterbudgets_create", "summary": "This endpoint represents the matterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the matterbudget period\n* `end_date` - end date of the matterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterBudget"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterBudget"}}}, "tags": ["matterbudgets"]}, "parameters": []}, "/matterbudgets/{id}/": {"get": {"operationId": "matterbudgets_read", "summary": "This endpoint represents the matterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the matterbudget period\n* `end_date` - end date of the matterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterBudget"}}}, "tags": ["matterbudgets"]}, "put": {"operationId": "matterbudgets_update", "summary": "This endpoint represents the matterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the matterbudget period\n* `end_date` - end date of the matterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterBudget"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterBudget"}}}, "tags": ["matterbudgets"]}, "delete": {"operationId": "matterbudgets_delete", "summary": "This endpoint represents the matterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the matterbudget period\n* `end_date` - end date of the matterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["matterbudgets"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/mattercontacts/": {"get": {"operationId": "mattercontacts_list", "summary": "This endpoint represents the matter contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `kind` - contact kind id\n* `their_reference`\n* `matter`\n* `contact`\n* `address`\n* `contact_person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterContact"}}}}}}, "tags": ["mattercontacts"]}, "post": {"operationId": "mattercontacts_create", "summary": "This endpoint represents the matter contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `kind` - contact kind id\n* `their_reference`\n* `matter`\n* `contact`\n* `address`\n* `contact_person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterContact"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterContact"}}}, "tags": ["mattercontacts"]}, "parameters": []}, "/mattercontacts/{id}/": {"get": {"operationId": "mattercontacts_read", "summary": "This endpoint represents the matter contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `kind` - contact kind id\n* `their_reference`\n* `matter`\n* `contact`\n* `address`\n* `contact_person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterContact"}}}, "tags": ["mattercontacts"]}, "put": {"operationId": "mattercontacts_update", "summary": "This endpoint represents the matter contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `kind` - contact kind id\n* `their_reference`\n* `matter`\n* `contact`\n* `address`\n* `contact_person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterContact"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterContact"}}}, "tags": ["mattercontacts"]}, "delete": {"operationId": "mattercontacts_delete", "summary": "This endpoint represents the matter contacts.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `kind` - contact kind id\n* `their_reference`\n* `matter`\n* `contact`\n* `address`\n* `contact_person`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["mattercontacts"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/mattercustomfielddefinitions/": {"get": {"operationId": "mattercustomfielddefinitions_list", "summary": "This endpoint represents the matter custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "excel_export", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "identifier", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "read_only", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "required", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterCustomFieldDefinition"}}}}}}, "tags": ["mattercustomfielddefinitions"]}, "post": {"operationId": "mattercustomfielddefinitions_create", "summary": "This endpoint represents the matter custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterCustomFieldDefinition"}}}, "tags": ["mattercustomfielddefinitions"]}, "parameters": []}, "/mattercustomfielddefinitions/{id}/": {"get": {"operationId": "mattercustomfielddefinitions_read", "summary": "This endpoint represents the matter custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterCustomFieldDefinition"}}}, "tags": ["mattercustomfielddefinitions"]}, "put": {"operationId": "mattercustomfielddefinitions_update", "summary": "This endpoint represents the matter custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterCustomFieldDefinition"}}}, "tags": ["mattercustomfielddefinitions"]}, "delete": {"operationId": "mattercustomfielddefinitions_delete", "summary": "This endpoint represents the matter custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["mattercustomfielddefinitions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/matterdebtors/": {"get": {"operationId": "matterdebtors_list", "summary": "This endpoint represents list of MatterDebtors.", "description": "MatterDebtor has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `debtor` - for more details check `contacts` endpoint\n* `address`\n* `contact_person`\n* `matter`\n* `split_type`:\n * 0 - Full / remaining amount\n * 1 - Amount\n * 2 - Percentage` or `null`\n* `amount`\n* `percentage`\n* `billing_reference`\n* `invoice_send_method`\n * 1 - By regular mail\n * 2 - By email\n * 3 - By regular mail and email` or `null`\n* `email_source`:\n * 1 - debtor\n * 2 - contact person\n * 3 - specific to matter\n* `to_email` - ContactDetail id\n* `cc_email` - ContactDetail id\n* `to_emails_custom`\n* `cc_emails_custom`\n* `dunning_to_emails_custom`\n* `dunning_cc_emails_custom`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `debtor`, eg. `?debtor=1`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "debtor", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterDebtor"}}}}}}, "tags": ["matterdebtors"]}, "post": {"operationId": "matterdebtors_create", "summary": "This endpoint represents list of MatterDebtors.", "description": "MatterDebtor has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `debtor` - for more details check `contacts` endpoint\n* `address`\n* `contact_person`\n* `matter`\n* `split_type`:\n * 0 - Full / remaining amount\n * 1 - Amount\n * 2 - Percentage` or `null`\n* `amount`\n* `percentage`\n* `billing_reference`\n* `invoice_send_method`\n * 1 - By regular mail\n * 2 - By email\n * 3 - By regular mail and email` or `null`\n* `email_source`:\n * 1 - debtor\n * 2 - contact person\n * 3 - specific to matter\n* `to_email` - ContactDetail id\n* `cc_email` - ContactDetail id\n* `to_emails_custom`\n* `cc_emails_custom`\n* `dunning_to_emails_custom`\n* `dunning_cc_emails_custom`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `debtor`, eg. `?debtor=1`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterDebtor"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterDebtor"}}}, "tags": ["matterdebtors"]}, "parameters": []}, "/matterdebtors/{id}/": {"get": {"operationId": "matterdebtors_read", "summary": "This endpoint represents list of MatterDebtors.", "description": "MatterDebtor has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `debtor` - for more details check `contacts` endpoint\n* `address`\n* `contact_person`\n* `matter`\n* `split_type`:\n * 0 - Full / remaining amount\n * 1 - Amount\n * 2 - Percentage` or `null`\n* `amount`\n* `percentage`\n* `billing_reference`\n* `invoice_send_method`\n * 1 - By regular mail\n * 2 - By email\n * 3 - By regular mail and email` or `null`\n* `email_source`:\n * 1 - debtor\n * 2 - contact person\n * 3 - specific to matter\n* `to_email` - ContactDetail id\n* `cc_email` - ContactDetail id\n* `to_emails_custom`\n* `cc_emails_custom`\n* `dunning_to_emails_custom`\n* `dunning_cc_emails_custom`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `debtor`, eg. `?debtor=1`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterDebtor"}}}, "tags": ["matterdebtors"]}, "put": {"operationId": "matterdebtors_update", "summary": "This endpoint represents list of MatterDebtors.", "description": "MatterDebtor has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `debtor` - for more details check `contacts` endpoint\n* `address`\n* `contact_person`\n* `matter`\n* `split_type`:\n * 0 - Full / remaining amount\n * 1 - Amount\n * 2 - Percentage` or `null`\n* `amount`\n* `percentage`\n* `billing_reference`\n* `invoice_send_method`\n * 1 - By regular mail\n * 2 - By email\n * 3 - By regular mail and email` or `null`\n* `email_source`:\n * 1 - debtor\n * 2 - contact person\n * 3 - specific to matter\n* `to_email` - ContactDetail id\n* `cc_email` - ContactDetail id\n* `to_emails_custom`\n* `cc_emails_custom`\n* `dunning_to_emails_custom`\n* `dunning_cc_emails_custom`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `debtor`, eg. `?debtor=1`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterDebtor"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterDebtor"}}}, "tags": ["matterdebtors"]}, "delete": {"operationId": "matterdebtors_delete", "summary": "This endpoint represents list of MatterDebtors.", "description": "MatterDebtor has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `debtor` - for more details check `contacts` endpoint\n* `address`\n* `contact_person`\n* `matter`\n* `split_type`:\n * 0 - Full / remaining amount\n * 1 - Amount\n * 2 - Percentage` or `null`\n* `amount`\n* `percentage`\n* `billing_reference`\n* `invoice_send_method`\n * 1 - By regular mail\n * 2 - By email\n * 3 - By regular mail and email` or `null`\n* `email_source`:\n * 1 - debtor\n * 2 - contact person\n * 3 - specific to matter\n* `to_email` - ContactDetail id\n* `cc_email` - ContactDetail id\n* `to_emails_custom`\n* `cc_emails_custom`\n* `dunning_to_emails_custom`\n* `dunning_cc_emails_custom`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `debtor`, eg. `?debtor=1`\n* `matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n * `modified_date`\n\n For instance: ?extra_fields=modified_date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["matterdebtors"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/matters/": {"get": {"operationId": "matters_list", "summary": "This endpoint represents the matters.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name` - equivalent to `display_select` (backward compatible)\n* `display`\n* `display_select` - equivalent to `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `access_kind` - possible choices:\n 1 - Everyone\n 2 - Choose from list\n* `activity_groups` - List of ids.\n* `aml_required` - boolean or null\n* `archived_date` - read-only\n* `archive_information` - Can be provided if matter is archived. Object with keys:\n - `notes`\n - `number` - type `null` to assign a new number automatically.\n* `billing_instructions`\n* `billing_user` - user id\n* `block_time_entry`\n* `block_time_entry_comments`\n* `can_archive` - read-only\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `client` - client id\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `currency` - derived field.\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date` - date in format YYYY-MM-DD\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status` - derived field. Possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `firm`\n* `insolvency_number`\n* `is_recofa`\n* `magistrate`\n* `name`\n* `invoice_language` - derived field.\n* `is_billable` - derived field.\n* `is_time_entry_blocked` - boolean\n* `legal_aid_number`\n* `logline_submatter_required` - boolean\n* `matter_status` - matter status id\n* `matter_type` - matter type id\n* `number` - type `null` to assign a new number automatically.\n* `office_expenses_rate` - derived field. The value is equal to 4.00 when `is_recofa` is true.\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user` - user id.\n* `points`\n* `practice_area` - practice area id.\n* `practice_group` - practice group id.\n* `price_list` - price list id\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate` - derived field.\n* `referrer` - derived field. Value is referrer id.\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags` - list of strings\n* `users`\n* `wip_percentage`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `access_kind`, eg. `?access_kind=1`\n * 1 - Everyone\n * 2 - Choose from list\n* `aml_required`, eg. `?aml_required=null`\n * `null`\n * `true`\n * `false`\n* `is_billable`, eg. `?is_billable=true`\n * `true`\n * `false`\n* `is_recofa`, eg. `?is_recofa=true`\n * `true`\n * `false`\n* `is_time_entry_blocked`, eg. `?is_time_entry_blocked=true`\n * `true`\n * `false`\n* `invoice_language`, eg. `?invoice_language=nl-nl` (iso language code)\n* `logline_submatter_required`, eg. `?logline_submatter_required=true`\n * `true`\n * `false`\n* `number`, eg. `?number=1001`\n* `modified_date__lte` / `modified_date__gte`, eg. `?modified_date__gte=2020-01-01T15:30:15`.\n Matches against the latest of the matter's own `modified_date` and those of its\n submatters (including soft-deleted ones). The `modified_date` field in responses\n still reflects only the matter's own changes.\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `access_kind`\n* `activities` - **Temporary workaround** (DEV-6965), will be removed in a future release.\n Returns a list of active Activity PKs for the matter.\n* `activity_groups`\n* `aml_required`\n* `archived_date`\n* `billing_instructions`\n* `billing_user`\n* `block_time_entry`\n* `block_time_entry_comments`\n* `chinese_wall_kind`\n* `client`\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status`\n* `firm`\n* `insolvency_number`\n* `invoice_language`\n* `is_billable`\n* `is_recofa`\n* `is_time_entry_blocked`\n* `legal_aid_number`\n* `logline_submatter_required`\n* `magistrate`\n* `matter_status`\n* `matter_type`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user`\n* `points`\n* `practice_area`\n* `practice_group`\n* `price_list`\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate`\n* `referrer`\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags`\n* `users`\n* `wip_percentage`\n\n\n For instance: ?extra_fields=modified_date\n\n## Matter reporting custom fields\n\nIf there are reporting custom fields defined in Legalsense settings (customer-specific,\nvia matter_custom_fields setting), called `custom1`, `custom2`, `custom3`, `custom4`,\nthese will be available in both detail view, and list view (via `extra_fields` param).\n\nReturned value will consist of the verbose name as stated in the matter_custom_fields\ndefinition of the field, and the value (assigned per Matter object):\n\n\"custom1\": {\n \"verbose_name\": \"Some Category\",\n \"value\": \"123\",\n}\n\nThese fields are read only.\n\n## Quicksearch\n\nApart from filtering, you can also apply a search by adding `?quicksearch=name001`.\n\nThis will apply a search on the following fields:\n\n* `name`\n* `number`\n* `client__name`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "softkill_status", "in": "query", "description": "softkill_status", "required": false, "type": "string"}, {"name": "tags", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_billable", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_language", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_recofa", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_time_entry_blocked", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "logline_submatter_required", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "access_kind", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "aml_required", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "quicksearch", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- archived_date\n- tags\n- access_kind\n- activity_groups\n- aml_required\n- billing_instructions\n- billing_user\n- block_time_entry\n- block_time_entry_comments\n- can_archive\n- chinese_wall_kind\n- client\n- client_reference\n- court_reference_number\n- created_by\n- currency\n- custom_fields\n- date\n- display\n- display_select\n- default_invoice_kind\n- description\n- docket_number\n- engagement_letter_status\n- firm\n- insolvency_number\n- invoice_language\n- is_billable\n- is_recofa\n- is_time_entry_blocked\n- legal_aid_number\n- logline_submatter_required\n- magistrate\n- matter_status\n- matter_type\n- name\n- number\n- office_expenses_rate\n- on_hold\n- on_hold_until\n- on_hold_comments\n- originating_user\n- points\n- practice_area\n- practice_group\n- price_list\n- recofa_cap\n- recofa_inventory\n- recofa_court_decision_date\n- reduction_rate\n- referrer\n- rvr_approval_date\n- submatters\n- supervising_user\n- users\n- wip_percentage", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterActivities"}}}}}}, "tags": ["matters"]}, "post": {"operationId": "matters_create", "summary": "This endpoint represents the matters.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name` - equivalent to `display_select` (backward compatible)\n* `display`\n* `display_select` - equivalent to `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `access_kind` - possible choices:\n 1 - Everyone\n 2 - Choose from list\n* `activity_groups` - List of ids.\n* `aml_required` - boolean or null\n* `archived_date` - read-only\n* `archive_information` - Can be provided if matter is archived. Object with keys:\n - `notes`\n - `number` - type `null` to assign a new number automatically.\n* `billing_instructions`\n* `billing_user` - user id\n* `block_time_entry`\n* `block_time_entry_comments`\n* `can_archive` - read-only\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `client` - client id\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `currency` - derived field.\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date` - date in format YYYY-MM-DD\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status` - derived field. Possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `firm`\n* `insolvency_number`\n* `is_recofa`\n* `magistrate`\n* `name`\n* `invoice_language` - derived field.\n* `is_billable` - derived field.\n* `is_time_entry_blocked` - boolean\n* `legal_aid_number`\n* `logline_submatter_required` - boolean\n* `matter_status` - matter status id\n* `matter_type` - matter type id\n* `number` - type `null` to assign a new number automatically.\n* `office_expenses_rate` - derived field. The value is equal to 4.00 when `is_recofa` is true.\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user` - user id.\n* `points`\n* `practice_area` - practice area id.\n* `practice_group` - practice group id.\n* `price_list` - price list id\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate` - derived field.\n* `referrer` - derived field. Value is referrer id.\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags` - list of strings\n* `users`\n* `wip_percentage`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `access_kind`, eg. `?access_kind=1`\n * 1 - Everyone\n * 2 - Choose from list\n* `aml_required`, eg. `?aml_required=null`\n * `null`\n * `true`\n * `false`\n* `is_billable`, eg. `?is_billable=true`\n * `true`\n * `false`\n* `is_recofa`, eg. `?is_recofa=true`\n * `true`\n * `false`\n* `is_time_entry_blocked`, eg. `?is_time_entry_blocked=true`\n * `true`\n * `false`\n* `invoice_language`, eg. `?invoice_language=nl-nl` (iso language code)\n* `logline_submatter_required`, eg. `?logline_submatter_required=true`\n * `true`\n * `false`\n* `number`, eg. `?number=1001`\n* `modified_date__lte` / `modified_date__gte`, eg. `?modified_date__gte=2020-01-01T15:30:15`.\n Matches against the latest of the matter's own `modified_date` and those of its\n submatters (including soft-deleted ones). The `modified_date` field in responses\n still reflects only the matter's own changes.\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `access_kind`\n* `activities` - **Temporary workaround** (DEV-6965), will be removed in a future release.\n Returns a list of active Activity PKs for the matter.\n* `activity_groups`\n* `aml_required`\n* `archived_date`\n* `billing_instructions`\n* `billing_user`\n* `block_time_entry`\n* `block_time_entry_comments`\n* `chinese_wall_kind`\n* `client`\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status`\n* `firm`\n* `insolvency_number`\n* `invoice_language`\n* `is_billable`\n* `is_recofa`\n* `is_time_entry_blocked`\n* `legal_aid_number`\n* `logline_submatter_required`\n* `magistrate`\n* `matter_status`\n* `matter_type`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user`\n* `points`\n* `practice_area`\n* `practice_group`\n* `price_list`\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate`\n* `referrer`\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags`\n* `users`\n* `wip_percentage`\n\n\n For instance: ?extra_fields=modified_date\n\n## Matter reporting custom fields\n\nIf there are reporting custom fields defined in Legalsense settings (customer-specific,\nvia matter_custom_fields setting), called `custom1`, `custom2`, `custom3`, `custom4`,\nthese will be available in both detail view, and list view (via `extra_fields` param).\n\nReturned value will consist of the verbose name as stated in the matter_custom_fields\ndefinition of the field, and the value (assigned per Matter object):\n\n\"custom1\": {\n \"verbose_name\": \"Some Category\",\n \"value\": \"123\",\n}\n\nThese fields are read only.\n\n## Quicksearch\n\nApart from filtering, you can also apply a search by adding `?quicksearch=name001`.\n\nThis will apply a search on the following fields:\n\n* `name`\n* `number`\n* `client__name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Matter"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Matter"}}}, "tags": ["matters"]}, "parameters": []}, "/matters/xml/codex/": {"get": {"operationId": "matters_xml_codex_list", "summary": "This endpoint is for downloading zip file with xml matters for Codex.", "description": "## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `matter_status`, eg. `?matter_status=1`\n* `is_billable`, eg. `?is_billable=True` (True or False)\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`", "parameters": [{"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "softkill_status", "in": "query", "description": "softkill_status", "required": false, "type": "string"}, {"name": "is_billable", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter_status", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- archived_date", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterXmlCodex"}}}}}}, "tags": ["matters"]}, "parameters": []}, "/matters/{id}/": {"get": {"operationId": "matters_read", "summary": "This endpoint represents the matters.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name` - equivalent to `display_select` (backward compatible)\n* `display`\n* `display_select` - equivalent to `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `access_kind` - possible choices:\n 1 - Everyone\n 2 - Choose from list\n* `activity_groups` - List of ids.\n* `aml_required` - boolean or null\n* `archived_date` - read-only\n* `archive_information` - Can be provided if matter is archived. Object with keys:\n - `notes`\n - `number` - type `null` to assign a new number automatically.\n* `billing_instructions`\n* `billing_user` - user id\n* `block_time_entry`\n* `block_time_entry_comments`\n* `can_archive` - read-only\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `client` - client id\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `currency` - derived field.\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date` - date in format YYYY-MM-DD\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status` - derived field. Possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `firm`\n* `insolvency_number`\n* `is_recofa`\n* `magistrate`\n* `name`\n* `invoice_language` - derived field.\n* `is_billable` - derived field.\n* `is_time_entry_blocked` - boolean\n* `legal_aid_number`\n* `logline_submatter_required` - boolean\n* `matter_status` - matter status id\n* `matter_type` - matter type id\n* `number` - type `null` to assign a new number automatically.\n* `office_expenses_rate` - derived field. The value is equal to 4.00 when `is_recofa` is true.\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user` - user id.\n* `points`\n* `practice_area` - practice area id.\n* `practice_group` - practice group id.\n* `price_list` - price list id\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate` - derived field.\n* `referrer` - derived field. Value is referrer id.\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags` - list of strings\n* `users`\n* `wip_percentage`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `access_kind`, eg. `?access_kind=1`\n * 1 - Everyone\n * 2 - Choose from list\n* `aml_required`, eg. `?aml_required=null`\n * `null`\n * `true`\n * `false`\n* `is_billable`, eg. `?is_billable=true`\n * `true`\n * `false`\n* `is_recofa`, eg. `?is_recofa=true`\n * `true`\n * `false`\n* `is_time_entry_blocked`, eg. `?is_time_entry_blocked=true`\n * `true`\n * `false`\n* `invoice_language`, eg. `?invoice_language=nl-nl` (iso language code)\n* `logline_submatter_required`, eg. `?logline_submatter_required=true`\n * `true`\n * `false`\n* `number`, eg. `?number=1001`\n* `modified_date__lte` / `modified_date__gte`, eg. `?modified_date__gte=2020-01-01T15:30:15`.\n Matches against the latest of the matter's own `modified_date` and those of its\n submatters (including soft-deleted ones). The `modified_date` field in responses\n still reflects only the matter's own changes.\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `access_kind`\n* `activities` - **Temporary workaround** (DEV-6965), will be removed in a future release.\n Returns a list of active Activity PKs for the matter.\n* `activity_groups`\n* `aml_required`\n* `archived_date`\n* `billing_instructions`\n* `billing_user`\n* `block_time_entry`\n* `block_time_entry_comments`\n* `chinese_wall_kind`\n* `client`\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status`\n* `firm`\n* `insolvency_number`\n* `invoice_language`\n* `is_billable`\n* `is_recofa`\n* `is_time_entry_blocked`\n* `legal_aid_number`\n* `logline_submatter_required`\n* `magistrate`\n* `matter_status`\n* `matter_type`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user`\n* `points`\n* `practice_area`\n* `practice_group`\n* `price_list`\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate`\n* `referrer`\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags`\n* `users`\n* `wip_percentage`\n\n\n For instance: ?extra_fields=modified_date\n\n## Matter reporting custom fields\n\nIf there are reporting custom fields defined in Legalsense settings (customer-specific,\nvia matter_custom_fields setting), called `custom1`, `custom2`, `custom3`, `custom4`,\nthese will be available in both detail view, and list view (via `extra_fields` param).\n\nReturned value will consist of the verbose name as stated in the matter_custom_fields\ndefinition of the field, and the value (assigned per Matter object):\n\n\"custom1\": {\n \"verbose_name\": \"Some Category\",\n \"value\": \"123\",\n}\n\nThese fields are read only.\n\n## Quicksearch\n\nApart from filtering, you can also apply a search by adding `?quicksearch=name001`.\n\nThis will apply a search on the following fields:\n\n* `name`\n* `number`\n* `client__name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Matter"}}}, "tags": ["matters"]}, "put": {"operationId": "matters_update", "summary": "This endpoint represents the matters.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name` - equivalent to `display_select` (backward compatible)\n* `display`\n* `display_select` - equivalent to `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `access_kind` - possible choices:\n 1 - Everyone\n 2 - Choose from list\n* `activity_groups` - List of ids.\n* `aml_required` - boolean or null\n* `archived_date` - read-only\n* `archive_information` - Can be provided if matter is archived. Object with keys:\n - `notes`\n - `number` - type `null` to assign a new number automatically.\n* `billing_instructions`\n* `billing_user` - user id\n* `block_time_entry`\n* `block_time_entry_comments`\n* `can_archive` - read-only\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `client` - client id\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `currency` - derived field.\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date` - date in format YYYY-MM-DD\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status` - derived field. Possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `firm`\n* `insolvency_number`\n* `is_recofa`\n* `magistrate`\n* `name`\n* `invoice_language` - derived field.\n* `is_billable` - derived field.\n* `is_time_entry_blocked` - boolean\n* `legal_aid_number`\n* `logline_submatter_required` - boolean\n* `matter_status` - matter status id\n* `matter_type` - matter type id\n* `number` - type `null` to assign a new number automatically.\n* `office_expenses_rate` - derived field. The value is equal to 4.00 when `is_recofa` is true.\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user` - user id.\n* `points`\n* `practice_area` - practice area id.\n* `practice_group` - practice group id.\n* `price_list` - price list id\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate` - derived field.\n* `referrer` - derived field. Value is referrer id.\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags` - list of strings\n* `users`\n* `wip_percentage`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `access_kind`, eg. `?access_kind=1`\n * 1 - Everyone\n * 2 - Choose from list\n* `aml_required`, eg. `?aml_required=null`\n * `null`\n * `true`\n * `false`\n* `is_billable`, eg. `?is_billable=true`\n * `true`\n * `false`\n* `is_recofa`, eg. `?is_recofa=true`\n * `true`\n * `false`\n* `is_time_entry_blocked`, eg. `?is_time_entry_blocked=true`\n * `true`\n * `false`\n* `invoice_language`, eg. `?invoice_language=nl-nl` (iso language code)\n* `logline_submatter_required`, eg. `?logline_submatter_required=true`\n * `true`\n * `false`\n* `number`, eg. `?number=1001`\n* `modified_date__lte` / `modified_date__gte`, eg. `?modified_date__gte=2020-01-01T15:30:15`.\n Matches against the latest of the matter's own `modified_date` and those of its\n submatters (including soft-deleted ones). The `modified_date` field in responses\n still reflects only the matter's own changes.\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `access_kind`\n* `activities` - **Temporary workaround** (DEV-6965), will be removed in a future release.\n Returns a list of active Activity PKs for the matter.\n* `activity_groups`\n* `aml_required`\n* `archived_date`\n* `billing_instructions`\n* `billing_user`\n* `block_time_entry`\n* `block_time_entry_comments`\n* `chinese_wall_kind`\n* `client`\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status`\n* `firm`\n* `insolvency_number`\n* `invoice_language`\n* `is_billable`\n* `is_recofa`\n* `is_time_entry_blocked`\n* `legal_aid_number`\n* `logline_submatter_required`\n* `magistrate`\n* `matter_status`\n* `matter_type`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user`\n* `points`\n* `practice_area`\n* `practice_group`\n* `price_list`\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate`\n* `referrer`\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags`\n* `users`\n* `wip_percentage`\n\n\n For instance: ?extra_fields=modified_date\n\n## Matter reporting custom fields\n\nIf there are reporting custom fields defined in Legalsense settings (customer-specific,\nvia matter_custom_fields setting), called `custom1`, `custom2`, `custom3`, `custom4`,\nthese will be available in both detail view, and list view (via `extra_fields` param).\n\nReturned value will consist of the verbose name as stated in the matter_custom_fields\ndefinition of the field, and the value (assigned per Matter object):\n\n\"custom1\": {\n \"verbose_name\": \"Some Category\",\n \"value\": \"123\",\n}\n\nThese fields are read only.\n\n## Quicksearch\n\nApart from filtering, you can also apply a search by adding `?quicksearch=name001`.\n\nThis will apply a search on the following fields:\n\n* `name`\n* `number`\n* `client__name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Matter"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Matter"}}}, "tags": ["matters"]}, "delete": {"operationId": "matters_delete", "summary": "This endpoint represents the matters.", "description": "Using the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name` - equivalent to `display_select` (backward compatible)\n* `display`\n* `display_select` - equivalent to `display_name`\n* `softkill_status` -\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `access_kind` - possible choices:\n 1 - Everyone\n 2 - Choose from list\n* `activity_groups` - List of ids.\n* `aml_required` - boolean or null\n* `archived_date` - read-only\n* `archive_information` - Can be provided if matter is archived. Object with keys:\n - `notes`\n - `number` - type `null` to assign a new number automatically.\n* `billing_instructions`\n* `billing_user` - user id\n* `block_time_entry`\n* `block_time_entry_comments`\n* `can_archive` - read-only\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `client` - client id\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `currency` - derived field.\n* `custom_fields` - list of objects with keys: `identifier` (string), `value` (string).\n Boolean values should be passed as \"True\" or \"False\".\n* `date` - date in format YYYY-MM-DD\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status` - derived field. Possible choices:\n 1 - Not sent to client\n 2 - Sent to client\n 3 - Received back from client\n 4 - Covering agreement\n 5 - Did not become a matter\n* `firm`\n* `insolvency_number`\n* `is_recofa`\n* `magistrate`\n* `name`\n* `invoice_language` - derived field.\n* `is_billable` - derived field.\n* `is_time_entry_blocked` - boolean\n* `legal_aid_number`\n* `logline_submatter_required` - boolean\n* `matter_status` - matter status id\n* `matter_type` - matter type id\n* `number` - type `null` to assign a new number automatically.\n* `office_expenses_rate` - derived field. The value is equal to 4.00 when `is_recofa` is true.\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user` - user id.\n* `points`\n* `practice_area` - practice area id.\n* `practice_group` - practice group id.\n* `price_list` - price list id\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate` - derived field.\n* `referrer` - derived field. Value is referrer id.\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags` - list of strings\n* `users`\n* `wip_percentage`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `access_kind`, eg. `?access_kind=1`\n * 1 - Everyone\n * 2 - Choose from list\n* `aml_required`, eg. `?aml_required=null`\n * `null`\n * `true`\n * `false`\n* `is_billable`, eg. `?is_billable=true`\n * `true`\n * `false`\n* `is_recofa`, eg. `?is_recofa=true`\n * `true`\n * `false`\n* `is_time_entry_blocked`, eg. `?is_time_entry_blocked=true`\n * `true`\n * `false`\n* `invoice_language`, eg. `?invoice_language=nl-nl` (iso language code)\n* `logline_submatter_required`, eg. `?logline_submatter_required=true`\n * `true`\n * `false`\n* `number`, eg. `?number=1001`\n* `modified_date__lte` / `modified_date__gte`, eg. `?modified_date__gte=2020-01-01T15:30:15`.\n Matches against the latest of the matter's own `modified_date` and those of its\n submatters (including soft-deleted ones). The `modified_date` field in responses\n still reflects only the matter's own changes.\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `tags`, eg. `?tags=lorem`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `access_kind`\n* `activities` - **Temporary workaround** (DEV-6965), will be removed in a future release.\n Returns a list of active Activity PKs for the matter.\n* `activity_groups`\n* `aml_required`\n* `archived_date`\n* `billing_instructions`\n* `billing_user`\n* `block_time_entry`\n* `block_time_entry_comments`\n* `chinese_wall_kind`\n* `client`\n* `client_reference`\n* `court_reference_number`\n* `created_by`\n* `created_date`\n* `currency`\n* `custom_fields`\n* `date`\n* `default_invoice_kind`\n* `description`\n* `docket_number`\n* `engagement_letter_status`\n* `firm`\n* `insolvency_number`\n* `invoice_language`\n* `is_billable`\n* `is_recofa`\n* `is_time_entry_blocked`\n* `legal_aid_number`\n* `logline_submatter_required`\n* `magistrate`\n* `matter_status`\n* `matter_type`\n* `modified_date`\n* `name`\n* `number`\n* `office_expenses_rate`\n* `on_hold`\n* `on_hold_until`\n* `on_hold_comments`\n* `originating_user`\n* `points`\n* `practice_area`\n* `practice_group`\n* `price_list`\n* `recofa_cap`\n* `recofa_inventory`\n* `recofa_court_decision_date`\n* `reduction_rate`\n* `referrer`\n* `rvr_approval_date`\n* `submatters`\n* `supervising_user`\n* `tags`\n* `users`\n* `wip_percentage`\n\n\n For instance: ?extra_fields=modified_date\n\n## Matter reporting custom fields\n\nIf there are reporting custom fields defined in Legalsense settings (customer-specific,\nvia matter_custom_fields setting), called `custom1`, `custom2`, `custom3`, `custom4`,\nthese will be available in both detail view, and list view (via `extra_fields` param).\n\nReturned value will consist of the verbose name as stated in the matter_custom_fields\ndefinition of the field, and the value (assigned per Matter object):\n\n\"custom1\": {\n \"verbose_name\": \"Some Category\",\n \"value\": \"123\",\n}\n\nThese fields are read only.\n\n## Quicksearch\n\nApart from filtering, you can also apply a search by adding `?quicksearch=name001`.\n\nThis will apply a search on the following fields:\n\n* `name`\n* `number`\n* `client__name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["matters"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/matters/{id}/archive/": {"post": {"operationId": "matters_archive", "description": "Archive a matter.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterActionArchive"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterActionArchive"}}}, "tags": ["matters"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/matters/{id}/unarchive/": {"post": {"operationId": "matters_unarchive", "description": "Unarchive a matter.", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterActionUnarchive"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterActionUnarchive"}}}, "tags": ["matters"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/matterstatuses/": {"get": {"operationId": "matterstatuses_list", "summary": "This endpoint represents the matter statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n* `billing_on_hold`- boolean field\n* `block_time_entry` - boolean field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterStatus"}}}}}}, "tags": ["matterstatuses"]}, "post": {"operationId": "matterstatuses_create", "summary": "This endpoint represents the matter statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n* `billing_on_hold`- boolean field\n* `block_time_entry` - boolean field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterStatus"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterStatus"}}}, "tags": ["matterstatuses"]}, "parameters": []}, "/matterstatuses/{id}/": {"get": {"operationId": "matterstatuses_read", "summary": "This endpoint represents the matter statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n* `billing_on_hold`- boolean field\n* `block_time_entry` - boolean field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterStatus"}}}, "tags": ["matterstatuses"]}, "put": {"operationId": "matterstatuses_update", "summary": "This endpoint represents the matter statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n* `billing_on_hold`- boolean field\n* `block_time_entry` - boolean field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterStatus"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterStatus"}}}, "tags": ["matterstatuses"]}, "delete": {"operationId": "matterstatuses_delete", "summary": "This endpoint represents the matter statuses.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_default`\n* `billing_on_hold`- boolean field\n* `block_time_entry` - boolean field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["matterstatuses"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/mattertypes/": {"get": {"operationId": "mattertypes_list", "summary": "This endpoint represents the matter types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `code`\n* `is_wwft_required`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/MatterType"}}}}}}, "tags": ["mattertypes"]}, "post": {"operationId": "mattertypes_create", "summary": "This endpoint represents the matter types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `code`\n* `is_wwft_required`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterType"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/MatterType"}}}, "tags": ["mattertypes"]}, "parameters": []}, "/mattertypes/{id}/": {"get": {"operationId": "mattertypes_read", "summary": "This endpoint represents the matter types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `code`\n* `is_wwft_required`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterType"}}}, "tags": ["mattertypes"]}, "put": {"operationId": "mattertypes_update", "summary": "This endpoint represents the matter types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `code`\n* `is_wwft_required`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/MatterType"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/MatterType"}}}, "tags": ["mattertypes"]}, "delete": {"operationId": "mattertypes_delete", "summary": "This endpoint represents the matter types.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `code`\n* `is_wwft_required`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["mattertypes"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/me/": {"get": {"operationId": "me_list", "summary": "Gives information about the current user.", "description": "We provide the following fields:\n\n* `app_features` - A dictionary of application features available to the user.\nKey is a feature name and the value is a (computed) boolean indicating,\nif the user has access to that feature.\n* `avatars` - map of sizes to URLs.\n* `email`\n* `first_name`\n* `id`\n* `language` - The default language code for the application, retrieved from settings.\n* `last_name`\n* `permits` - A dictionary of permissions associated with the user,\nthat are needed for outside clients.\n* `username`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": ""}}, "tags": ["me"]}, "parameters": []}, "/me/time-report/": {"get": {"operationId": "me_time_report", "summary": "Gives information about the current user.", "description": "We provide the following fields:\n\n* `app_features` - A dictionary of application features available to the user.\nKey is a feature name and the value is a (computed) boolean indicating,\nif the user has access to that feature.\n* `avatars` - map of sizes to URLs.\n* `email`\n* `first_name`\n* `id`\n* `language` - The default language code for the application, retrieved from settings.\n* `last_name`\n* `permits` - A dictionary of permissions associated with the user,\nthat are needed for outside clients.\n* `username`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": ""}}, "tags": ["me"]}, "parameters": []}, "/offices/": {"get": {"operationId": "offices_list", "summary": "This endpoint represents the offices.", "description": "This endpoint requires \"office\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Office"}}}}}}, "tags": ["offices"]}, "post": {"operationId": "offices_create", "summary": "This endpoint represents the offices.", "description": "This endpoint requires \"office\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Office"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Office"}}}, "tags": ["offices"]}, "parameters": []}, "/offices/{id}/": {"get": {"operationId": "offices_read", "summary": "This endpoint represents the offices.", "description": "This endpoint requires \"office\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Office"}}}, "tags": ["offices"]}, "put": {"operationId": "offices_update", "summary": "This endpoint represents the offices.", "description": "This endpoint requires \"office\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Office"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Office"}}}, "tags": ["offices"]}, "delete": {"operationId": "offices_delete", "summary": "This endpoint represents the offices.", "description": "This endpoint requires \"office\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["offices"]}, "parameters": [{"name": "id", "in": "path", "description": "A unique integer value identifying this office.", "required": true, "type": "integer"}]}, "/organizationkindsubtypes/": {"get": {"operationId": "organizationkindsubtypes_list", "summary": "This endpoint represents the organization kind subtypes / Legal entity subtypes (in UI).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `name`\n* `is_active` - boolean\n* `organization_kind`:\n * 1 - Domestic legal entity\n * 2 - Foreign legal entity\n * 3 - Partnership\n * 4 - Trust\n* `display_name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/OrganizationKindSubtype"}}}}}}, "tags": ["organizationkindsubtypes"]}, "post": {"operationId": "organizationkindsubtypes_create", "summary": "This endpoint represents the organization kind subtypes / Legal entity subtypes (in UI).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `name`\n* `is_active` - boolean\n* `organization_kind`:\n * 1 - Domestic legal entity\n * 2 - Foreign legal entity\n * 3 - Partnership\n * 4 - Trust\n* `display_name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OrganizationKindSubtype"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/OrganizationKindSubtype"}}}, "tags": ["organizationkindsubtypes"]}, "parameters": []}, "/organizationkindsubtypes/{id}/": {"get": {"operationId": "organizationkindsubtypes_read", "summary": "This endpoint represents the organization kind subtypes / Legal entity subtypes (in UI).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `name`\n* `is_active` - boolean\n* `organization_kind`:\n * 1 - Domestic legal entity\n * 2 - Foreign legal entity\n * 3 - Partnership\n * 4 - Trust\n* `display_name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/OrganizationKindSubtype"}}}, "tags": ["organizationkindsubtypes"]}, "put": {"operationId": "organizationkindsubtypes_update", "summary": "This endpoint represents the organization kind subtypes / Legal entity subtypes (in UI).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `name`\n* `is_active` - boolean\n* `organization_kind`:\n * 1 - Domestic legal entity\n * 2 - Foreign legal entity\n * 3 - Partnership\n * 4 - Trust\n* `display_name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/OrganizationKindSubtype"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/OrganizationKindSubtype"}}}, "tags": ["organizationkindsubtypes"]}, "delete": {"operationId": "organizationkindsubtypes_delete", "summary": "This endpoint represents the organization kind subtypes / Legal entity subtypes (in UI).", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `name`\n* `is_active` - boolean\n* `organization_kind`:\n * 1 - Domestic legal entity\n * 2 - Foreign legal entity\n * 3 - Partnership\n * 4 - Trust\n* `display_name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["organizationkindsubtypes"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/partialpaymentinvoicelines/": {"get": {"operationId": "partialpaymentinvoicelines_list", "summary": "This endpoint represents the partialpaymentinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to partialpaymentinvoicelines:\n* `partially_paid_invoice`\n* `partially_paid_section`\n* `partial_amount`\n* `partial_percentage`\n* `split_type`\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `partially_paid_invoice`\n* `partially_paid_section`\n* `partial_amount`\n* `partial_percentage`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `split_type`\n* `tax_percentage`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section\n- partial_amount\n- partial_percentage\n- partially_paid_invoice\n- partially_paid_section\n- split_type\n- tax_percentage", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PartialPaymentInvoiceline"}}}}}}, "tags": ["partialpaymentinvoicelines"]}, "parameters": []}, "/partialpaymentinvoicelines/{id}/": {"get": {"operationId": "partialpaymentinvoicelines_read", "summary": "This endpoint represents the partialpaymentinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to partialpaymentinvoicelines:\n* `partially_paid_invoice`\n* `partially_paid_section`\n* `partial_amount`\n* `partial_percentage`\n* `split_type`\n* `tax_percentage`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `partially_paid_invoice`\n* `partially_paid_section`\n* `partial_amount`\n* `partial_percentage`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `split_type`\n* `tax_percentage`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PartialPaymentInvoiceline"}}}, "tags": ["partialpaymentinvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/payments/": {"get": {"operationId": "payments_list", "summary": "This endpoint represents the payments.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `date`\n* `amount`\n* `comments`\n* `invoice`\n* `is_outstanding_correction`\n* `is_active`\n* `is_sent_by_email`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `date__lte`, date less than or equal eg. `?date__lte=2020-01-01`\n* `date__gte`, date greater than or equal eg. `?date__gte=2020-01-01`\n* `date__isnull`, date being null / not null. `?date__isnull=true`\n * `true`\n * `false`\n* `invoice`, eg. `\"invoice=123`\n* `is_outstanding_correction`, eg. `?is_outstanding_correction=true`\n * `true`\n * `false` (default)\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `comments`\n* `date`\n* `invoice`\n* `is_outstanding_correction`\n* `is_sent_by_email`\n\nFor instance: ?extra_fields=amount,comments,date", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "date", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "date__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_outstanding_correction", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- comments\n- date\n- invoice\n- is_outstanding_correction\n- is_sent_by_email", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Payment"}}}}}}, "tags": ["payments"]}, "post": {"operationId": "payments_create", "summary": "This endpoint represents the payments.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `date`\n* `amount`\n* `comments`\n* `invoice`\n* `is_outstanding_correction`\n* `is_active`\n* `is_sent_by_email`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `date__lte`, date less than or equal eg. `?date__lte=2020-01-01`\n* `date__gte`, date greater than or equal eg. `?date__gte=2020-01-01`\n* `date__isnull`, date being null / not null. `?date__isnull=true`\n * `true`\n * `false`\n* `invoice`, eg. `\"invoice=123`\n* `is_outstanding_correction`, eg. `?is_outstanding_correction=true`\n * `true`\n * `false` (default)\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `comments`\n* `date`\n* `invoice`\n* `is_outstanding_correction`\n* `is_sent_by_email`\n\nFor instance: ?extra_fields=amount,comments,date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Payment"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Payment"}}}, "tags": ["payments"]}, "parameters": []}, "/payments/{id}/": {"get": {"operationId": "payments_read", "summary": "This endpoint represents the payments.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `date`\n* `amount`\n* `comments`\n* `invoice`\n* `is_outstanding_correction`\n* `is_active`\n* `is_sent_by_email`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `date__lte`, date less than or equal eg. `?date__lte=2020-01-01`\n* `date__gte`, date greater than or equal eg. `?date__gte=2020-01-01`\n* `date__isnull`, date being null / not null. `?date__isnull=true`\n * `true`\n * `false`\n* `invoice`, eg. `\"invoice=123`\n* `is_outstanding_correction`, eg. `?is_outstanding_correction=true`\n * `true`\n * `false` (default)\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `comments`\n* `date`\n* `invoice`\n* `is_outstanding_correction`\n* `is_sent_by_email`\n\nFor instance: ?extra_fields=amount,comments,date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Payment"}}}, "tags": ["payments"]}, "put": {"operationId": "payments_update", "summary": "This endpoint represents the payments.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `date`\n* `amount`\n* `comments`\n* `invoice`\n* `is_outstanding_correction`\n* `is_active`\n* `is_sent_by_email`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `date__lte`, date less than or equal eg. `?date__lte=2020-01-01`\n* `date__gte`, date greater than or equal eg. `?date__gte=2020-01-01`\n* `date__isnull`, date being null / not null. `?date__isnull=true`\n * `true`\n * `false`\n* `invoice`, eg. `\"invoice=123`\n* `is_outstanding_correction`, eg. `?is_outstanding_correction=true`\n * `true`\n * `false` (default)\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `comments`\n* `date`\n* `invoice`\n* `is_outstanding_correction`\n* `is_sent_by_email`\n\nFor instance: ?extra_fields=amount,comments,date", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Payment"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Payment"}}}, "tags": ["payments"]}, "delete": {"operationId": "payments_delete", "summary": "This endpoint represents the payments.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `date`\n* `amount`\n* `comments`\n* `invoice`\n* `is_outstanding_correction`\n* `is_active`\n* `is_sent_by_email`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `date__lte`, date less than or equal eg. `?date__lte=2020-01-01`\n* `date__gte`, date greater than or equal eg. `?date__gte=2020-01-01`\n* `date__isnull`, date being null / not null. `?date__isnull=true`\n * `true`\n * `false`\n* `invoice`, eg. `\"invoice=123`\n* `is_outstanding_correction`, eg. `?is_outstanding_correction=true`\n * `true`\n * `false` (default)\n\n## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `comments`\n* `date`\n* `invoice`\n* `is_outstanding_correction`\n* `is_sent_by_email`\n\nFor instance: ?extra_fields=amount,comments,date", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["payments"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/practiceareas/": {"get": {"operationId": "practiceareas_list", "summary": "This endpoint represents the practice areas.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `short_name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PracticeArea"}}}}}}, "tags": ["practiceareas"]}, "post": {"operationId": "practiceareas_create", "summary": "This endpoint represents the practice areas.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `short_name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PracticeArea"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/PracticeArea"}}}, "tags": ["practiceareas"]}, "parameters": []}, "/practiceareas/{id}/": {"get": {"operationId": "practiceareas_read", "summary": "This endpoint represents the practice areas.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `short_name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PracticeArea"}}}, "tags": ["practiceareas"]}, "put": {"operationId": "practiceareas_update", "summary": "This endpoint represents the practice areas.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `short_name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PracticeArea"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PracticeArea"}}}, "tags": ["practiceareas"]}, "delete": {"operationId": "practiceareas_delete", "summary": "This endpoint represents the practice areas.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `short_name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["practiceareas"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/practicegroups/": {"get": {"operationId": "practicegroups_list", "summary": "This endpoint represents the practice groups.", "description": "This endpoint requires \"practice_group\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `boss` - supervisor, related user id\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `current_members` - list of objects with key `id` which points to the user.\n* `display_name`\n* `is_active`\n* `name`\n* `short_name`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `boss`\n * `is_active`\n * `chinese_wall_kind`\n * `current_members`\n\n For instance: ?extra_fields=boss", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- boss\n- is_active\n- chinese_wall_kind\n- current_members", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PracticeGroup"}}}}}}, "tags": ["practicegroups"]}, "post": {"operationId": "practicegroups_create", "summary": "This endpoint represents the practice groups.", "description": "This endpoint requires \"practice_group\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `boss` - supervisor, related user id\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `current_members` - list of objects with key `id` which points to the user.\n* `display_name`\n* `is_active`\n* `name`\n* `short_name`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `boss`\n * `is_active`\n * `chinese_wall_kind`\n * `current_members`\n\n For instance: ?extra_fields=boss", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PracticeGroup"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/PracticeGroup"}}}, "tags": ["practicegroups"]}, "parameters": []}, "/practicegroups/{id}/": {"get": {"operationId": "practicegroups_read", "summary": "This endpoint represents the practice groups.", "description": "This endpoint requires \"practice_group\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `boss` - supervisor, related user id\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `current_members` - list of objects with key `id` which points to the user.\n* `display_name`\n* `is_active`\n* `name`\n* `short_name`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `boss`\n * `is_active`\n * `chinese_wall_kind`\n * `current_members`\n\n For instance: ?extra_fields=boss", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PracticeGroup"}}}, "tags": ["practicegroups"]}, "put": {"operationId": "practicegroups_update", "summary": "This endpoint represents the practice groups.", "description": "This endpoint requires \"practice_group\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `boss` - supervisor, related user id\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `current_members` - list of objects with key `id` which points to the user.\n* `display_name`\n* `is_active`\n* `name`\n* `short_name`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `boss`\n * `is_active`\n * `chinese_wall_kind`\n * `current_members`\n\n For instance: ?extra_fields=boss", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/PracticeGroup"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PracticeGroup"}}}, "tags": ["practicegroups"]}, "delete": {"operationId": "practicegroups_delete", "summary": "This endpoint represents the practice groups.", "description": "This endpoint requires \"practice_group\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `boss` - supervisor, related user id\n* `chinese_wall_kind` - on create editable, on update read-only. Possible choices:\n * null - `Both`\n * 1 - `Lawyer`\n * 2 - `Notary`\n* `current_members` - list of objects with key `id` which points to the user.\n* `display_name`\n* `is_active`\n* `name`\n* `short_name`\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `boss`\n * `is_active`\n * `chinese_wall_kind`\n * `current_members`\n\n For instance: ?extra_fields=boss", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["practicegroups"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/pricekeys/": {"get": {"operationId": "pricekeys_list", "summary": "This endpoint represents the price keys.", "description": "Different types of price keys will be returned, and different types will have\ndifferent fields. The `object_type` field specifies which type of price key is\nreturned.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `object_type`\n* `is_rate`\n\nDepending on `object_type` more fields will be present.\n\n* `activitypricekey` has extra field `activity`\n* `functionpricekey` has extra field `function`\n* `legalaidpricekey` has no extra fields.\n* `recofapricekey` has extra fields `user`, `yeearly_base_rate` (decimal),\n `inventory_factory` (decimal) and `experience_factor` (decimal).\n* `singletonpricekey` has no extra fields.\n* `useractivitypricekey` has extra fields `activity` and `user`.\n* `userfunctionpricekey` has extra fields `function` and `user`.\n* `usermonthactivitypricekey` has extra fields `activity`, `user`, `year` (int) and\n `month` (int).\n* `usermonthpricekey` has extra fields `user`, `year` (int) and `month` (int).\n* `userpricekey` has extra field `user`\n\nFor more information on pricing, check the documentation of `pricelists`.", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PriceKey"}}}}}}, "tags": ["pricekeys"]}, "parameters": []}, "/pricekeys/{id}/": {"get": {"operationId": "pricekeys_read", "summary": "This endpoint represents the price keys.", "description": "Different types of price keys will be returned, and different types will have\ndifferent fields. The `object_type` field specifies which type of price key is\nreturned.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `object_type`\n* `is_rate`\n\nDepending on `object_type` more fields will be present.\n\n* `activitypricekey` has extra field `activity`\n* `functionpricekey` has extra field `function`\n* `legalaidpricekey` has no extra fields.\n* `recofapricekey` has extra fields `user`, `yeearly_base_rate` (decimal),\n `inventory_factory` (decimal) and `experience_factor` (decimal).\n* `singletonpricekey` has no extra fields.\n* `useractivitypricekey` has extra fields `activity` and `user`.\n* `userfunctionpricekey` has extra fields `function` and `user`.\n* `usermonthactivitypricekey` has extra fields `activity`, `user`, `year` (int) and\n `month` (int).\n* `usermonthpricekey` has extra fields `user`, `year` (int) and `month` (int).\n* `userpricekey` has extra field `user`\n\nFor more information on pricing, check the documentation of `pricelists`.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PriceKey"}}}, "tags": ["pricekeys"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/pricelists/": {"get": {"operationId": "pricelists_list", "summary": "This endpoint represents the price lists.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `pricing_scheme`\n* `underlying_list`\n* `fixed_fee_underlying_scheme`\n* `fallback_list`\n* `is_template`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `name`, eg. `?name=Prices%20USD`\n* `is_template`, eg. `?is_template=true`\n\n## More information about pricing\n\nPricing in Legalsense is about allocating a monetary value to time entries, and\ncontroling how these time entries appear on invoices.\n\nCalculating the value of a time entry starts at the matter. The matter has a\n`price_list`, which determines which price list is used to calculate the rates.\n\nA price list has a pricing scheme, which determines the logic underlying the pricing\ncalculations. The pricing scheme determines which price keys are used. Then, for\neach price key, there must one or more price objects that can be used to assign\nmonetary value.\n\nPricing schemes can be \"date aware\" or not, which determines whether the\n`begin_date` and `end_date` in price objects may be filled.\n\nLegalsense supports the following pricing schemes:\n\n* `fixed-rate` - The simplest pricing scheme of all. All time entries have the same\n rate. The scheme is date-aware, so it is possible to use different rates for\n different periods.\n* `fixed-rate-user-lines` - The same pricing logic as `fixed-rate`, however during\n invoicing separate invoice lines will be created based on the timekeeper.\n* `function` - Separate functions can be assigned different rates. The price keys\n are the functions. If the `value` of a price object is `null`, the default\n rate for that function will apply.\n* `user` - Separate time keepers can be assigned different rates. Each user will\n have its own price key. When a `value` is not specified, the default rate for that\n user will apply.\n* `activity` - Separate activities can be assigned different rates. Each activity\n will have its own price key. When a `value` is not specified, the defualt rate of\n that activity applies.\n* `fixed-rate-activity` - A combination of the `fixed-rate` and `activity` schemes.\n If an `activity` has `separate_on_invoice=true`, the time entry is priced like\n the `activity` scheme, and otherwise it is priced like the `fixed-rate` scheme.\n* `useractivity` - A combination of `user` and `activity`, similar to\n `fixed-rate-activity`.\n* `usermonth` - Pricing like the `user` scheme, but for each month a new invoiceline\n gets created.\n* `fixed-fee` - The `fixed-fee` is a pricing scheme where a given monetary\n amount is spread over all underlying time entries. This scheme can not be set on a\n client, but only on a matter. This pricing scheme is not date-aware.\n `fixed_fee_underlying_scheme` determines how time entries are weighted in the\n process of distribution of the fixed fee over the time entries.\n* `capped-price` - Similar to `fixed-fee`, but distribution only starts when the\n monetary value would exceed the cap. The `underlying_list` is used to determine\n the pricing of the time entries before the cap, as well as the weighting when the\n cap has been obtained.\n* `recofa` - This pricing scheme implements the pricing mandated by Dutch law for\n insolvency matters.\n* `legalaid` - This pricing scheme implements the pricing mandated by Dutch law for\n legal aid.", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "is_template", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "name", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/PriceList"}}}}}}, "tags": ["pricelists"]}, "parameters": []}, "/pricelists/{id}/": {"get": {"operationId": "pricelists_read", "summary": "This endpoint represents the price lists.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `pricing_scheme`\n* `underlying_list`\n* `fixed_fee_underlying_scheme`\n* `fallback_list`\n* `is_template`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `name`, eg. `?name=Prices%20USD`\n* `is_template`, eg. `?is_template=true`\n\n## More information about pricing\n\nPricing in Legalsense is about allocating a monetary value to time entries, and\ncontroling how these time entries appear on invoices.\n\nCalculating the value of a time entry starts at the matter. The matter has a\n`price_list`, which determines which price list is used to calculate the rates.\n\nA price list has a pricing scheme, which determines the logic underlying the pricing\ncalculations. The pricing scheme determines which price keys are used. Then, for\neach price key, there must one or more price objects that can be used to assign\nmonetary value.\n\nPricing schemes can be \"date aware\" or not, which determines whether the\n`begin_date` and `end_date` in price objects may be filled.\n\nLegalsense supports the following pricing schemes:\n\n* `fixed-rate` - The simplest pricing scheme of all. All time entries have the same\n rate. The scheme is date-aware, so it is possible to use different rates for\n different periods.\n* `fixed-rate-user-lines` - The same pricing logic as `fixed-rate`, however during\n invoicing separate invoice lines will be created based on the timekeeper.\n* `function` - Separate functions can be assigned different rates. The price keys\n are the functions. If the `value` of a price object is `null`, the default\n rate for that function will apply.\n* `user` - Separate time keepers can be assigned different rates. Each user will\n have its own price key. When a `value` is not specified, the default rate for that\n user will apply.\n* `activity` - Separate activities can be assigned different rates. Each activity\n will have its own price key. When a `value` is not specified, the defualt rate of\n that activity applies.\n* `fixed-rate-activity` - A combination of the `fixed-rate` and `activity` schemes.\n If an `activity` has `separate_on_invoice=true`, the time entry is priced like\n the `activity` scheme, and otherwise it is priced like the `fixed-rate` scheme.\n* `useractivity` - A combination of `user` and `activity`, similar to\n `fixed-rate-activity`.\n* `usermonth` - Pricing like the `user` scheme, but for each month a new invoiceline\n gets created.\n* `fixed-fee` - The `fixed-fee` is a pricing scheme where a given monetary\n amount is spread over all underlying time entries. This scheme can not be set on a\n client, but only on a matter. This pricing scheme is not date-aware.\n `fixed_fee_underlying_scheme` determines how time entries are weighted in the\n process of distribution of the fixed fee over the time entries.\n* `capped-price` - Similar to `fixed-fee`, but distribution only starts when the\n monetary value would exceed the cap. The `underlying_list` is used to determine\n the pricing of the time entries before the cap, as well as the weighting when the\n cap has been obtained.\n* `recofa` - This pricing scheme implements the pricing mandated by Dutch law for\n insolvency matters.\n* `legalaid` - This pricing scheme implements the pricing mandated by Dutch law for\n legal aid.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/PriceList"}}}, "tags": ["pricelists"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/prices/": {"get": {"operationId": "prices_list", "summary": "This endpoint represents the price information.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `is_active`\n* `list`\n* `key`\n* `begin_date`\n* `end_date`\n* `value`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `list`, eg. `?list=1`\n* `key`, eg. `?key=1`\n* `begin_date__lte`, eg. `?begin_date__lte=2024-12-31`\n* `end_date__gte`, eg. `?end_date__gte=2024-12-31`\n* `valid_from`, eg. `?valid_from=2024-12-31`\n* `valid_until`, eg. `?valid_until=2025-12-31`\n* `value__isnull`, eg. `?value__isnull=false` - to find records with a value set.\n\nWhen using `valid_from` and `valid_until` all ranges that at least partially\noverlap the range defined by the selected dates will be returned. If using\nonly one of `valid_from` and `valid_until`, an open-ended range is used to\ncheck for (partial) overlap.\n\nFor more information on pricing, check the documentation of `pricelists`.", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "begin_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_from", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_until", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "list", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "key", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "value__isnull", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Price"}}}}}}, "tags": ["prices"]}, "parameters": []}, "/prices/{id}/": {"get": {"operationId": "prices_read", "summary": "This endpoint represents the price information.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `is_active`\n* `list`\n* `key`\n* `begin_date`\n* `end_date`\n* `value`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n* `list`, eg. `?list=1`\n* `key`, eg. `?key=1`\n* `begin_date__lte`, eg. `?begin_date__lte=2024-12-31`\n* `end_date__gte`, eg. `?end_date__gte=2024-12-31`\n* `valid_from`, eg. `?valid_from=2024-12-31`\n* `valid_until`, eg. `?valid_until=2025-12-31`\n* `value__isnull`, eg. `?value__isnull=false` - to find records with a value set.\n\nWhen using `valid_from` and `valid_until` all ranges that at least partially\noverlap the range defined by the selected dates will be returned. If using\nonly one of `valid_from` and `valid_until`, an open-ended range is used to\ncheck for (partial) overlap.\n\nFor more information on pricing, check the documentation of `pricelists`.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Price"}}}, "tags": ["prices"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/productinvoicelines/": {"get": {"operationId": "productinvoicelines_list", "summary": "This endpoint represents the productinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to productinvoicelines:\n* `date`\n* `office_expenses_rate`\n* `quantity`\n* `submatter`\n* `tax_percentage`\n* `unit_price`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `date`\n* `description`\n* `no_details`\n* `object_type`\n* `office_expenses_rate`\n* `paid_amount`\n* `quantity`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `submatter`\n* `tax_percentage`\n* `unit_price`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section\n- date\n- office_expenses_rate\n- quantity\n- submatter\n- unit_price", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/ProductInvoiceline"}}}}}}, "tags": ["productinvoicelines"]}, "parameters": []}, "/productinvoicelines/{id}/": {"get": {"operationId": "productinvoicelines_read", "summary": "This endpoint represents the productinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to productinvoicelines:\n* `date`\n* `office_expenses_rate`\n* `quantity`\n* `submatter`\n* `tax_percentage`\n* `unit_price`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `date`\n* `description`\n* `no_details`\n* `object_type`\n* `office_expenses_rate`\n* `paid_amount`\n* `quantity`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `submatter`\n* `tax_percentage`\n* `unit_price`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ProductInvoiceline"}}}, "tags": ["productinvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/recofacategories/": {"get": {"operationId": "recofacategories_list", "summary": "This endpoint represents the recofa categories.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `code`\n* `name`\n\nBy using the list view, you can access fields:\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/RecofaCategory"}}}}}}, "tags": ["recofacategories"]}, "parameters": []}, "/recofacategories/{id}/": {"get": {"operationId": "recofacategories_read", "summary": "This endpoint represents the recofa categories.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `code`\n* `name`\n\nBy using the list view, you can access fields:\n* `id`\n* `display_name`\n* `url`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/RecofaCategory"}}}, "tags": ["recofacategories"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/referrers/": {"get": {"operationId": "referrers_list", "summary": "This endpoint represents the referrers.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Referrer"}}}}}}, "tags": ["referrers"]}, "post": {"operationId": "referrers_create", "summary": "This endpoint represents the referrers.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Referrer"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Referrer"}}}, "tags": ["referrers"]}, "parameters": []}, "/referrers/{id}/": {"get": {"operationId": "referrers_read", "summary": "This endpoint represents the referrers.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Referrer"}}}, "tags": ["referrers"]}, "put": {"operationId": "referrers_update", "summary": "This endpoint represents the referrers.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Referrer"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Referrer"}}}, "tags": ["referrers"]}, "delete": {"operationId": "referrers_delete", "summary": "This endpoint represents the referrers.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["referrers"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/sectors/": {"get": {"operationId": "sectors_list", "summary": "This endpoint represents the sectors.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Sector"}}}}}}, "tags": ["sectors"]}, "post": {"operationId": "sectors_create", "summary": "This endpoint represents the sectors.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Sector"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Sector"}}}, "tags": ["sectors"]}, "parameters": []}, "/sectors/{id}/": {"get": {"operationId": "sectors_read", "summary": "This endpoint represents the sectors.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Sector"}}}, "tags": ["sectors"]}, "put": {"operationId": "sectors_update", "summary": "This endpoint represents the sectors.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Sector"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Sector"}}}, "tags": ["sectors"]}, "delete": {"operationId": "sectors_delete", "summary": "This endpoint represents the sectors.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `name`\n* `is_active`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["sectors"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/splitfactors/": {"get": {"operationId": "splitfactors_list", "description": "Return a list of split factors, or a specific split factor by id.\nOptionally filtered by matter, user, factor percentage, and date.\n\nIn either the list or the detail view, the following fields are returned:\n\n* `id`: unique identifier of the split factor.\n* `url`: the api url of the split factor.\n* `display_name`: a human-friendly representaiton of the split factor.\n* `user`: the user associated with the split factor.\n* `matter`: the matter associated with the split factor.\n* `factor`: the factor as a decimal percentage (e.g., 25.5 for 25.5%).\n* `begin_date`: (optional) the start date from which the split factor is valid.\n* `end_date`: (optional) the end date until (inclusive) which the split factor is valid.\n\n## Filtering:\n\nBy default, the endpoint returns all split factors.\nIt's possible to filter using the following query parameters:\n\n* `matter`, eg. `?matter=1`, return all split factors for a given matter id.\n* `user`, eg. `?user=1`, return all split factors for a given user id.\n* `factor__lte`, eg. `?factor__lte=50`, return all split factors with percentage\n less than or equal to the given value.\n* `factor__lt`, eg. `?factor__lt=50`, return all split factors with percentage\n less than the given value.\n* `factor__gte`, eg. `?factor__gte=50`, return all split factors with percentage\n greater than or equal to the given value.\n* `factor__gt`, eg. `?factor__gt=50`, return all split factors with percentage\n greater than the given value.\n* `begin_date__lte`, eg. `?begin_date__lte=2020-01-01`, return all split factors\n that are valid on or before the given date.\n* `end_date__gte`, eg. `?end_date__gte=2020-01-01`, return all split factors\n that are valid on or after the given date.\n\n`__lte`, `__lt`, `__gt`, and `__gte` filters can be interchanged and combined.", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "factor", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "begin_date", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "begin_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_from", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_until", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "factor__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "factor__lt", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "factor__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "factor__gt", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SplitFactor"}}}}}}, "tags": ["splitfactors"]}, "parameters": []}, "/splitfactors/{id}/": {"get": {"operationId": "splitfactors_read", "description": "Return a list of split factors, or a specific split factor by id.\nOptionally filtered by matter, user, factor percentage, and date.\n\nIn either the list or the detail view, the following fields are returned:\n\n* `id`: unique identifier of the split factor.\n* `url`: the api url of the split factor.\n* `display_name`: a human-friendly representaiton of the split factor.\n* `user`: the user associated with the split factor.\n* `matter`: the matter associated with the split factor.\n* `factor`: the factor as a decimal percentage (e.g., 25.5 for 25.5%).\n* `begin_date`: (optional) the start date from which the split factor is valid.\n* `end_date`: (optional) the end date until (inclusive) which the split factor is valid.\n\n## Filtering:\n\nBy default, the endpoint returns all split factors.\nIt's possible to filter using the following query parameters:\n\n* `matter`, eg. `?matter=1`, return all split factors for a given matter id.\n* `user`, eg. `?user=1`, return all split factors for a given user id.\n* `factor__lte`, eg. `?factor__lte=50`, return all split factors with percentage\n less than or equal to the given value.\n* `factor__lt`, eg. `?factor__lt=50`, return all split factors with percentage\n less than the given value.\n* `factor__gte`, eg. `?factor__gte=50`, return all split factors with percentage\n greater than or equal to the given value.\n* `factor__gt`, eg. `?factor__gt=50`, return all split factors with percentage\n greater than the given value.\n* `begin_date__lte`, eg. `?begin_date__lte=2020-01-01`, return all split factors\n that are valid on or before the given date.\n* `end_date__gte`, eg. `?end_date__gte=2020-01-01`, return all split factors\n that are valid on or after the given date.\n\n`__lte`, `__lt`, `__gt`, and `__gte` filters can be interchanged and combined.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SplitFactor"}}}, "tags": ["splitfactors"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/submatterbudgets/": {"get": {"operationId": "submatterbudgets_list", "summary": "This endpoint represents the submatterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the submatterbudget period\n* `end_date` - end date of the submatterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter` - read only\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n* `submatter`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `submatter`, e.g. `?submatter=15`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `submatter`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "begin_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "end_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_from", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "valid_until", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "amount", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "budget_status", "in": "query", "description": "Budget status", "required": false, "type": "string"}, {"name": "client", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "hours", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "kind", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_billing_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_supervising_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "notify_user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "submatter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- begin_date\n- end_date\n- hours\n- kind\n- notify_billing_user\n- notify_supervising_user\n- notify_user\n- object_type\n- amount_used\n- hours_used\n- matter\n- submatter\n- client", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SubmatterBudget"}}}}}}, "tags": ["submatterbudgets"]}, "post": {"operationId": "submatterbudgets_create", "summary": "This endpoint represents the submatterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the submatterbudget period\n* `end_date` - end date of the submatterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter` - read only\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n* `submatter`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `submatter`, e.g. `?submatter=15`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `submatter`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SubmatterBudget"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/SubmatterBudget"}}}, "tags": ["submatterbudgets"]}, "parameters": []}, "/submatterbudgets/{id}/": {"get": {"operationId": "submatterbudgets_read", "summary": "This endpoint represents the submatterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the submatterbudget period\n* `end_date` - end date of the submatterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter` - read only\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n* `submatter`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `submatter`, e.g. `?submatter=15`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `submatter`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SubmatterBudget"}}}, "tags": ["submatterbudgets"]}, "put": {"operationId": "submatterbudgets_update", "summary": "This endpoint represents the submatterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the submatterbudget period\n* `end_date` - end date of the submatterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter` - read only\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n* `submatter`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `submatter`, e.g. `?submatter=15`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `submatter`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SubmatterBudget"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SubmatterBudget"}}}, "tags": ["submatterbudgets"]}, "delete": {"operationId": "submatterbudgets_delete", "summary": "This endpoint represents the submatterbudgets.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `amount` - applicable when kind is 2 or 3. Amount in system currency.\n* `amount_used`\n* `begin_date` - begin date of the submatterbudget period\n* `end_date` - end date of the submatterbudget period\n* `client`\n* `hours` - applicable when kind is 1 or 4\n* `hours_used`\n* `kind` -\n * 1 - billable hours\n * 2 - expected amount\n * 3 - virtual amount\n * 4 - all hours\n* `matter` - read only\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `object_type`\n* `submatter`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `begin_date__lte`, begin_date less than eg. `?begin_date__lte=2025-05-01`\n* `end_date__gte`, end_date greater than eg. `?end_date__gte=2025-01-01`\n* `amount`, e.g. `?amount=100`\n* `budget_status`, e.g. `?budget_status=1`\n * 0 - below target\n * 1 - warning threshold\n * 2 - over target\n* `client`, e.g. `?client=5\n* `hours`, e.g. `?hours=10`\n* `kind`, e.g. `?kind=1`\n* `matter`, e.g. `?matter=25`\n* `notify_billing_user`, e.g. `?notify_billing_user=true`\n* `notify_supervising_user`, e.g. `?notify_supervising_user=true`\n* `notify_user`, e.g. `?notify_user=false`\n* `submatter`, e.g. `?submatter=15`\n* `valid_from`, `?valid_from=2025-01-01`\n* `valid_until`, `?valid_until=2025-05-01`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `amount`\n* `amount_used`\n* `begin_date`\n* `end_date`\n* `client`\n* `hours`\n* `hours_used`\n* `kind`\n* `matter`\n* `notify_billing_user`\n* `notify_supervising_user`\n* `notify_user`\n* `submatter`\n\nFor instance: ?extra_fields=amount,client,kind", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["submatterbudgets"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/submatterkinds/": {"get": {"operationId": "submatterkinds_list", "summary": "This endpoint represents the submatter kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `current_unit_price` - applicable only when is_product=true, read only field\n* `display_name`\n* `is_active`\n* `is_product`\n* `name`\n* `name_on_invoice` - nested object with translations: language code as key, translation as value.\n* `ledes_task_code` - LEDES task code for activities written on this submatterkind\nFor empty values, use empty strings in translations. For instance, for available languages nl-nl and en-us:\n`{\n \"en-us\": \"\",\n \"nl-nl\": \"\"\n}`\n* `rates` - applicable only when `is_product=true`. Rates for specified date range. Dates ranges should not\noverlap and there should not be any date ranges without rate specified. Omitted date range ends means infinity or\n-infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/SubmatterKind"}}}}}}, "tags": ["submatterkinds"]}, "post": {"operationId": "submatterkinds_create", "summary": "This endpoint represents the submatter kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `current_unit_price` - applicable only when is_product=true, read only field\n* `display_name`\n* `is_active`\n* `is_product`\n* `name`\n* `name_on_invoice` - nested object with translations: language code as key, translation as value.\n* `ledes_task_code` - LEDES task code for activities written on this submatterkind\nFor empty values, use empty strings in translations. For instance, for available languages nl-nl and en-us:\n`{\n \"en-us\": \"\",\n \"nl-nl\": \"\"\n}`\n* `rates` - applicable only when `is_product=true`. Rates for specified date range. Dates ranges should not\noverlap and there should not be any date ranges without rate specified. Omitted date range ends means infinity or\n-infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SubmatterKind"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/SubmatterKind"}}}, "tags": ["submatterkinds"]}, "parameters": []}, "/submatterkinds/{id}/": {"get": {"operationId": "submatterkinds_read", "summary": "This endpoint represents the submatter kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `current_unit_price` - applicable only when is_product=true, read only field\n* `display_name`\n* `is_active`\n* `is_product`\n* `name`\n* `name_on_invoice` - nested object with translations: language code as key, translation as value.\n* `ledes_task_code` - LEDES task code for activities written on this submatterkind\nFor empty values, use empty strings in translations. For instance, for available languages nl-nl and en-us:\n`{\n \"en-us\": \"\",\n \"nl-nl\": \"\"\n}`\n* `rates` - applicable only when `is_product=true`. Rates for specified date range. Dates ranges should not\noverlap and there should not be any date ranges without rate specified. Omitted date range ends means infinity or\n-infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SubmatterKind"}}}, "tags": ["submatterkinds"]}, "put": {"operationId": "submatterkinds_update", "summary": "This endpoint represents the submatter kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `current_unit_price` - applicable only when is_product=true, read only field\n* `display_name`\n* `is_active`\n* `is_product`\n* `name`\n* `name_on_invoice` - nested object with translations: language code as key, translation as value.\n* `ledes_task_code` - LEDES task code for activities written on this submatterkind\nFor empty values, use empty strings in translations. For instance, for available languages nl-nl and en-us:\n`{\n \"en-us\": \"\",\n \"nl-nl\": \"\"\n}`\n* `rates` - applicable only when `is_product=true`. Rates for specified date range. Dates ranges should not\noverlap and there should not be any date ranges without rate specified. Omitted date range ends means infinity or\n-infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/SubmatterKind"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/SubmatterKind"}}}, "tags": ["submatterkinds"]}, "delete": {"operationId": "submatterkinds_delete", "summary": "This endpoint represents the submatter kinds.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `current_unit_price` - applicable only when is_product=true, read only field\n* `display_name`\n* `is_active`\n* `is_product`\n* `name`\n* `name_on_invoice` - nested object with translations: language code as key, translation as value.\n* `ledes_task_code` - LEDES task code for activities written on this submatterkind\nFor empty values, use empty strings in translations. For instance, for available languages nl-nl and en-us:\n`{\n \"en-us\": \"\",\n \"nl-nl\": \"\"\n}`\n* `rates` - applicable only when `is_product=true`. Rates for specified date range. Dates ranges should not\noverlap and there should not be any date ranges without rate specified. Omitted date range ends means infinity or\n-infinity. For example:\n`[\n {\n \"rate\": 1.0,\n \"end_date\": \"2020-08-01\"\n },\n {\n \"rate\": 2.0,\n \"begin_date\": \"2020-08-02\"\n }\n]`\n\n* `url`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["submatterkinds"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/submatters/": {"get": {"operationId": "submatters_list", "summary": "This endpoint represents list of Submatters.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nSubmatter has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `name`\n* `display_name`\n* `matter`\n* `name_on_invoice`\n* `kind` - submatter kind id\n* `quantity`\n* `billing_date`\n* `unit_price`\n* `originating_subscription` - subscription id\n* `fixed_fee_underlying_scheme`\n* `softkill_status`\n* `billed_on_invoice` - invoice id\n* `billed_on_invoice_draft` - invoice id\n* `billed_elsewhere`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n`matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `created_date`\n * `modified_date`\n * `archived_date`\n * `matter`\n\n For instance: ?extra_fields=modified_date,matter", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- archived_date\n- matter", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Submatter"}}}}}}, "tags": ["submatters"]}, "post": {"operationId": "submatters_create", "summary": "This endpoint represents list of Submatters.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nSubmatter has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `name`\n* `display_name`\n* `matter`\n* `name_on_invoice`\n* `kind` - submatter kind id\n* `quantity`\n* `billing_date`\n* `unit_price`\n* `originating_subscription` - subscription id\n* `fixed_fee_underlying_scheme`\n* `softkill_status`\n* `billed_on_invoice` - invoice id\n* `billed_on_invoice_draft` - invoice id\n* `billed_elsewhere`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n`matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `created_date`\n * `modified_date`\n * `archived_date`\n * `matter`\n\n For instance: ?extra_fields=modified_date,matter", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Submatter"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Submatter"}}}, "tags": ["submatters"]}, "parameters": []}, "/submatters/{id}/": {"get": {"operationId": "submatters_read", "summary": "This endpoint represents list of Submatters.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nSubmatter has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `name`\n* `display_name`\n* `matter`\n* `name_on_invoice`\n* `kind` - submatter kind id\n* `quantity`\n* `billing_date`\n* `unit_price`\n* `originating_subscription` - subscription id\n* `fixed_fee_underlying_scheme`\n* `softkill_status`\n* `billed_on_invoice` - invoice id\n* `billed_on_invoice_draft` - invoice id\n* `billed_elsewhere`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n`matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `created_date`\n * `modified_date`\n * `archived_date`\n * `matter`\n\n For instance: ?extra_fields=modified_date,matter", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Submatter"}}}, "tags": ["submatters"]}, "put": {"operationId": "submatters_update", "summary": "This endpoint represents list of Submatters.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nSubmatter has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `name`\n* `display_name`\n* `matter`\n* `name_on_invoice`\n* `kind` - submatter kind id\n* `quantity`\n* `billing_date`\n* `unit_price`\n* `originating_subscription` - subscription id\n* `fixed_fee_underlying_scheme`\n* `softkill_status`\n* `billed_on_invoice` - invoice id\n* `billed_on_invoice_draft` - invoice id\n* `billed_elsewhere`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n`matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `created_date`\n * `modified_date`\n * `archived_date`\n * `matter`\n\n For instance: ?extra_fields=modified_date,matter", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Submatter"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Submatter"}}}, "tags": ["submatters"]}, "delete": {"operationId": "submatters_delete", "summary": "This endpoint represents list of Submatters.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nSubmatter has the following attributes:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `name`\n* `display_name`\n* `matter`\n* `name_on_invoice`\n* `kind` - submatter kind id\n* `quantity`\n* `billing_date`\n* `unit_price`\n* `originating_subscription` - subscription id\n* `fixed_fee_underlying_scheme`\n* `softkill_status`\n* `billed_on_invoice` - invoice id\n* `billed_on_invoice_draft` - invoice id\n* `billed_elsewhere`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n`matter`, eg. `?matter=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `created_date`\n * `modified_date`\n * `archived_date`\n * `matter`\n\n For instance: ?extra_fields=modified_date,matter", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["submatters"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/subscriptions/": {"get": {"operationId": "subscriptions_list", "summary": "This endpoint represents the subscriptions.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status`\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `begin_date`\n* `billing_date_days_offset`\n* `billing_date_period_reference` - BEGIN or END\n* `default_quantity`\n* `kind`\n* `matter`\n* `name` - derived field\n* `name_on_invoice` - derived field\n* `unit_price`\n* `recurrences` - in rrule format, e.g. RRULE:FREQ=WEEKLY\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "softkill_status", "in": "query", "description": "softkill_status", "required": false, "type": "string"}, {"name": "matter", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- archived_date", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Subscription"}}}}}}, "tags": ["subscriptions"]}, "post": {"operationId": "subscriptions_create", "summary": "This endpoint represents the subscriptions.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status`\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `begin_date`\n* `billing_date_days_offset`\n* `billing_date_period_reference` - BEGIN or END\n* `default_quantity`\n* `kind`\n* `matter`\n* `name` - derived field\n* `name_on_invoice` - derived field\n* `unit_price`\n* `recurrences` - in rrule format, e.g. RRULE:FREQ=WEEKLY\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Subscription"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Subscription"}}}, "tags": ["subscriptions"]}, "parameters": []}, "/subscriptions/{id}/": {"get": {"operationId": "subscriptions_read", "summary": "This endpoint represents the subscriptions.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status`\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `begin_date`\n* `billing_date_days_offset`\n* `billing_date_period_reference` - BEGIN or END\n* `default_quantity`\n* `kind`\n* `matter`\n* `name` - derived field\n* `name_on_invoice` - derived field\n* `unit_price`\n* `recurrences` - in rrule format, e.g. RRULE:FREQ=WEEKLY\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Subscription"}}}, "tags": ["subscriptions"]}, "put": {"operationId": "subscriptions_update", "summary": "This endpoint represents the subscriptions.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status`\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `begin_date`\n* `billing_date_days_offset`\n* `billing_date_period_reference` - BEGIN or END\n* `default_quantity`\n* `kind`\n* `matter`\n* `name` - derived field\n* `name_on_invoice` - derived field\n* `unit_price`\n* `recurrences` - in rrule format, e.g. RRULE:FREQ=WEEKLY\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Subscription"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Subscription"}}}, "tags": ["subscriptions"]}, "delete": {"operationId": "subscriptions_delete", "summary": "This endpoint represents the subscriptions.", "description": "This endpoint requires \"submatters\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `created_date`\n* `modified_date`\n* `archived_date`\n* `id`\n* `display_name`\n* `url`\n* `softkill_status`\n active = 1\n archived = 2\n deleted = 3\n provisional = 4\n* `begin_date`\n* `billing_date_days_offset`\n* `billing_date_period_reference` - BEGIN or END\n* `default_quantity`\n* `kind`\n* `matter`\n* `name` - derived field\n* `name_on_invoice` - derived field\n* `unit_price`\n* `recurrences` - in rrule format, e.g. RRULE:FREQ=WEEKLY\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `softkill_status`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`\n* `softkill_status`, eg. `?softkill_status=all`\n * `active` (default)\n * `all`\n * `archived`\n * `deleted`\n* `matter`, eg. `?matter=1`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["subscriptions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/targets/": {"get": {"operationId": "targets_list", "summary": "This endpoint represents the targets.", "description": "This endpoint requires \"reporting_targets\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `amount`\n* `amount2`\n* `begin_date`\n* `billable_time`\n* `billable_time2`\n* `comments`\n* `end_date`\n* `user`\n* `total_time` - derived field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `user`, eg. `?user=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `user`\n * `amount`\n * `begin_date`\n * `end_date`\n * `billable_time`\n * `total_time`\n\n For instance: ?extra_fields=user", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "user", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- user\n- amount\n- amount2\n- begin_date\n- end_date\n- billable_time\n- billable_time2\n- total_time", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/Target"}}}}}}, "tags": ["targets"]}, "post": {"operationId": "targets_create", "summary": "This endpoint represents the targets.", "description": "This endpoint requires \"reporting_targets\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `amount`\n* `amount2`\n* `begin_date`\n* `billable_time`\n* `billable_time2`\n* `comments`\n* `end_date`\n* `user`\n* `total_time` - derived field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `user`, eg. `?user=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `user`\n * `amount`\n * `begin_date`\n * `end_date`\n * `billable_time`\n * `total_time`\n\n For instance: ?extra_fields=user", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Target"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Target"}}}, "tags": ["targets"]}, "parameters": []}, "/targets/{id}/": {"get": {"operationId": "targets_read", "summary": "This endpoint represents the targets.", "description": "This endpoint requires \"reporting_targets\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `amount`\n* `amount2`\n* `begin_date`\n* `billable_time`\n* `billable_time2`\n* `comments`\n* `end_date`\n* `user`\n* `total_time` - derived field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `user`, eg. `?user=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `user`\n * `amount`\n * `begin_date`\n * `end_date`\n * `billable_time`\n * `total_time`\n\n For instance: ?extra_fields=user", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Target"}}}, "tags": ["targets"]}, "put": {"operationId": "targets_update", "summary": "This endpoint represents the targets.", "description": "This endpoint requires \"reporting_targets\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `amount`\n* `amount2`\n* `begin_date`\n* `billable_time`\n* `billable_time2`\n* `comments`\n* `end_date`\n* `user`\n* `total_time` - derived field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `user`, eg. `?user=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `user`\n * `amount`\n * `begin_date`\n * `end_date`\n * `billable_time`\n * `total_time`\n\n For instance: ?extra_fields=user", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Target"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Target"}}}, "tags": ["targets"]}, "delete": {"operationId": "targets_delete", "summary": "This endpoint represents the targets.", "description": "This endpoint requires \"reporting_targets\" feature to be enabled within the application.\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `amount`\n* `amount2`\n* `begin_date`\n* `billable_time`\n* `billable_time2`\n* `comments`\n* `end_date`\n* `user`\n* `total_time` - derived field\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `user`, eg. `?user=1`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `user`\n * `amount`\n * `begin_date`\n * `end_date`\n * `billable_time`\n * `total_time`\n\n For instance: ?extra_fields=user", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["targets"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/taxcountries/": {"get": {"operationId": "taxcountries_list", "summary": "This endpoint represents the tax country.", "description": "By using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `country`\n * `example_tax_number`\n\n For instance: ?extra_fields=country,example_tax_number", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- country\n- example_tax_number", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TaxCountry"}}}}}}, "tags": ["taxcountries"]}, "parameters": []}, "/taxcountries/{id}/": {"get": {"operationId": "taxcountries_read", "summary": "This endpoint represents the tax country.", "description": "By using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n * `country`\n * `example_tax_number`\n\n For instance: ?extra_fields=country,example_tax_number", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TaxCountry"}}}, "tags": ["taxcountries"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/taxpercentages/": {"get": {"operationId": "taxpercentages_list", "summary": "This endpoint represents tax percentages.", "description": "By using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `begin_date`\n* `end_date`\n* `rate`\n* `value`\n For instance: ?extra_fields=rate,value", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- begin_date\n- end_date\n- rate\n- value", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TaxPercentage"}}}}}}, "tags": ["taxpercentages"]}, "parameters": []}, "/taxpercentages/{id}/": {"get": {"operationId": "taxpercentages_read", "summary": "This endpoint represents tax percentages.", "description": "By using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `begin_date`\n* `end_date`\n* `rate`\n* `value`\n For instance: ?extra_fields=rate,value", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TaxPercentage"}}}, "tags": ["taxpercentages"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/taxrates/": {"get": {"operationId": "taxrates_list", "summary": "This endpoint represents tax rates.", "description": "By using the list view, you can access fields:\n* `id`\n* `url`\n* `display_name`\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `short_name`\n* `country`\n* `is_default_advance_tax_rate` - boolean\n* `is_default_logline_tax_rate` - boolean\n* `is_default_tax_rate` - boolean\n* `is_selectable_logline_tax_rate` - boolean", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TaxRate"}}}}}}, "tags": ["taxrates"]}, "parameters": []}, "/taxrates/{id}/": {"get": {"operationId": "taxrates_read", "summary": "This endpoint represents tax rates.", "description": "By using the list view, you can access fields:\n* `id`\n* `url`\n* `display_name`\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `short_name`\n* `country`\n* `is_default_advance_tax_rate` - boolean\n* `is_default_logline_tax_rate` - boolean\n* `is_default_tax_rate` - boolean\n* `is_selectable_logline_tax_rate` - boolean", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TaxRate"}}}, "tags": ["taxrates"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/taxschemes/": {"get": {"operationId": "taxschemes_list", "summary": "This endpoint represents tax schemes.", "description": "By using the list view, you can access fields:\n\n*`id`\n*`display_name`\n*`url`\n\nBy using the detail view, you can access fields:\n\n* `applicable_tax_rates`\n* `country`\n* `display_name`\n* `id`\n* `is_active`\n* `is_tax_free`\n* `kind`\n* `name`\n* `url`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter(values are comma - separated):\n\n*`applicable_tax_rates`\n*`country`\n*`kind` - integer, choices:\n 1 - Default\n 2 - Intra-community (EU)\n 3 - Outside of the EU\n 4 - None\n 5 - International\n*`is_active`\n*`is_tax_free`\n*`name`\n For instance: ?extra_fields = country, kind", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- applicable_tax_rates\n- country\n- kind\n- is_active\n- is_tax_free\n- name", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TaxScheme"}}}}}}, "tags": ["taxschemes"]}, "parameters": []}, "/taxschemes/{id}/": {"get": {"operationId": "taxschemes_read", "summary": "This endpoint represents tax schemes.", "description": "By using the list view, you can access fields:\n\n*`id`\n*`display_name`\n*`url`\n\nBy using the detail view, you can access fields:\n\n* `applicable_tax_rates`\n* `country`\n* `display_name`\n* `id`\n* `is_active`\n* `is_tax_free`\n* `kind`\n* `name`\n* `url`\n\n## Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter(values are comma - separated):\n\n*`applicable_tax_rates`\n*`country`\n*`kind` - integer, choices:\n 1 - Default\n 2 - Intra-community (EU)\n 3 - Outside of the EU\n 4 - None\n 5 - International\n*`is_active`\n*`is_tax_free`\n*`name`\n For instance: ?extra_fields = country, kind", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TaxScheme"}}}, "tags": ["taxschemes"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/trustaccountingsettlementinvoicelines/": {"get": {"operationId": "trustaccountingsettlementinvoicelines_list", "summary": "This endpoint represents the trustaccountingsettlementinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to trustaccountingsettlementinvoicelines:\n* `trust_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `trust_account`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "id", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "invoice_number", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "object_type", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- amount\n- billables_are_dependent\n- billed_amount\n- billed_amount_ex_office_expenses\n- description\n- object_type\n- no_details\n- paid_amount\n- reduction_amount\n- reduction_rate\n- section\n- trust_account", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TrustAccountingSettlementInvoiceline"}}}}}}, "tags": ["trustaccountingsettlementinvoicelines"]}, "parameters": []}, "/trustaccountingsettlementinvoicelines/{id}/": {"get": {"operationId": "trustaccountingsettlementinvoicelines_read", "summary": "This endpoint represents the trustaccountingsettlementinvoicelines.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `display_name`\n* `url`\n* `object_type`\n* `amount`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `billables_are_dependent`\n* `description`\n* `no_details`\n* `paid_amount`\n* `reduction_amount`\n* `section`\n\nMoreover these are specific to trustaccountingsettlementinvoicelines:\n* `trust_account`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `display_name` (the number of the invoice)\n* `url`\n\n## Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `id` e.g. ?id=1\n* `invoice_number` e.g. ?invoice_number=20240001\n* `object_type`, e.g. ?object_type=loglineinvoiceline\n\n ## Extra fields\n\nIt's possible to show extra fields in list view response when requested,\nusing extra_fields query parameter (values are comma-separated):\n\n* `amount`\n* `billables_are_dependent`\n* `billed_amount`\n* `billed_amount_ex_office_expenses`\n* `description`\n* `no_details`\n* `object_type`\n* `paid_amount`\n* `reduction_amount`\n* `reduction_rate`\n* `section`\n* `trust_account`\n\nFor instance: ?extra_fields=amount,description,billed_amount,billed_amount_ex_office_expenses", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrustAccountingSettlementInvoiceline"}}}, "tags": ["trustaccountingsettlementinvoicelines"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/trustaccountingtransactions/": {"get": {"operationId": "trustaccountingtransactions_list", "summary": "This endpoint represents the trust accounting transactions.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `matter`\n* `date`\n* `description`\n* `amount`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/TrustAccountingTransaction"}}}}}}, "tags": ["trustaccountingtransactions"]}, "post": {"operationId": "trustaccountingtransactions_create", "summary": "This endpoint represents the trust accounting transactions.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `matter`\n* `date`\n* `description`\n* `amount`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/TrustAccountingTransaction"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/TrustAccountingTransaction"}}}, "tags": ["trustaccountingtransactions"]}, "parameters": []}, "/trustaccountingtransactions/{id}/": {"get": {"operationId": "trustaccountingtransactions_read", "summary": "This endpoint represents the trust accounting transactions.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `matter`\n* `date`\n* `description`\n* `amount`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrustAccountingTransaction"}}}, "tags": ["trustaccountingtransactions"]}, "put": {"operationId": "trustaccountingtransactions_update", "summary": "This endpoint represents the trust accounting transactions.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `matter`\n* `date`\n* `description`\n* `amount`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/TrustAccountingTransaction"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/TrustAccountingTransaction"}}}, "tags": ["trustaccountingtransactions"]}, "delete": {"operationId": "trustaccountingtransactions_delete", "summary": "This endpoint represents the trust accounting transactions.", "description": "Using the detail view, you can access fields:\n* `created_date`\n* `modified_date`\n* `id`\n* `url`\n* `display_name`\n* `account`\n* `matter`\n* `date`\n* `description`\n* `amount`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=all`\n * `true` (default) returns active objects\n * `false` returns deleted objects\n * `all` returns active and deleted objects\n\n* `modified_date__lte`, modified_date less than eg. `?modified_date__lte=2020-01-01T15:30:15`\n* `modified_date__gte`, modified_date greater than eg. `?modified_date__gte=2020-01-01T15:30:15`\n* `created_date__lte`, created_date less than eg. `?created_date__lte=2020-01-01T15:30:15`\n* `created_date__gte`, created_date greater than eg. `?created_date__gte=2020-01-01T15:30:15`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["trustaccountingtransactions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/userpreferences/": {"get": {"operationId": "userpreferences_list", "summary": "This endpoint represents the user preferences.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `default_reporting_currency` - derived field.\n* `display_name`\n* `user`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\nPass `null` to use system currency or currency code (ISO-4217).\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `user`, eg. `?user=1`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UserPreference"}}}}}}, "tags": ["userpreferences"]}, "parameters": []}, "/userpreferences/{id}/": {"get": {"operationId": "userpreferences_read", "summary": "This endpoint represents the user preferences.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `default_reporting_currency` - derived field.\n* `display_name`\n* `user`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\nPass `null` to use system currency or currency code (ISO-4217).\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `user`, eg. `?user=1`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UserPreference"}}}, "tags": ["userpreferences"]}, "put": {"operationId": "userpreferences_update", "summary": "This endpoint represents the user preferences.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `default_reporting_currency` - derived field.\n* `display_name`\n* `user`\n\nDerived fields accept following input:\n{\n \"internal\": null\n}\nPass `null` to use system currency or currency code (ISO-4217).\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `user`, eg. `?user=1`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/UserPreference"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UserPreference"}}}, "tags": ["userpreferences"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/userprofilecustomfielddefinitions/": {"get": {"operationId": "userprofilecustomfielddefinitions_list", "summary": "This endpoint represents the user profile custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "is_active", "in": "query", "description": "is_active", "required": false, "type": "string"}, {"name": "excel_export", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "identifier", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "read_only", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "required", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/UserProfileCustomFieldDefinition"}}}}}}, "tags": ["userprofilecustomfielddefinitions"]}, "post": {"operationId": "userprofilecustomfielddefinitions_create", "summary": "This endpoint represents the user profile custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/UserProfileCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/UserProfileCustomFieldDefinition"}}}, "tags": ["userprofilecustomfielddefinitions"]}, "parameters": []}, "/userprofilecustomfielddefinitions/{id}/": {"get": {"operationId": "userprofilecustomfielddefinitions_read", "summary": "This endpoint represents the user profile custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UserProfileCustomFieldDefinition"}}}, "tags": ["userprofilecustomfielddefinitions"]}, "put": {"operationId": "userprofilecustomfielddefinitions_update", "summary": "This endpoint represents the user profile custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/UserProfileCustomFieldDefinition"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/UserProfileCustomFieldDefinition"}}}, "tags": ["userprofilecustomfielddefinitions"]}, "delete": {"operationId": "userprofilecustomfielddefinitions_delete", "summary": "This endpoint represents the user profile custom field definitions.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n* `is_active` - boolean\n* `default`\n* `excel_export` - boolean\n* `excel_export_value`\n * 1 - Value\n * 2 - Display text\n * 3 - Both value and display text\n* `extra_info` - When the 'Select' widget is chosen, add options in this field.\n One option per line, in the form of 'value|display text'. Lines are separated by \\n\n* `help_text`\n* `identifier`\n* `name`\n* `read_only` - boolean\n* `required` - boolean\n* `widget`\n * 1 - Text input\n * 2 - Number input\n * 3 - Dropdown box\n * 4 - Checkbox\n * 5 - URL\n * 6 - Long text input\n * 7 - Datepicker\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `is_active` - boolean\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `is_active`, eg. `?is_active=false`\n* `identifier`\n* `required`\n* `read_only`\n* `excel_export`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["userprofilecustomfielddefinitions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/users/": {"get": {"operationId": "users_list", "summary": "This endpoint represents the users.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `abbreviation`\n* `begin_date`\n* `cost_rates` - list of objects with keys: `rate`, `begin_date`, `end_date`. Date intervals cannot overlap.\n* `dashboard_note`\n* `display_name`\n* `email`\n* `employee_number`\n* `end_date`\n* `first_name`\n* `functions` - list of objects with keys: `function`, `begin_date`, `end_date`. `functions` is an object with\nkey `id` which points to the function. Date intervals cannot overlap and cannot have gaps in between.\n* `groups` - list of objects with key `id` which points to the group.\n* `initials`\n* `is_fee_earner`\n* `last_name`\n* `last_release` - used to decide if the user should see a release notification\n* `leverage_teams` - list of objects with keys: `leverage_team`, `begin_date`, `end_date`. `leverage_team` is\nan object with key `id` which points to the leverage_team.\n* `name_prefix`\n* `offices` - list of objects with keys: `office`, `begin_date`, `end_date`. `office` is an object with\nkey `id` which points to the office.\n* `practice_groups` - list of objects with keys: `practice_group`, `begin_date`, `end_date`.\n`practice_group` is an object with key `id` which points to the practice group.\n* `rates` - list of objects with keys: `rate`, `begin_date`, `end_date`. Date intervals cannot overlap.\n* `title`\n* `url`\n* `username`\n* `variable_cost_rates` - list of objects with keys: `rate`, `begin_date`, `end_date`.\nDate intervals cannot overlap.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `status`, eg. `?status=active`\n * `active` returns users that are currently active (and able to log in)\n * `inactive` returns list of users that no longer have possibility to log in, in other words if current date\n does not belong to the range between begin_date and end_date fields in particular user's profile\n * `archived` returns users that are not active (disabled / prevented from logging in)\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `abbreviation`\n* `begin_date`\n* `billing_assistant`\n* `cost_rates`\n* `custom_fields`\n* `dashboard_note`\n* `email`\n* `employee_number`\n* `end_date`\n* `expected_hours_factor`\n* `first_name`\n* `functions`\n* `groups`\n* `initials`\n* `is_fee_earner`\n* `is_selectable`\n* `last_name`\n* `last_release`\n* `leverage_teams`\n* `name_prefix`\n* `offices`\n* `practice_groups`\n* `rates`\n* `receive_security_email`\n* `recofa_begin_date`\n* `recofa_sworn_in_date`\n* `title`\n* `username`\n* `variable_cost_rates`\n\nFor instance: `?extra_fields=first_name,last_name,groups,practice_groups`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "status", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- abbreviation\n- begin_date\n- billing_assistant\n- cost_rates\n- custom_fields\n- dashboard_note\n- email\n- employee_number\n- end_date\n- expected_hours_factor\n- first_name\n- functions\n- groups\n- initials\n- is_fee_earner\n- is_selectable\n- last_name\n- last_release\n- leverage_teams\n- name_prefix\n- offices\n- practice_groups\n- rates\n- receive_security_email\n- recofa_begin_date\n- recofa_sworn_in_date\n- title\n- username\n- variable_cost_rates", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/User"}}}}}}, "tags": ["users"]}, "post": {"operationId": "users_create", "summary": "This endpoint represents the users.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `abbreviation`\n* `begin_date`\n* `cost_rates` - list of objects with keys: `rate`, `begin_date`, `end_date`. Date intervals cannot overlap.\n* `dashboard_note`\n* `display_name`\n* `email`\n* `employee_number`\n* `end_date`\n* `first_name`\n* `functions` - list of objects with keys: `function`, `begin_date`, `end_date`. `functions` is an object with\nkey `id` which points to the function. Date intervals cannot overlap and cannot have gaps in between.\n* `groups` - list of objects with key `id` which points to the group.\n* `initials`\n* `is_fee_earner`\n* `last_name`\n* `last_release` - used to decide if the user should see a release notification\n* `leverage_teams` - list of objects with keys: `leverage_team`, `begin_date`, `end_date`. `leverage_team` is\nan object with key `id` which points to the leverage_team.\n* `name_prefix`\n* `offices` - list of objects with keys: `office`, `begin_date`, `end_date`. `office` is an object with\nkey `id` which points to the office.\n* `practice_groups` - list of objects with keys: `practice_group`, `begin_date`, `end_date`.\n`practice_group` is an object with key `id` which points to the practice group.\n* `rates` - list of objects with keys: `rate`, `begin_date`, `end_date`. Date intervals cannot overlap.\n* `title`\n* `url`\n* `username`\n* `variable_cost_rates` - list of objects with keys: `rate`, `begin_date`, `end_date`.\nDate intervals cannot overlap.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `status`, eg. `?status=active`\n * `active` returns users that are currently active (and able to log in)\n * `inactive` returns list of users that no longer have possibility to log in, in other words if current date\n does not belong to the range between begin_date and end_date fields in particular user's profile\n * `archived` returns users that are not active (disabled / prevented from logging in)\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `abbreviation`\n* `begin_date`\n* `billing_assistant`\n* `cost_rates`\n* `custom_fields`\n* `dashboard_note`\n* `email`\n* `employee_number`\n* `end_date`\n* `expected_hours_factor`\n* `first_name`\n* `functions`\n* `groups`\n* `initials`\n* `is_fee_earner`\n* `is_selectable`\n* `last_name`\n* `last_release`\n* `leverage_teams`\n* `name_prefix`\n* `offices`\n* `practice_groups`\n* `rates`\n* `receive_security_email`\n* `recofa_begin_date`\n* `recofa_sworn_in_date`\n* `title`\n* `username`\n* `variable_cost_rates`\n\nFor instance: `?extra_fields=first_name,last_name,groups,practice_groups`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["users"]}, "parameters": []}, "/users/{id}/": {"get": {"operationId": "users_read", "summary": "This endpoint represents the users.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `abbreviation`\n* `begin_date`\n* `cost_rates` - list of objects with keys: `rate`, `begin_date`, `end_date`. Date intervals cannot overlap.\n* `dashboard_note`\n* `display_name`\n* `email`\n* `employee_number`\n* `end_date`\n* `first_name`\n* `functions` - list of objects with keys: `function`, `begin_date`, `end_date`. `functions` is an object with\nkey `id` which points to the function. Date intervals cannot overlap and cannot have gaps in between.\n* `groups` - list of objects with key `id` which points to the group.\n* `initials`\n* `is_fee_earner`\n* `last_name`\n* `last_release` - used to decide if the user should see a release notification\n* `leverage_teams` - list of objects with keys: `leverage_team`, `begin_date`, `end_date`. `leverage_team` is\nan object with key `id` which points to the leverage_team.\n* `name_prefix`\n* `offices` - list of objects with keys: `office`, `begin_date`, `end_date`. `office` is an object with\nkey `id` which points to the office.\n* `practice_groups` - list of objects with keys: `practice_group`, `begin_date`, `end_date`.\n`practice_group` is an object with key `id` which points to the practice group.\n* `rates` - list of objects with keys: `rate`, `begin_date`, `end_date`. Date intervals cannot overlap.\n* `title`\n* `url`\n* `username`\n* `variable_cost_rates` - list of objects with keys: `rate`, `begin_date`, `end_date`.\nDate intervals cannot overlap.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `status`, eg. `?status=active`\n * `active` returns users that are currently active (and able to log in)\n * `inactive` returns list of users that no longer have possibility to log in, in other words if current date\n does not belong to the range between begin_date and end_date fields in particular user's profile\n * `archived` returns users that are not active (disabled / prevented from logging in)\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `abbreviation`\n* `begin_date`\n* `billing_assistant`\n* `cost_rates`\n* `custom_fields`\n* `dashboard_note`\n* `email`\n* `employee_number`\n* `end_date`\n* `expected_hours_factor`\n* `first_name`\n* `functions`\n* `groups`\n* `initials`\n* `is_fee_earner`\n* `is_selectable`\n* `last_name`\n* `last_release`\n* `leverage_teams`\n* `name_prefix`\n* `offices`\n* `practice_groups`\n* `rates`\n* `receive_security_email`\n* `recofa_begin_date`\n* `recofa_sworn_in_date`\n* `title`\n* `username`\n* `variable_cost_rates`\n\nFor instance: `?extra_fields=first_name,last_name,groups,practice_groups`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["users"]}, "put": {"operationId": "users_update", "summary": "This endpoint represents the users.", "description": "Using the detail view, you can access fields:\n\n* `id`\n* `abbreviation`\n* `begin_date`\n* `cost_rates` - list of objects with keys: `rate`, `begin_date`, `end_date`. Date intervals cannot overlap.\n* `dashboard_note`\n* `display_name`\n* `email`\n* `employee_number`\n* `end_date`\n* `first_name`\n* `functions` - list of objects with keys: `function`, `begin_date`, `end_date`. `functions` is an object with\nkey `id` which points to the function. Date intervals cannot overlap and cannot have gaps in between.\n* `groups` - list of objects with key `id` which points to the group.\n* `initials`\n* `is_fee_earner`\n* `last_name`\n* `last_release` - used to decide if the user should see a release notification\n* `leverage_teams` - list of objects with keys: `leverage_team`, `begin_date`, `end_date`. `leverage_team` is\nan object with key `id` which points to the leverage_team.\n* `name_prefix`\n* `offices` - list of objects with keys: `office`, `begin_date`, `end_date`. `office` is an object with\nkey `id` which points to the office.\n* `practice_groups` - list of objects with keys: `practice_group`, `begin_date`, `end_date`.\n`practice_group` is an object with key `id` which points to the practice group.\n* `rates` - list of objects with keys: `rate`, `begin_date`, `end_date`. Date intervals cannot overlap.\n* `title`\n* `url`\n* `username`\n* `variable_cost_rates` - list of objects with keys: `rate`, `begin_date`, `end_date`.\nDate intervals cannot overlap.\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `display_name`\n\n## Filtering:\n\nIt's possible to filter using the following query parameters:\n\n* `status`, eg. `?status=active`\n * `active` returns users that are currently active (and able to log in)\n * `inactive` returns list of users that no longer have possibility to log in, in other words if current date\n does not belong to the range between begin_date and end_date fields in particular user's profile\n * `archived` returns users that are not active (disabled / prevented from logging in)\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n* `abbreviation`\n* `begin_date`\n* `billing_assistant`\n* `cost_rates`\n* `custom_fields`\n* `dashboard_note`\n* `email`\n* `employee_number`\n* `end_date`\n* `expected_hours_factor`\n* `first_name`\n* `functions`\n* `groups`\n* `initials`\n* `is_fee_earner`\n* `is_selectable`\n* `last_name`\n* `last_release`\n* `leverage_teams`\n* `name_prefix`\n* `offices`\n* `practice_groups`\n* `rates`\n* `receive_security_email`\n* `recofa_begin_date`\n* `recofa_sworn_in_date`\n* `title`\n* `username`\n* `variable_cost_rates`\n\nFor instance: `?extra_fields=first_name,last_name,groups,practice_groups`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/User"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/User"}}}, "tags": ["users"]}, "delete": {"operationId": "users_delete", "summary": "Archive the user.", "description": "Users in Legalsense cannot be deleted, only archived. This endpoint is\nkept for backwards compatibility and is deprecated; prefer\n`POST /api/v3/users/{pk}/archive/` instead.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": ""}}, "tags": ["users"], "deprecated": true}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/users/{id}/archive/": {"post": {"operationId": "users_archive", "summary": "Archive the user.", "description": "Users in Legalsense cannot be completely deleted, only archived.\nArchived users are still selectable in some cases. They can only be made\n\"unselectable\" by an Admin action in the UI.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": "User archived successfully"}}, "tags": ["users"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/users/{id}/unarchive/": {"post": {"operationId": "users_unarchive", "description": "Unarchive the user.", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"204": {"description": "User unarchived successfully"}}, "tags": ["users"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}, "/version/": {"get": {"operationId": "version_list", "description": "", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": ""}}, "tags": ["version"]}, "parameters": []}, "/voicetotimesubmissions/": {"get": {"operationId": "voicetotimesubmissions_list", "summary": "This endpoint represents voice-to-time submissions.", "description": "Submissions allow API clients to upload audio recordings that are\nasynchronously transcribed and converted into draft time entries.\n\n### Permissions\n\nRequires `PERMIT_MANAGE_MY_DRAFTLOGLINE`.\n\nResults are scoped to the authenticated user. Each user can only\nsee and create their own submissions.\n\n### Status mapping\n\nThe status is an enum (int) value, that maps to the following label:\n\n1. Queued\n2. Processing\n3. Completed\n4. Failed\n\n### Creating a submission (POST)\n\nSend a `multipart/form-data` request with an `audio_file` field.\nThe audio file is validated before the submission is created.\nOn success, a submission is created in **Queued** state and\nasynchronous processing is triggered. The detail URL in the\nresponse can be used to poll for status updates.\n\nWhen an error occurs during submission (400, 503), the returned object\ncontains a `detail` key with an explanation. On successful submission (201),\nthe created `VoiceToTimeSubmission` is returned.\n\n### Polling for status (GET detail)\n\nThe `status` field progresses through: Queued, Processing,\nCompleted, or Failed. Once completed, `transcription` and\n`structured_data` are populated.\n\n### Fields\n\nAll fields except `audio_file` are read-only. `audio_file` is write-only\n(accepted on POST, not returned in responses).\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `status`\n* `transcription`\n* `structured_data`\n* `created_date`\n* `modified_date`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `status`\n\n#### Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `transcription`\n* `structured_data`\n* `created_date`\n* `modified_date`\n\n#### Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `status`, eg. `?status=1` (1=Queued, 2=Processing, 3=Completed, 4=Failed)\n* `created_date__gte`, eg. `?created_date__gte=2026-01-01T00:00:00Z`\n* `created_date__lte`\n* `modified_date__gte`\n* `modified_date__lte`", "parameters": [{"name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string"}, {"name": "modified_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "modified_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__lte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "created_date__gte", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "status", "in": "query", "description": "", "required": false, "type": "string"}, {"name": "page", "in": "query", "description": "A page number within the paginated result set.", "required": false, "type": "integer"}, {"name": "page_size", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer"}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}, {"name": "extra_fields", "in": "query", "description": "Extra fields to return. Comma separated without spaces. Choose from: \n- created_date\n- modified_date\n- structured_data\n- transcription", "type": "query"}], "responses": {"200": {"description": "", "schema": {"required": ["count", "results"], "type": "object", "properties": {"count": {"type": "integer"}, "next": {"type": "string", "format": "uri", "x-nullable": true}, "previous": {"type": "string", "format": "uri", "x-nullable": true}, "results": {"type": "array", "items": {"$ref": "#/definitions/VoiceToTimeSubmission"}}}}}}, "tags": ["voicetotimesubmissions"]}, "post": {"operationId": "voicetotimesubmissions_create", "summary": "This endpoint represents voice-to-time submissions.", "description": "Submissions allow API clients to upload audio recordings that are\nasynchronously transcribed and converted into draft time entries.\n\n### Permissions\n\nRequires `PERMIT_MANAGE_MY_DRAFTLOGLINE`.\n\nResults are scoped to the authenticated user. Each user can only\nsee and create their own submissions.\n\n### Status mapping\n\nThe status is an enum (int) value, that maps to the following label:\n\n1. Queued\n2. Processing\n3. Completed\n4. Failed\n\n### Creating a submission (POST)\n\nSend a `multipart/form-data` request with an `audio_file` field.\nThe audio file is validated before the submission is created.\nOn success, a submission is created in **Queued** state and\nasynchronous processing is triggered. The detail URL in the\nresponse can be used to poll for status updates.\n\nWhen an error occurs during submission (400, 503), the returned object\ncontains a `detail` key with an explanation. On successful submission (201),\nthe created `VoiceToTimeSubmission` is returned.\n\n### Polling for status (GET detail)\n\nThe `status` field progresses through: Queued, Processing,\nCompleted, or Failed. Once completed, `transcription` and\n`structured_data` are populated.\n\n### Fields\n\nAll fields except `audio_file` are read-only. `audio_file` is write-only\n(accepted on POST, not returned in responses).\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `status`\n* `transcription`\n* `structured_data`\n* `created_date`\n* `modified_date`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `status`\n\n#### Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `transcription`\n* `structured_data`\n* `created_date`\n* `modified_date`\n\n#### Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `status`, eg. `?status=1` (1=Queued, 2=Processing, 3=Completed, 4=Failed)\n* `created_date__gte`, eg. `?created_date__gte=2026-01-01T00:00:00Z`\n* `created_date__lte`\n* `modified_date__gte`\n* `modified_date__lte`", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/VoiceToTimeSubmission"}}, {"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/VoiceToTimeSubmission"}}}, "tags": ["voicetotimesubmissions"]}, "parameters": []}, "/voicetotimesubmissions/{id}/": {"get": {"operationId": "voicetotimesubmissions_read", "summary": "This endpoint represents voice-to-time submissions.", "description": "Submissions allow API clients to upload audio recordings that are\nasynchronously transcribed and converted into draft time entries.\n\n### Permissions\n\nRequires `PERMIT_MANAGE_MY_DRAFTLOGLINE`.\n\nResults are scoped to the authenticated user. Each user can only\nsee and create their own submissions.\n\n### Status mapping\n\nThe status is an enum (int) value, that maps to the following label:\n\n1. Queued\n2. Processing\n3. Completed\n4. Failed\n\n### Creating a submission (POST)\n\nSend a `multipart/form-data` request with an `audio_file` field.\nThe audio file is validated before the submission is created.\nOn success, a submission is created in **Queued** state and\nasynchronous processing is triggered. The detail URL in the\nresponse can be used to poll for status updates.\n\nWhen an error occurs during submission (400, 503), the returned object\ncontains a `detail` key with an explanation. On successful submission (201),\nthe created `VoiceToTimeSubmission` is returned.\n\n### Polling for status (GET detail)\n\nThe `status` field progresses through: Queued, Processing,\nCompleted, or Failed. Once completed, `transcription` and\n`structured_data` are populated.\n\n### Fields\n\nAll fields except `audio_file` are read-only. `audio_file` is write-only\n(accepted on POST, not returned in responses).\n\nUsing the detail view, you can access fields:\n\n* `id`\n* `url`\n* `status`\n* `transcription`\n* `structured_data`\n* `created_date`\n* `modified_date`\n\nBy using the list view, you can access fields:\n\n* `id`\n* `url`\n* `status`\n\n#### Extra fields\n\nIt's possible to show following fields in list view when requested,\nusing `extra_fields` query parameter (values are comma-separated):\n\n* `transcription`\n* `structured_data`\n* `created_date`\n* `modified_date`\n\n#### Filtering\n\nIt's possible to filter using the following query parameters:\n\n* `status`, eg. `?status=1` (1=Queued, 2=Processing, 3=Completed, 4=Failed)\n* `created_date__gte`, eg. `?created_date__gte=2026-01-01T00:00:00Z`\n* `created_date__lte`\n* `modified_date__gte`\n* `modified_date__lte`", "parameters": [{"name": "X-Legalsense-Api-Client-Identifier", "in": "header", "description": "Client identifier", "type": "header"}, {"name": "X-Legalsense-Api-Client-Token", "in": "header", "description": "Client token", "type": "header"}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/VoiceToTimeSubmission"}}}, "tags": ["voicetotimesubmissions"]}, "parameters": [{"name": "id", "in": "path", "required": true, "type": "string"}]}}, "definitions": {"Account": {"required": ["name", "groups"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "allow_settling": {"title": "Verrekening op declaraties toestaan", "description": "Derdengeldenverrekening op declaraties is toegestaan voor deze rekening.", "type": "boolean"}, "groups": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}}}, "Activity": {"required": ["rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "billable": {"title": "Beschikbaarheid", "type": "boolean", "x-nullable": true}, "is_default": {"title": "Standaard verrichting", "description": "Deze verrichting wordt voorgeselecteerd bij het invoeren van tijdregels.", "type": "boolean"}, "name": {"title": "Naam", "type": "string"}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "maxLength": 255, "x-nullable": true}, "rate": {"title": "Standaard tarief", "description": "Dit tarief wordt ingezet bij de tariefschema's 'Tarief per verrichting' en 'Uurtarief per tijdschrijver, zekere verrichtingen apart'", "type": "string", "format": "decimal"}, "rate_factor": {"title": "Tarieffactor", "description": "Pas een tarieffactor toe op de tijd die is geschreven op deze verrichting.
N.B.: Bij het wijzigen van de tarieffactor kan het tot 24 uur duren voordat het OHW opnieuw wordt berekend met de nieuwe factor.", "type": "string", "format": "decimal"}, "separate_on_invoice": {"title": "Apart op declaratie", "description": "Vermeld tijdregels van de verrichting apart op declaraties", "type": "boolean"}, "min_logline_description_length": {"title": "Minimum aantal karakters", "description": "Dit veld bepaalt het minumum aantal karakters dat voor de omschrijving van een tijdregel verplicht is. Gebruik een waarde van 0 om de omschrijving niet verplicht te maken.", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}}}, "ActivityGroup": {"required": ["name", "activities"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "is_default": {"title": "Standaard", "description": "Groepen die als 'standaard' zijn gemarkeerd worden automatisch toegevoegd bij het aanmaken van een nieuw dossier.", "type": "boolean"}, "activities": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}}}, "Address": {"required": ["contact"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "address": {"title": "Adres", "type": "string", "maxLength": 255}, "address_kind": {"title": "Address kind", "type": "string", "format": "uri", "default": {"display_name": "Hoofdadres", "id": 7, "url": "http://localhost:8000/api/v3/addresskinds/7/?format=openapi"}}, "address_line_2": {"title": "Adresregel 2", "type": "string", "maxLength": 255}, "address_template": {"title": "Address template", "type": "integer", "default": 2}, "city": {"title": "Stad", "type": "string", "maxLength": 255}, "contact": {"title": "Contact", "type": "string", "format": "uri"}, "country": {"title": "Land", "type": "string", "maxLength": 255}, "department": {"title": "Afdeling", "type": "string", "maxLength": 255}, "full_address": {"title": "Volledig adres", "description": "Dit adres wordt gebruikt als adreslabel, voeg daarom ook de naam van de organisatie en/of contactpersoon toe.", "type": "string", "x-nullable": true}, "normalized_country": {"title": "Land", "type": "string", "enum": ["AF", "AX", "AL", "DZ", "AS", "VI", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CA", "KY", "CF", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "CU", "CW", "CY", "CD", "DK", "DJ", "DM", "DO", "DE", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FO", "FK", "FJ", "PH", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "IM", "HN", "HU", "HK", "IS", "IE", "IN", "ID", "IQ", "IR", "IL", "IT", "CI", "JM", "JP", "YE", "JE", "JO", "CV", "CM", "KZ", "KE", "KG", "KI", "UM", "KW", "XK", "HR", "LA", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MV", "MY", "ML", "MT", "MA", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "MM", "NA", "NR", "NL", "NP", "NI", "NC", "NZ", "NE", "NG", "NU", "KP", "MK", "MP", "NO", "NF", "UG", "UA", "UZ", "OM", "ZZ", "TL", "AT", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "KN", "LC", "VC", "BL", "PM", "SB", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SH", "SX", "MF", "SI", "SK", "SD", "SO", "ES", "SJ", "LK", "SR", "SY", "TJ", "TW", "TZ", "TH", "TG", "TK", "TO", "TT", "TD", "CZ", "TN", "TR", "TM", "TC", "TV", "UY", "VU", "VE", "GB", "AE", "US", "VN", "WF", "EH", "BY", "ZM", "ZW", "SS", "ZA", "GS", "KR", "SE", "CH"]}, "zipcode": {"title": "Postcode", "type": "string", "maxLength": 32}}}, "AddressKind": {"required": ["name", "type_TWF"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "is_default": {"title": "Is default", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "type_TWF": {"title": "Adrestype in Twinfield", "type": "string", "enum": ["postal", "invoice", "contact"]}}}, "AdvanceInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "advance_invoice_line": {"title": "Advance invoice line", "type": "string", "format": "uri", "readOnly": true}, "tax_percentage": {"title": "Tax percentage", "type": "string", "format": "uri", "readOnly": true}, "is_credited": {"title": "Is credited", "type": "boolean", "readOnly": true}}}, "LegalsenseLogin": {"required": ["username", "password"], "type": "object", "properties": {"username": {"title": "Username", "type": "string"}, "password": {"title": "Password", "type": "string"}, "token": {"title": "Token", "type": "string"}}}, "Branch": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}}}, "Budget": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Bedrag", "type": "string", "format": "decimal", "x-nullable": true}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}, "hours": {"title": "Uren", "type": "integer", "maximum": 2147483647, "minimum": 1, "x-nullable": true}, "kind": {"title": "Type budget", "type": "integer", "enum": [4, 1, 2, 3]}, "notify_billing_user": {"title": "Notificaties aan verantwoordelijke declaratieproces", "type": "boolean"}, "notify_supervising_user": {"title": "Notificaties aan verantwoordelijk advocaat", "type": "boolean"}, "notify_user": {"title": "Notificaties aan tijdschrijvende gebruiker", "type": "boolean"}, "object_type": {"title": "Object type", "type": "string", "readOnly": true, "minLength": 1}}}, "Chargeable": {"required": ["amount", "purchase_invoice", "tax_percentage"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "amount": {"title": "Bedrag ex. btw", "type": "string", "format": "decimal"}, "description": {"title": "Omschrijving", "type": "string"}, "expense_type": {"title": "Expense type", "type": "string", "format": "uri", "x-nullable": true}, "is_billed": {"title": "Is billed", "type": "string", "readOnly": true}, "include_expense_on_invoice": {"title": "Voeg PDF toe bij declaratie", "type": "boolean"}, "is_billable": {"title": "Declarabel", "type": "boolean"}, "kilometers": {"title": "Aantal kilometers", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "matter": {"title": "Matter", "type": "string", "format": "uri", "x-nullable": true}, "purchase_invoice": {"title": "Purchase invoice", "type": "string", "format": "uri"}, "tax_percentage": {"title": "Tax percentage", "type": "string", "format": "uri"}, "billed_on_invoice": {"title": "Billed on invoice", "type": "string", "format": "uri", "x-nullable": true}, "billed_on_invoice_draft": {"title": "Billed on invoice draft", "type": "string", "format": "uri", "x-nullable": true}, "billed_elsewhere": {"title": "Billed elsewhere", "type": "boolean", "readOnly": true}}}, "ClientBudget": {"required": ["client", "matters"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Bedrag", "type": "string", "format": "decimal", "x-nullable": true}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}, "hours": {"title": "Uren", "type": "integer", "maximum": 2147483647, "minimum": 1, "x-nullable": true}, "kind": {"title": "Type budget", "type": "integer", "enum": [4, 1, 2, 3]}, "notify_billing_user": {"title": "Notificaties aan verantwoordelijke declaratieproces", "type": "boolean"}, "notify_supervising_user": {"title": "Notificaties aan verantwoordelijk advocaat", "type": "boolean"}, "notify_user": {"title": "Notificaties aan tijdschrijvende gebruiker", "type": "boolean"}, "object_type": {"title": "Object type", "type": "string", "readOnly": true, "minLength": 1}, "amount_used": {"title": "Amount used", "type": "string", "format": "decimal", "readOnly": true}, "hours_used": {"title": "Hours used", "type": "string", "readOnly": true}, "add_future_matters": {"title": "Toekomstige dossiers toevoegen", "description": "Nieuwe dossiers voor deze cliënt worden automatisch aan het budget toegevoegd als u het veld ‘Toekomstige dossiers toevoegen’ aanvinkt.", "type": "boolean"}, "client": {"title": "Client", "type": "string", "format": "uri"}, "matters": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}}}, "ClientContributionInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "tax_percentage": {"title": "Tax percentage", "type": "string", "format": "uri", "readOnly": true}}}, "ClientCustomFieldDefinition": {"required": ["identifier", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "default": {"title": "Standaard", "description": "Deze waarde wordt gebruikt als standaard waarde voor nieuwe objecten. Voor velden die de widget \"Keuzelijst\" gebruiken, kies een waarde, niet de weergegeven tekst.", "type": "string", "maxLength": 255, "x-nullable": true}, "excel_export": {"title": "Voeg toe bij een Excel export", "type": "boolean"}, "excel_export_value": {"title": "Excel export waarde", "description": "Als dit veld naar Excel wordt geëxporteerd en het is een keuzeveld, kies dan wat er moet worden weergegeven in Excel: de waarde van het veld of de tekst uit het keuzeveld.", "type": "integer", "enum": [1, 2, 3]}, "extra_info": {"title": "Extra informatie", "description": "Als de 'Keuzelijst' widget is gekozen, geef dan hier de mogelijke keuzes op. Eén optie per regel, in de vorm van '2|Tweede optie'.", "type": "string", "x-nullable": true}, "help_text": {"title": "Helptekst", "description": "Wordt getoond onder het invoerveld.", "type": "string"}, "identifier": {"title": "Systeemnaam", "type": "string", "pattern": "^[0-9a-zA-Z_-]+$", "maxLength": 255, "minLength": 1}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "read_only": {"title": "Read-only veld", "type": "boolean"}, "required": {"title": "Verplicht veld", "type": "boolean"}, "widget": {"title": "Widget", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7]}}}, "DerivedCurrency": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "minLength": 1, "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "readOnly": true, "minLength": 1}}}, "ClientCustomField": {"required": ["identifier", "value"], "type": "object", "properties": {"identifier": {"title": "Identifier", "type": "string", "maxLength": 255, "minLength": 1}, "value": {"title": "Value", "type": "string", "maxLength": 255}}}, "DerivedOfficeExpensesRate": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "format": "decimal", "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "format": "decimal", "readOnly": true}}}, "Client": {"required": ["contact"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "archived_date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "softkill_status": {"title": "Softkill status", "type": "string"}, "tags": {"type": "array", "items": {"type": "string", "minLength": 1}}, "alternative_names": {"title": "Alternatieve namen", "description": "Deze namen worden gebruikt om te controleren op conflicterende belangen", "type": "string"}, "branches": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "billing_instructions": {"title": "Declaratie-instructies", "description": "De instructies worden bovenaan de declaratie getoond (op het scherm).", "type": "string", "x-nullable": true}, "client_status": {"title": "Client status", "type": "string", "format": "uri", "readOnly": true, "default": {"display_name": "Actief", "id": 1, "url": "http://localhost:8000/api/v3/clientstatuses/1/?format=openapi"}}, "contact": {"title": "Contact", "type": "string", "format": "uri"}, "currency": {"$ref": "#/definitions/DerivedCurrency"}, "custom_fields": {"type": "array", "items": {"$ref": "#/definitions/ClientCustomField"}}, "date": {"title": "Datum", "type": "string", "format": "date"}, "description": {"title": "Omschrijving", "type": "string"}, "engagement_letter_status": {"title": "Status opdrachtbevestiging", "type": "integer", "enum": [1, 2, 3, 5, 6], "x-nullable": true}, "is_billable": {"title": "Declarabel", "type": "boolean"}, "is_identified": {"title": "Gelegitimeerd", "type": "boolean"}, "name": {"title": "Name", "type": "string", "x-nullable": true}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "maxLength": 255, "x-nullable": true}, "office_expenses_rate": {"$ref": "#/definitions/DerivedOfficeExpensesRate"}, "originating_user": {"title": "Originating user", "type": "string", "format": "uri", "x-nullable": true}, "parent_client": {"title": "Parent client", "type": "string", "format": "uri", "x-nullable": true}, "price_list": {"title": "Price list", "type": "string", "format": "uri", "readOnly": true}, "reduction_rate": {"title": "Kortingspercentage", "description": "Het standaard kortingspercentage wordt automatisch toegepast op alle honorariumgebaseerde declaratieregels", "type": "string", "format": "decimal"}, "referrer": {"title": "Referrer", "type": "string", "format": "uri", "x-nullable": true}, "sector": {"title": "Sector", "type": "string", "format": "uri", "x-nullable": true}}}, "ClientStatus": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "is_default": {"title": "Is standaard", "description": "Deze status wordt als standaardwaarde gebruikt", "type": "boolean"}}}, "ContactContact": {"required": ["organization", "person"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "default_address": {"title": "Default address", "type": "string", "format": "uri", "x-nullable": true}, "is_primary_organization": {"title": "Is hoofdorganisatie", "type": "boolean"}, "job_description": {"title": "Functietitel", "description": "De functietitel van de contactpersoon bij deze organisatie.", "type": "string", "maxLength": 128}, "organization": {"title": "Organization", "type": "string", "format": "uri"}, "person": {"title": "Person", "type": "string", "format": "uri"}}}, "ContactCustomFieldDefinition": {"required": ["identifier", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "default": {"title": "Standaard", "description": "Deze waarde wordt gebruikt als standaard waarde voor nieuwe objecten. Voor velden die de widget \"Keuzelijst\" gebruiken, kies een waarde, niet de weergegeven tekst.", "type": "string", "maxLength": 255, "x-nullable": true}, "excel_export": {"title": "Voeg toe bij een Excel export", "type": "boolean"}, "excel_export_value": {"title": "Excel export waarde", "description": "Als dit veld naar Excel wordt geëxporteerd en het is een keuzeveld, kies dan wat er moet worden weergegeven in Excel: de waarde van het veld of de tekst uit het keuzeveld.", "type": "integer", "enum": [1, 2, 3]}, "extra_info": {"title": "Extra informatie", "description": "Als de 'Keuzelijst' widget is gekozen, geef dan hier de mogelijke keuzes op. Eén optie per regel, in de vorm van '2|Tweede optie'.", "type": "string", "x-nullable": true}, "help_text": {"title": "Helptekst", "description": "Wordt getoond onder het invoerveld.", "type": "string"}, "identifier": {"title": "Systeemnaam", "type": "string", "pattern": "^[0-9a-zA-Z_-]+$", "maxLength": 255, "minLength": 1}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "read_only": {"title": "Read-only veld", "type": "boolean"}, "required": {"title": "Verplicht veld", "type": "boolean"}, "widget": {"title": "Widget", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7]}}}, "ContactDetailKind": {"required": ["name", "validation_method"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "identifier": {"title": "Identifier", "type": "string", "readOnly": true, "minLength": 1}, "validation_method": {"title": "Validatiemethode", "type": "string", "enum": ["email", "url", "text"]}, "weight": {"title": "Weight", "type": "integer", "readOnly": true}, "icon": {"title": "Icoon", "type": "string", "enum": ["email", "mobile_phone", "phone", "fax", "website", "other"]}}}, "ContactDetail": {"required": ["kind", "value"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "contact": {"title": "Contact", "type": "string", "format": "uri", "readOnly": true}, "kind": {"title": "Kind", "type": "string", "minLength": 1}, "value": {"title": "Value", "type": "string", "maxLength": 255, "minLength": 1}}}, "ContactKind": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}}}, "ContactCustomField": {"required": ["identifier", "value"], "type": "object", "properties": {"identifier": {"title": "Identifier", "type": "string", "maxLength": 255, "minLength": 1}, "value": {"title": "Value", "type": "string", "maxLength": 255}}}, "ContactDetailModel": {"required": ["kind", "value"], "type": "object", "properties": {"is_billing_cc_email": {"title": "Is billing cc email", "type": "boolean", "default": false}, "is_billing_to_email": {"title": "Is billing to email", "type": "boolean", "default": false}, "is_dunning_to_email": {"title": "Is dunning to email", "type": "boolean", "default": false}, "is_dunning_cc_email": {"title": "Is dunning cc email", "type": "boolean", "default": false}, "kind": {"title": "Kind", "type": "string", "minLength": 1}, "value": {"title": "Value", "type": "string", "maxLength": 255, "minLength": 1}}, "x-nullable": true}, "ContactList": {"type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "archived_date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "softkill_status": {"title": "Softkill status", "type": "string"}, "tags": {"type": "array", "items": {"type": "string", "minLength": 1}}, "account_manager_user": {"title": "Account manager user", "type": "string", "format": "uri", "x-nullable": true}, "add_payment_link": {"title": "Betaallink toevoegen", "description": "Voeg standaard een betaallink toe aan declaraties en/of declaratie e-mails.", "type": "boolean", "x-nullable": true}, "address_label_name": {"title": "Naam op adreslabels", "type": "string", "maxLength": 255, "x-nullable": true}, "bank_account_bic": {"title": "BIC code", "type": "string", "maxLength": 11, "x-nullable": true}, "bank_account_iban": {"title": "Bankrekeningnummer", "type": "string", "maxLength": 34, "x-nullable": true}, "custom_fields": {"type": "array", "items": {"$ref": "#/definitions/ContactCustomField"}}, "default_billing_address": {"title": "Default billing address", "type": "string", "format": "uri", "x-nullable": true}, "default_contact_person": {"title": "Default contact person", "type": "string", "format": "uri", "x-nullable": true}, "details": {"type": "array", "items": {"$ref": "#/definitions/ContactDetailModel"}, "x-nullable": true}, "firm": {"title": "Firm", "type": "string", "format": "uri", "x-nullable": true}, "email": {"title": "Email", "type": "string", "readOnly": true}, "first_name": {"title": "Voornaam", "type": "string", "maxLength": 255}, "gender": {"title": "Geslacht", "type": "integer", "enum": [1, 2, 3], "x-nullable": true}, "has_dunning": {"title": "Debiteurenbeheer", "description": "Deze debiteur wordt meegenomen bij het aanmaken van herinneringen/aanmaningen in Legalsense. Indien u geen herinneringen aan deze debiteur wilt sturen, zet u deze waarde uit.", "type": "boolean"}, "invoice_attachment_type": {"title": "Declaratie bijlage", "description": "De format(s) van de declaratie die worden bijgevoegd aan de declaratie e-mail.", "type": "integer", "enum": [0, 1, 2], "x-nullable": true}, "invoice_language": {"title": "Taal", "description": "De standaardtaal voor declaraties", "type": "string", "maxLength": 7, "minLength": 1}, "invoice_send_method": {"title": "Verzendwijze declaratie", "type": "integer", "enum": [1, 2, 3, 4], "x-nullable": true}, "is_debtor": {"title": "Debiteur?", "description": "Geef aan of dit contact als debiteur gebruikt wordt. Een cliënt moet altijd een debiteur zijn.", "type": "boolean"}, "is_organization": {"title": "Is organisatie", "type": "boolean"}, "last_name": {"title": "Achternaam", "type": "string", "maxLength": 255}, "name_prefix": {"title": "Tussenvoegsel", "type": "string", "maxLength": 32}, "notes": {"title": "Opmerkingen", "type": "string"}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "maxLength": 255, "x-nullable": true}, "organization_kind": {"title": "Rechtsvorm type", "type": "integer", "enum": [1, 2, 3, 4], "x-nullable": true}, "organization_kind_subtype": {"title": "Organization kind subtype", "type": "string", "format": "uri", "x-nullable": true}, "organization_name": {"title": "Naam van de organisatie", "type": "string", "maxLength": 255}, "organization_number": {"title": "KvK-Nummer", "type": "string", "maxLength": 100, "x-nullable": true}, "payment_deadline": {"title": "Standaard betalingstermijn", "description": "Aantal dagen", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "peppol_id": {"title": "Peppol endpoint-ID", "description": "De endpointidentificatie verwijst naar de Peppol-identificatie van dit contact wanneer het contact een ontvanger van een factuur is. Ga naar de Peppol Directory om Peppol IDs op te zoeken", "type": "string", "maxLength": 255, "x-nullable": true}, "peppol_company_id": {"title": "Peppol bedrijfs-ID", "description": "Optioneel: Gebruik dit veld als u een Company-ID wilt gebruiken die anders is dan het Endpoint-ID (Peppol-ID). Als dit niet is ingevuld, wordt de Endpoint-ID gebruikt als Company-ID.", "type": "string", "maxLength": 255}, "primary_organization": {"title": "Primary organization", "type": "string", "readOnly": true}, "tax_scheme": {"title": "Toepasbare btw", "type": "integer", "enum": [1, 2, 3, 4, 5], "x-nullable": true}, "vat_number": {"title": "Btw-nummer", "type": "string", "pattern": "^ATU[0-9]{8}$|^BE[01]?[0-9]{9}$|^BG[0-9]{9,10}$|^CY[0-9]{8}[A-Z]$|^CZ[0-9]{8,10}$|^DE[0-9]{9}$|^DK[0-9]{8}$|^EE[0-9]{9}$|^EL[0-9]{9}$|^GR[0-9]{9}$|^ES[0-9A-Z][0-9]{7}[0-9A-Z]$|^FI[0-9]{8}$|^FR[0-9A-Z]{2}[0-9]{9}$|^HU[0-9]{8}$|^HR[0-9]{11}$|^IE[0-9]{7}[A-Z]$|^IE[0-9][A-Z][0-9]{5}[A-Z]$|^IE[0-9]{7}[A-Z]{2}$|^IT[0-9]{11}$|^LT([0-9]{9}|[0-9]{12})$|^LU[0-9]{8}$|^LV[0-9]{11}$|^MT[0-9]{8}$|^NL[0-9]{9}B[0-9]{2}$|^PL[0-9]{10}$|^PT[0-9]{9}$|^RO[0-9]{2,10}$|^SE[0-9]{12}$|^SI[0-9]{8}$|^SK[0-9]{10}$", "maxLength": 100, "x-nullable": true}}}, "DerivedAddressLabelName": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "minLength": 1, "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "readOnly": true, "minLength": 1}}}, "DerivedAddPaymentLink": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "boolean", "x-nullable": true}, "representation": {"title": "Representation", "type": "boolean", "readOnly": true}}}, "DerivedInvoiceAttachmentType": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "integer", "enum": [0, 1, 2], "x-nullable": true}, "representation": {"title": "Representation", "type": "integer", "enum": [0, 1, 2], "readOnly": true}}}, "DerivedPaymentDeadline": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "integer", "x-nullable": true}, "representation": {"title": "Representation", "type": "integer", "readOnly": true}}}, "ContactDebtorPerson": {"required": ["is_debtor", "is_organization"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "archived_date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "softkill_status": {"title": "Softkill status", "type": "string"}, "tags": {"type": "array", "items": {"type": "string", "minLength": 1}}, "is_debtor": {"title": "Is debtor", "type": "boolean"}, "is_organization": {"title": "Is organization", "type": "boolean"}, "account_manager_user": {"title": "Account manager user", "type": "string", "format": "uri", "x-nullable": true}, "address_label_name": {"$ref": "#/definitions/DerivedAddressLabelName"}, "custom_fields": {"type": "array", "items": {"$ref": "#/definitions/ContactCustomField"}}, "default_billing_address": {"title": "Default billing address", "type": "string", "format": "uri", "x-nullable": true}, "details": {"type": "array", "items": {"$ref": "#/definitions/ContactDetailModel"}, "x-nullable": true}, "email": {"title": "Email", "type": "string", "readOnly": true}, "firm": {"title": "Firm", "type": "string", "format": "uri", "readOnly": true}, "notes": {"title": "Opmerkingen", "type": "string"}, "add_payment_link": {"$ref": "#/definitions/DerivedAddPaymentLink"}, "bank_account_bic": {"title": "BIC code", "type": "string", "maxLength": 11, "x-nullable": true}, "bank_account_iban": {"title": "Bankrekeningnummer", "type": "string", "maxLength": 34, "x-nullable": true}, "has_dunning": {"title": "Debiteurenbeheer", "description": "Deze debiteur wordt meegenomen bij het aanmaken van herinneringen/aanmaningen in Legalsense. Indien u geen herinneringen aan deze debiteur wilt sturen, zet u deze waarde uit.", "type": "boolean"}, "invoice_attachment_type": {"$ref": "#/definitions/DerivedInvoiceAttachmentType"}, "invoice_language": {"title": "Taal", "description": "De standaardtaal voor declaraties", "type": "string", "maxLength": 7, "minLength": 1}, "invoice_send_method": {"title": "Verzendwijze declaratie", "type": "integer", "enum": [1, 2, 3, 4], "x-nullable": true}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "maxLength": 255, "x-nullable": true}, "payment_deadline": {"$ref": "#/definitions/DerivedPaymentDeadline"}, "tax_scheme": {"title": "Toepasbare btw", "type": "integer", "enum": [1, 2, 3], "x-nullable": true}, "vat_number": {"title": "Vat number", "type": "string", "maxLength": 100}, "attention": {"title": "Ter attentie tekst", "description": "bijv. Attn. P/a.\nLaat dit veld leeg om de standaardwaarde van het adrestemplate over te nemen.", "type": "string", "maxLength": 32}, "birthdate": {"title": "Geboortedatum", "type": "string", "format": "date", "x-nullable": true}, "first_name": {"title": "Voornaam", "type": "string", "maxLength": 255}, "gender": {"title": "Geslacht", "type": "integer", "enum": [1, 2, 3], "x-nullable": true}, "identification_number": {"title": "Burger Service Nummer (BSN)", "type": "string", "maxLength": 32}, "initials": {"title": "Initialen", "type": "string", "maxLength": 255}, "last_name": {"title": "Achternaam", "type": "string", "maxLength": 255}, "mailing_option": {"title": "Verzendoptie", "description": "bijv. Strikt persoonlijk en vertrouwelijk", "type": "string", "maxLength": 255}, "name_prefix": {"title": "Tussenvoegsel", "type": "string", "maxLength": 32}, "salutation": {"title": "Aanhef", "description": "e.g. Geachte …", "type": "string", "maxLength": 255}, "suffix_title": {"title": "Postnominale titel", "description": "e.g. MSc of PhD (wordt achter de naam getoond)", "type": "string", "maxLength": 32}, "title": {"title": "Titel", "description": "e.g. De heer, Mevrouw, mr", "type": "string", "maxLength": 32}, "primary_organization": {"title": "Primary organization", "type": "string", "readOnly": true}}}, "CreditInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "credited_section": {"title": "Credited section", "type": "string", "format": "uri", "readOnly": true}}}, "Creditor": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "bank_account_bic": {"title": "BIC code", "type": "string", "maxLength": 11, "x-nullable": true}, "bank_account_iban": {"title": "Bankrekeningnummer", "type": "string", "maxLength": 34, "x-nullable": true}}}, "CustomInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate", "office_expenses_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "page_1_kind": {"title": "Page 1 kind", "type": "integer", "enum": [1, 2, 4]}, "office_expenses_rate": {"title": "Office expenses rate", "type": "string", "format": "decimal"}, "tax_percentage": {"title": "Tax percentage", "type": "string", "format": "uri", "readOnly": true}, "custom_ledger_account": {"title": "Grootboekrekening", "description": "Te gebruiken grootboekrekening bij export van de omzet voor deze declaratieregel", "type": "string", "maxLength": 36}, "type": {"title": "Type", "type": "string", "format": "uri", "readOnly": true}}}, "CustomInvoicelineType": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string"}, "custom_ledger_account": {"title": "Grootboekrekening", "description": "Te gebruiken grootboekrekening bij export van de omzet voor deze declaratieregel", "type": "string", "maxLength": 36}}}, "Document": {"required": ["content_object", "document_type"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "comment": {"title": "Opmerkingen", "type": "string"}, "content_object": {"title": "Content object", "type": "string"}, "document_type": {"title": "Document type", "type": "string", "format": "uri"}, "modified_by": {"title": "Modified by", "type": "string", "format": "uri", "readOnly": true}}}, "DocumentType": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "kind": {"title": "Type", "type": "integer", "readOnly": true}}}, "DraftLogline": {"required": ["reviewer"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "activity": {"title": "Activity", "type": "string", "format": "uri", "x-nullable": true}, "approved_at": {"title": "Approved at", "type": "string", "format": "date-time", "readOnly": true}, "comment": {"title": "Notities", "type": "string", "maxLength": 1024}, "created_by": {"title": "Created by", "type": "string", "format": "uri", "readOnly": true}, "date": {"title": "Date", "type": "string", "format": "date", "x-nullable": true}, "description": {"title": "Omschrijving", "type": "string", "maxLength": 1024}, "is_approved": {"title": "Is approved", "type": "boolean", "readOnly": true}, "logline": {"title": "Logline", "type": "string", "format": "uri", "readOnly": true}, "matter": {"title": "Matter", "type": "string", "format": "uri", "x-nullable": true}, "minutes": {"title": "Minutes", "type": "integer", "maximum": 4294967295, "minimum": 0}, "recofa_category": {"title": "Recofa category", "type": "string", "format": "uri", "x-nullable": true}, "reviewer": {"title": "Reviewer", "type": "string", "format": "uri"}, "source": {"title": "Source", "type": "integer", "enum": [1, 2, 3]}, "submatter": {"title": "Submatter", "type": "string", "format": "uri", "x-nullable": true}, "timekeeper": {"title": "Timekeeper", "type": "string", "format": "uri", "x-nullable": true}}}, "ExpenseInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "chargeable_ids": {"title": "Chargeable ids", "type": "string", "readOnly": true}}}, "Expense": {"required": ["amount"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "amount": {"title": "Bedrag", "type": "string", "format": "decimal"}, "creditor": {"title": "Creditor", "type": "string", "format": "uri", "x-nullable": true}, "currency": {"title": "Valuta", "type": "string", "readOnly": true, "maxLength": 3, "minLength": 1}, "date": {"title": "Datum", "type": "string", "format": "date"}, "description": {"title": "Omschrijving", "type": "string"}, "firm": {"title": "Firm", "type": "string", "format": "uri", "readOnly": true}, "invoice_number": {"title": "Invoice number", "type": "string", "maxLength": 255, "x-nullable": true}, "is_purchase": {"title": "Inkoopfactuur", "description": "Boek dit verschot als een inkoopfactuur, met crediteur, factuurnummer etc.", "type": "boolean"}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "readOnly": true, "maxLength": 255, "x-nullable": true}}}, "ExpenseType": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string"}, "ledes_code": {"title": "LEDES code", "type": "string", "maxLength": 255, "x-nullable": true}, "one_on_one_vat": {"title": "Doorlopende post", "description": "Doorlopende posten zijn kosten die u op naam en voor rekening van uw opdrachtgever betaalt aan een andere partij. Als de kosten niet als doorlopende post zijn aan te merken, vormen zij onderdeel van de btw-belaste vergoeding van de advocaat. Let op, deze optie kan niet meer veranderd worden.", "type": "boolean"}}}, "Firm": {"required": ["address", "name", "tax_country"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "address": {"title": "Adres", "description": "Vermeld uw kantoornaam op de eerste regel. Het adres wordt één op één overgenomen in declaraties en faillissementsrapporten.", "type": "string", "maxLength": 2000, "minLength": 1}, "address_line_1": {"title": "Adresregel 1", "type": "string", "maxLength": 255}, "address_line_2": {"title": "Adresregel 2", "type": "string", "maxLength": 255}, "bank_account": {"title": "Bankrekeningnummer", "type": "string", "maxLength": 34, "x-nullable": true}, "city": {"title": "Stad", "type": "string", "maxLength": 255}, "country": {"title": "Land", "type": "string", "maxLength": 255}, "email": {"title": "E-mailadres", "type": "string", "format": "email", "maxLength": 254, "x-nullable": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "organization_number": {"title": "KvK-Nummer", "type": "string", "maxLength": 100, "x-nullable": true}, "phone": {"title": "Telefoon", "type": "string", "maxLength": 254}, "tax_country": {"title": "Tax country", "type": "string", "format": "uri"}, "vat_number": {"title": "Btw-nummer", "type": "string", "pattern": "^ATU[0-9]{8}$|^BE[01]?[0-9]{9}$|^BG[0-9]{9,10}$|^CY[0-9]{8}[A-Z]$|^CZ[0-9]{8,10}$|^DE[0-9]{9}$|^DK[0-9]{8}$|^EE[0-9]{9}$|^EL[0-9]{9}$|^GR[0-9]{9}$|^ES[0-9A-Z][0-9]{7}[0-9A-Z]$|^FI[0-9]{8}$|^FR[0-9A-Z]{2}[0-9]{9}$|^HU[0-9]{8}$|^HR[0-9]{11}$|^IE[0-9]{7}[A-Z]$|^IE[0-9][A-Z][0-9]{5}[A-Z]$|^IE[0-9]{7}[A-Z]{2}$|^IT[0-9]{11}$|^LT([0-9]{9}|[0-9]{12})$|^LU[0-9]{8}$|^LV[0-9]{11}$|^MT[0-9]{8}$|^NL[0-9]{9}B[0-9]{2}$|^PL[0-9]{10}$|^PT[0-9]{9}$|^RO[0-9]{2,10}$|^SE[0-9]{12}$|^SI[0-9]{8}$|^SK[0-9]{10}$", "maxLength": 100, "x-nullable": true}, "zipcode": {"title": "Postcode", "type": "string", "maxLength": 32}}}, "FunctionCostRate": {"type": "object", "properties": {"rate": {"title": "Kostprijs", "type": "string", "format": "decimal"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "FunctionRate": {"required": ["rate"], "type": "object", "properties": {"rate": {"title": "Tarief", "type": "string", "format": "decimal"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "FunctionVariableCostRate": {"type": "object", "properties": {"rate": {"title": "Variabele kostprijs", "type": "string", "format": "decimal"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "Function": {"required": ["external_name", "name", "rates"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "cost_rates": {"type": "array", "items": {"$ref": "#/definitions/FunctionCostRate"}}, "external_name": {"title": "External name", "type": "string"}, "ledes_classification": {"title": "LEDES classificatie", "type": "string", "readOnly": true, "maxLength": 255, "x-nullable": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "rates": {"type": "array", "items": {"$ref": "#/definitions/FunctionRate"}}, "variable_cost_rates": {"type": "array", "items": {"$ref": "#/definitions/FunctionVariableCostRate"}}, "weight": {"title": "Gewicht", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}}}, "Group": {"required": ["members"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "members": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "name": {"title": "Naam", "type": "string", "readOnly": true, "minLength": 1}}}, "InvoiceCustomFieldDefinition": {"required": ["identifier", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "default": {"title": "Standaard", "description": "Deze waarde wordt gebruikt als standaard waarde voor nieuwe objecten. Voor velden die de widget \"Keuzelijst\" gebruiken, kies een waarde, niet de weergegeven tekst.", "type": "string", "maxLength": 255, "x-nullable": true}, "excel_export": {"title": "Voeg toe bij een Excel export", "type": "boolean"}, "excel_export_value": {"title": "Excel export waarde", "description": "Als dit veld naar Excel wordt geëxporteerd en het is een keuzeveld, kies dan wat er moet worden weergegeven in Excel: de waarde van het veld of de tekst uit het keuzeveld.", "type": "integer", "enum": [1, 2, 3]}, "extra_info": {"title": "Extra informatie", "description": "Als de 'Keuzelijst' widget is gekozen, geef dan hier de mogelijke keuzes op. Eén optie per regel, in de vorm van '2|Tweede optie'.", "type": "string", "x-nullable": true}, "help_text": {"title": "Helptekst", "description": "Wordt getoond onder het invoerveld.", "type": "string"}, "identifier": {"title": "Systeemnaam", "type": "string", "pattern": "^[0-9a-zA-Z_-]+$", "maxLength": 255, "minLength": 1}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "read_only": {"title": "Read-only veld", "type": "boolean"}, "required": {"title": "Verplicht veld", "type": "boolean"}, "widget": {"title": "Widget", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7]}, "required_for_finalization": {"title": "Vereist voor finaliseren", "type": "boolean"}}}, "Invoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}}}, "Invoice": {"required": ["amount", "amount_ex_tax", "amount_in_default_currency", "invoicesection_set", "kind", "language", "rounding_precision"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "accounting_date": {"title": "Boekingsdatum declaratie", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "format": "date", "x-nullable": true}, "add_payment_link": {"title": "Betaallink toevoegen", "description": "Voeg een betaallink toe aan de declaratie en/of declaratie e-mail. Vergeet niet de betaallink tag toe te voegen.", "type": "boolean", "x-nullable": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "amount_ex_tax": {"title": "Amount ex tax", "type": "string", "format": "decimal"}, "amount_in_default_currency": {"title": "Amount in default currency", "type": "string", "format": "decimal"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "billed_elsewhere": {"title": "Billed elsewhere", "type": "boolean", "readOnly": true}, "billed_on_invoice": {"title": "Billed on invoice", "type": "string", "readOnly": true}, "billed_on_invoice_draft": {"title": "Billed on invoice draft", "type": "string", "readOnly": true}, "cc_emails": {"title": "Cc emails", "type": "string"}, "child_invoice_ids": {"title": "Child invoice ids", "type": "string", "readOnly": true}, "client": {"title": "Client", "type": "string", "format": "uri", "readOnly": true}, "comments": {"title": "Opmerkingen", "type": "string"}, "contact_person": {"title": "Contact person", "type": "string", "format": "uri", "readOnly": true}, "created_by": {"title": "Created by", "type": "string", "format": "uri", "readOnly": true}, "created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "credited_invoice_id": {"title": "Credited invoice id", "type": "string", "readOnly": true}, "credit_comments": {"title": "Creditopmerkingen", "description": "Reden voor het maken van een creditdeclaratie.", "type": "string", "x-nullable": true}, "currency": {"title": "Currency", "type": "string", "readOnly": true, "minLength": 1}, "date": {"title": "Datum", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "format": "date", "x-nullable": true}, "debtor": {"title": "Debtor", "type": "string", "format": "uri", "readOnly": true}, "debtor_address": {"title": "Debtor address", "type": "string", "format": "uri", "readOnly": true}, "do_not_sync": {"title": "Niet met de externe boekhoudapplicatie koppelen", "type": "boolean"}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}, "exchange_rate": {"title": "Exchange rate", "type": "string", "format": "decimal", "x-nullable": true}, "finalized_at": {"title": "Finalized at", "type": "string", "format": "date-time", "x-nullable": true}, "finalized_by": {"title": "Finalized by", "type": "string", "format": "uri", "readOnly": true}, "firm": {"title": "Firm", "type": "string", "format": "uri", "readOnly": true}, "is_creditable": {"title": "Is creditable", "type": "boolean", "readOnly": true}, "is_credit_invoice": {"title": "Is credit invoice", "type": "boolean", "readOnly": true}, "invoicesection_set": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "kind": {"title": "Declaratie template", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "language": {"title": "Taal", "type": "string", "maxLength": 7, "minLength": 1}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "maxLength": 255, "x-nullable": true}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal", "readOnly": true}, "parent_invoice_id": {"title": "Parent invoice id", "type": "string", "readOnly": true}, "payment_deadline": {"title": "Betalingstermijn", "description": "Aantal dagen", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "payment_status": {"title": "Betalingsstatus", "type": "integer", "enum": [11, 12, 13, 14]}, "receiver_address": {"title": "Adres", "type": "string", "maxLength": 1024, "x-nullable": true}, "rounding_precision": {"title": "Rounding precision", "type": "string", "format": "decimal"}, "rvr_kind": {"title": "Rvr kind", "type": "integer", "readOnly": true, "x-nullable": true}, "sender_address": {"title": "Afzender", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "send_method": {"title": "Verzendwijze declaratie", "type": "integer", "enum": [1, 2, 3, 4], "x-nullable": true}, "status": {"title": "Status", "type": "integer", "readOnly": true}, "tax_scheme": {"title": "Toepasbare btw", "type": "integer", "enum": [1, 2, 3, 4, 5], "x-nullable": true}, "to_emails": {"title": "To emails", "type": "string"}, "vat_correction_amount": {"title": "Vat correction amount", "type": "string", "format": "decimal"}, "vat_number": {"title": "Btw-nummer", "type": "string", "pattern": "^ATU[0-9]{8}$|^BE[01]?[0-9]{9}$|^BG[0-9]{9,10}$|^CY[0-9]{8}[A-Z]$|^CZ[0-9]{8,10}$|^DE[0-9]{9}$|^DK[0-9]{8}$|^EE[0-9]{9}$|^EL[0-9]{9}$|^GR[0-9]{9}$|^ES[0-9A-Z][0-9]{7}[0-9A-Z]$|^FI[0-9]{8}$|^FR[0-9A-Z]{2}[0-9]{9}$|^HU[0-9]{8}$|^HR[0-9]{11}$|^IE[0-9]{7}[A-Z]$|^IE[0-9][A-Z][0-9]{5}[A-Z]$|^IE[0-9]{7}[A-Z]{2}$|^IT[0-9]{11}$|^LT([0-9]{9}|[0-9]{12})$|^LU[0-9]{8}$|^LV[0-9]{11}$|^MT[0-9]{8}$|^NL[0-9]{9}B[0-9]{2}$|^PL[0-9]{10}$|^PT[0-9]{9}$|^RO[0-9]{2,10}$|^SE[0-9]{12}$|^SI[0-9]{8}$|^SK[0-9]{10}$", "maxLength": 100, "x-nullable": true}}}, "InvoiceSection": {"required": ["activity_amount", "advance_amount", "client_contribution_amount", "custom_activity_amount", "expense_amount", "invoiceline_set", "miscellaneous_amount", "office_expenses_amount", "paid_amount", "product_amount", "tax_amount", "total_amount", "trustaccounting_amount"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "activity_amount": {"title": "Activity amount", "type": "string", "format": "decimal"}, "advance_amount": {"title": "Advance amount", "type": "string", "format": "decimal"}, "billing_reference": {"title": "PO nummer", "type": "string", "readOnly": true, "minLength": 1}, "client_contribution_amount": {"title": "Client contribution amount", "type": "string", "format": "decimal"}, "custom_activity_amount": {"title": "Custom activity amount", "type": "string", "format": "decimal"}, "custom_expense_amount": {"title": "Custom expense amount", "type": "string", "format": "decimal", "readOnly": true, "x-nullable": true}, "expense_amount": {"title": "Expense amount", "type": "string", "format": "decimal"}, "invoice": {"title": "Invoice", "type": "string", "format": "uri", "readOnly": true}, "invoiceline_set": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "matter": {"title": "Matter", "type": "string", "format": "uri", "readOnly": true}, "miscellaneous_amount": {"title": "Miscellaneous amount", "type": "string", "format": "decimal"}, "netdocuments_identifier": {"title": "Netdocuments identifier", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "office_expenses_amount": {"title": "Office expenses amount", "type": "string", "format": "decimal"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "pricing_scheme": {"title": "Pricing scheme", "type": "integer", "enum": [1, 2, 8, 3, 7, 4, 5, 9, 10, 11, 12, 13], "x-nullable": true}, "product_amount": {"title": "Product amount", "type": "string", "format": "decimal"}, "tax_amount": {"title": "Tax amount", "type": "string", "format": "decimal"}, "total_amount": {"title": "Total amount", "type": "string", "format": "decimal"}, "trustaccounting_amount": {"title": "Trustaccounting amount", "type": "string", "format": "decimal"}}}, "LeverageTeam": {"required": ["name", "team_leader"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "team_leader": {"title": "Team leader", "type": "string", "format": "uri"}}}, "LoglineInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate", "office_expenses_rate", "original_price_value"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "rate": {"title": "Rate", "type": "string", "format": "decimal", "readOnly": true}, "billable_minutes": {"title": "Billable minutes", "type": "integer", "readOnly": true}, "minutes": {"title": "Minutes", "type": "integer", "readOnly": true}, "office_expenses_rate": {"title": "Office expenses rate", "type": "string", "format": "decimal"}, "original_price_value": {"title": "Original price value", "type": "string", "format": "decimal"}, "points": {"title": "Points", "type": "string", "format": "decimal", "readOnly": true}, "price": {"title": "Price", "type": "string", "format": "uri", "readOnly": true}, "invoice_price_key": {"title": "Invoice price key", "type": "string", "format": "uri", "readOnly": true}, "tax_percentage": {"title": "Tax percentage", "type": "string", "format": "uri", "readOnly": true}}}, "DerivedIsBillable": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "boolean", "x-nullable": true}, "representation": {"title": "Representation", "type": "boolean", "readOnly": true}}}, "Logline": {"required": ["activity", "date", "matter", "submatter", "user"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "activity": {"title": "Activity", "type": "string", "format": "uri"}, "amount": {"title": "Amount", "type": "string", "format": "decimal", "readOnly": true}, "billable_minutes": {"title": "Billable minutes", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "billable_status": {"title": "Billable status", "type": "string", "readOnly": true}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal", "readOnly": true}, "billed_elsewhere": {"title": "Billed elsewhere", "type": "boolean", "readOnly": true}, "billed_office_expenses_amount": {"title": "Billed office expenses amount", "type": "string", "format": "decimal", "readOnly": true}, "billed_on_invoice": {"title": "Billed on invoice", "type": "string", "format": "uri", "readOnly": true}, "billed_on_invoice_draft": {"title": "Billed on invoice draft", "type": "string", "format": "uri", "readOnly": true}, "comment": {"title": "Notities", "type": "string", "maxLength": 1024}, "cost_rate_amount": {"title": "Cost rate amount", "type": "string", "format": "decimal", "readOnly": true}, "created_by": {"title": "Created by", "type": "string", "format": "uri", "readOnly": true}, "created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "date": {"title": "Date", "type": "string", "format": "date"}, "description": {"title": "Omschrijving", "type": "string", "maxLength": 1024}, "draft_amount": {"title": "Draft amount", "type": "string", "format": "decimal", "readOnly": true}, "expected_amount": {"title": "Expected amount", "type": "string", "format": "decimal", "readOnly": true}, "expected_below_cap_amount": {"title": "Expected below cap amount", "type": "string", "format": "decimal", "readOnly": true}, "expected_client_rate_amount": {"title": "Expected client rate amount", "type": "string", "format": "decimal", "readOnly": true}, "expected_hourly_rate_amount": {"title": "Expected hourly rate amount", "type": "string", "format": "decimal", "readOnly": true}, "expected_ignoring_writeoffs_amount": {"title": "Expected ignoring writeoffs amount", "type": "string", "format": "decimal", "readOnly": true}, "expected_office_expenses_amount": {"title": "Expected office expenses amount", "type": "string", "format": "decimal", "readOnly": true}, "expected_office_expenses_ignoring_writeoffs_amount": {"title": "Expected office expenses ignoring writeoffs amount", "type": "string", "format": "decimal", "readOnly": true}, "expected_reduced_ignoring_writeoffs_amount": {"title": "Expected reduced ignoring writeoffs amount", "type": "string", "format": "decimal", "readOnly": true}, "expense": {"title": "Expense", "type": "string", "format": "uri"}, "is_billable": {"$ref": "#/definitions/DerivedIsBillable"}, "is_billed_anywhere": {"title": "Is billed anywhere", "type": "boolean", "readOnly": true}, "is_billed": {"title": "Is billed", "type": "boolean", "readOnly": true}, "is_zero_rate": {"title": "Is zero rate", "type": "boolean", "readOnly": true, "default": false}, "matter": {"title": "Matter", "type": "string", "format": "uri"}, "type": {"title": "Type", "type": "string", "default": "non_billable"}, "minutes": {"title": "Minutes", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "modified_date": {"title": "Modified date", "type": "string", "format": "date-time", "readOnly": true}, "original_amount": {"title": "Original amount", "type": "string", "format": "decimal", "readOnly": true, "x-nullable": true}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal", "readOnly": true}, "recofa_category": {"title": "Recofa category", "type": "string", "format": "uri"}, "submatter": {"title": "Submatter", "type": "string", "format": "uri", "x-nullable": true}, "tax_amount": {"title": "Tax amount", "type": "string", "format": "decimal", "readOnly": true}, "user": {"title": "User", "type": "string", "format": "uri"}, "variable_cost_rate_amount": {"title": "Variable cost rate amount", "type": "string", "format": "decimal", "readOnly": true}, "writeoff_line": {"title": "Writeoff line", "type": "string", "format": "uri", "readOnly": true}, "written_off_minutes": {"title": "Written off minutes", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}}}, "MatterArchiveInformation": {"required": ["matter"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "check_out_date": {"title": "Datum van de checkout", "type": "string", "format": "date", "x-nullable": true}, "checked_out_by": {"title": "Checked out by", "type": "string", "format": "uri", "x-nullable": true}, "check_out_comments": {"title": "Opmerkingen bij de checkout", "type": "string"}, "matter": {"title": "Matter", "type": "string", "format": "uri"}, "notes": {"title": "Archiefnotities", "type": "string", "x-nullable": true}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "maxLength": 255, "x-nullable": true}, "retention_end_date": {"title": "Retention end date", "type": "string", "readOnly": true}, "retention_period": {"title": "Bewaartermijn", "type": "integer", "readOnly": true, "maximum": 4294967295, "minimum": 0, "x-nullable": true}}}, "MatterBudget": {"required": ["matter"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Bedrag", "type": "string", "format": "decimal", "x-nullable": true}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}, "hours": {"title": "Uren", "type": "integer", "maximum": 2147483647, "minimum": 1, "x-nullable": true}, "kind": {"title": "Type budget", "type": "integer", "enum": [4, 1, 2, 3]}, "notify_billing_user": {"title": "Notificaties aan verantwoordelijke declaratieproces", "type": "boolean"}, "notify_supervising_user": {"title": "Notificaties aan verantwoordelijk advocaat", "type": "boolean"}, "notify_user": {"title": "Notificaties aan tijdschrijvende gebruiker", "type": "boolean"}, "object_type": {"title": "Object type", "type": "string", "readOnly": true, "minLength": 1}, "amount_used": {"title": "Amount used", "type": "string", "format": "decimal", "readOnly": true}, "hours_used": {"title": "Hours used", "type": "string", "readOnly": true}, "matter": {"title": "Matter", "type": "string", "format": "uri"}, "client": {"title": "Client", "type": "string", "format": "uri", "readOnly": true}}}, "MatterContact": {"required": ["contact", "kind", "matter"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "address": {"title": "Address", "type": "string", "format": "uri", "x-nullable": true}, "contact": {"title": "Contact", "type": "string", "format": "uri"}, "contact_person": {"title": "Contact person", "type": "string", "format": "uri", "x-nullable": true}, "kind": {"title": "Kind", "type": "string", "format": "uri"}, "matter": {"title": "Matter", "type": "string", "format": "uri"}, "their_reference": {"title": "Hun referentie", "type": "string", "maxLength": 255}}}, "MatterCustomFieldDefinition": {"required": ["identifier", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "default": {"title": "Standaard", "description": "Deze waarde wordt gebruikt als standaard waarde voor nieuwe objecten. Voor velden die de widget \"Keuzelijst\" gebruiken, kies een waarde, niet de weergegeven tekst.", "type": "string", "maxLength": 255, "x-nullable": true}, "excel_export": {"title": "Voeg toe bij een Excel export", "type": "boolean"}, "excel_export_value": {"title": "Excel export waarde", "description": "Als dit veld naar Excel wordt geëxporteerd en het is een keuzeveld, kies dan wat er moet worden weergegeven in Excel: de waarde van het veld of de tekst uit het keuzeveld.", "type": "integer", "enum": [1, 2, 3]}, "extra_info": {"title": "Extra informatie", "description": "Als de 'Keuzelijst' widget is gekozen, geef dan hier de mogelijke keuzes op. Eén optie per regel, in de vorm van '2|Tweede optie'.", "type": "string", "x-nullable": true}, "help_text": {"title": "Helptekst", "description": "Wordt getoond onder het invoerveld.", "type": "string"}, "identifier": {"title": "Systeemnaam", "type": "string", "pattern": "^[0-9a-zA-Z_-]+$", "maxLength": 255, "minLength": 1}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "read_only": {"title": "Read-only veld", "type": "boolean"}, "required": {"title": "Verplicht veld", "type": "boolean"}, "widget": {"title": "Widget", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7]}}}, "MatterDebtor": {"required": ["address", "debtor", "matter"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "address": {"title": "Address", "type": "string", "format": "uri"}, "amount": {"title": "Bedrag", "type": "string", "format": "decimal", "x-nullable": true}, "billing_reference": {"title": "PO nummer", "description": "Referentie voor declaraties voor dit dossier (inkoopordernummer e.d.)", "type": "string", "maxLength": 255}, "cc_email": {"title": "Cc email", "type": "string", "format": "uri", "x-nullable": true}, "cc_emails_custom": {"type": "array", "items": {"type": "string", "format": "email", "minLength": 1}}, "contact_person": {"title": "Contact person", "type": "string", "format": "uri", "x-nullable": true}, "debtor": {"title": "Debtor", "type": "string", "format": "uri"}, "dunning_cc_emails_custom": {"type": "array", "items": {"type": "string", "format": "email", "minLength": 1}}, "dunning_to_emails_custom": {"type": "array", "items": {"type": "string", "format": "email", "minLength": 1}}, "email_source": {"title": "E-mails aan", "type": "integer", "enum": [1, 2, 3]}, "invoice_attachment_type": {"$ref": "#/definitions/DerivedInvoiceAttachmentType"}, "invoice_send_method": {"title": "Verzendwijze declaratie", "type": "integer", "enum": [1, 2, 3, 4], "x-nullable": true}, "matter": {"title": "Matter", "type": "string", "format": "uri"}, "percentage": {"title": "Percentage", "type": "string", "format": "decimal", "x-nullable": true}, "split_type": {"title": "Verdeeltype", "type": "integer", "enum": [0, 1, 2]}, "to_email": {"title": "To email", "type": "string", "format": "uri", "x-nullable": true}, "to_emails_custom": {"type": "array", "items": {"type": "string", "format": "email", "minLength": 1}}}}, "MatterCustomField": {"required": ["identifier", "value"], "type": "object", "properties": {"identifier": {"title": "Identifier", "type": "string", "maxLength": 255, "minLength": 1}, "value": {"title": "Value", "type": "string", "maxLength": 255}}}, "DerivedEngagementLetterStatus": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "integer", "x-nullable": true}, "representation": {"title": "Representation", "type": "integer", "readOnly": true}}}, "DerivedFirm": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "format": "uri", "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "format": "uri", "readOnly": true}}}, "DerivedInvoiceLanguage": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "minLength": 1, "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "readOnly": true, "minLength": 1}}}, "DerivedReductionRate": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "format": "decimal", "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "format": "decimal", "readOnly": true}}}, "DerivedReferrer": {"type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "format": "uri", "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "format": "uri", "readOnly": true}}}, "MatterActivities": {"required": ["client", "name"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "archived_date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "softkill_status": {"title": "Softkill status", "type": "string"}, "tags": {"type": "array", "items": {"type": "string", "minLength": 1}}, "access_kind": {"title": "Type toegang", "type": "integer", "enum": [1, 2], "default": 1}, "activity_groups": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "aml_required": {"title": "Aml required", "type": "string", "x-nullable": true}, "billing_instructions": {"title": "Declaratie-instructies", "description": "De instructies worden bovenaan de declaratie getoond (op het scherm).", "type": "string", "x-nullable": true}, "billing_user": {"title": "Billing user", "type": "string", "format": "uri", "x-nullable": true}, "block_time_entry": {"title": "Blokkeer tijdinvoer", "type": "boolean"}, "block_time_entry_comments": {"title": "Blokkeer tijdinvoer opmerkingen", "type": "string"}, "can_archive": {"title": "Can archive", "type": "string", "readOnly": true}, "chinese_wall_kind": {"title": "Chinese wall type", "type": "integer", "enum": [1, 2], "readOnly": true, "x-nullable": true}, "client": {"title": "Client", "type": "string", "format": "uri"}, "client_reference": {"title": "Cliëntreferentie", "description": "Het kenmerk / de referentie voor documenten voor deze cliënt", "type": "string", "maxLength": 255}, "court_reference_number": {"title": "Kenmerk rechtbank", "type": "string", "maxLength": 255, "x-nullable": true}, "created_by": {"title": "Created by", "type": "string", "format": "uri", "readOnly": true}, "currency": {"$ref": "#/definitions/DerivedCurrency"}, "custom_fields": {"type": "array", "items": {"$ref": "#/definitions/MatterCustomField"}}, "date": {"title": "Datum", "type": "string", "format": "date"}, "display": {"title": "Display", "type": "string", "readOnly": true, "minLength": 1}, "display_select": {"title": "Display select", "type": "string", "readOnly": true, "minLength": 1}, "default_invoice_kind": {"title": "Standaard declaratietemplate", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "description": {"title": "Omschrijving", "type": "string"}, "docket_number": {"title": "Rolnummer", "type": "string", "maxLength": 255, "x-nullable": true}, "engagement_letter_status": {"$ref": "#/definitions/DerivedEngagementLetterStatus"}, "firm": {"$ref": "#/definitions/DerivedFirm"}, "insolvency_number": {"title": "Faillissementsnummer", "type": "string", "maxLength": 255, "x-nullable": true}, "invoice_language": {"$ref": "#/definitions/DerivedInvoiceLanguage"}, "is_billable": {"$ref": "#/definitions/DerivedIsBillable"}, "is_recofa": {"title": "Recofadossier?", "type": "boolean"}, "is_time_entry_blocked": {"title": "Is time entry blocked", "type": "string", "readOnly": true}, "legal_aid_number": {"title": "Toevoegingsnummer", "type": "string", "maxLength": 255, "x-nullable": true}, "logline_submatter_required": {"title": "Logline submatter required", "type": "boolean"}, "magistrate": {"title": "Rechter-Commissaris", "type": "string", "maxLength": 255, "x-nullable": true}, "matter_status": {"title": "Matter status", "type": "string", "format": "uri", "default": {"display_name": "Actief", "id": 1, "url": "http://localhost:8000/api/v3/matterstatuses/1/?format=openapi"}}, "matter_type": {"title": "Matter type", "type": "string", "format": "uri", "x-nullable": true}, "name": {"title": "Dossiernaam", "type": "string", "maxLength": 255, "minLength": 1}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "maxLength": 255, "x-nullable": true}, "office_expenses_rate": {"$ref": "#/definitions/DerivedOfficeExpensesRate"}, "on_hold": {"title": "Declareren stopgezet", "type": "boolean"}, "on_hold_until": {"title": "Stopgezet t/m", "type": "string", "format": "date", "x-nullable": true}, "on_hold_comments": {"title": "Opmerkingen stopzetting declareren", "type": "string", "x-nullable": true}, "originating_user": {"title": "Originating user", "type": "string", "format": "uri", "x-nullable": true}, "points": {"title": "Punten", "type": "string", "format": "decimal", "x-nullable": true}, "practice_area": {"title": "Practice area", "type": "string", "format": "uri", "x-nullable": true}, "practice_group": {"title": "Practice group", "type": "string", "format": "uri", "x-nullable": true}, "price_list": {"title": "Price list", "type": "string", "format": "uri", "readOnly": true}, "recofa_cap": {"title": "Boedelsaldo", "description": "Het boedelsaldo bepaalt het maximaal in rekening te brengen bedrag", "type": "string", "format": "decimal", "x-nullable": true}, "recofa_inventory": {"title": "Boedelomvang (vrij actief)", "description": "De boedelomvang is bepalend voor boedelfactor", "type": "string", "format": "decimal", "x-nullable": true}, "recofa_court_decision_date": {"title": "Datum uitspraak rechtbank", "type": "string", "format": "date", "x-nullable": true}, "reduction_rate": {"$ref": "#/definitions/DerivedReductionRate"}, "referrer": {"$ref": "#/definitions/DerivedReferrer"}, "rvr_approval_date": {"title": "Datum toekenning RvR", "type": "string", "format": "date", "x-nullable": true}, "submatters": {"type": "array", "items": {"type": "string", "format": "uri"}, "readOnly": true, "uniqueItems": true}, "supervising_user": {"title": "Supervising user", "type": "string", "format": "uri", "x-nullable": true}, "users": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "wip_percentage": {"title": "OHW percentage", "type": "string", "format": "decimal", "x-nullable": true}, "activities": {"type": "array", "items": {"type": "integer"}, "readOnly": true}}}, "Matter": {"required": ["client", "name"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "archived_date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "softkill_status": {"title": "Softkill status", "type": "string"}, "tags": {"type": "array", "items": {"type": "string", "minLength": 1}}, "access_kind": {"title": "Type toegang", "type": "integer", "enum": [1, 2], "default": 1}, "activity_groups": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "aml_required": {"title": "Aml required", "type": "string", "x-nullable": true}, "billing_instructions": {"title": "Declaratie-instructies", "description": "De instructies worden bovenaan de declaratie getoond (op het scherm).", "type": "string", "x-nullable": true}, "billing_user": {"title": "Billing user", "type": "string", "format": "uri", "x-nullable": true}, "block_time_entry": {"title": "Blokkeer tijdinvoer", "type": "boolean"}, "block_time_entry_comments": {"title": "Blokkeer tijdinvoer opmerkingen", "type": "string"}, "can_archive": {"title": "Can archive", "type": "string", "readOnly": true}, "chinese_wall_kind": {"title": "Chinese wall type", "type": "integer", "enum": [1, 2], "readOnly": true, "x-nullable": true}, "client": {"title": "Client", "type": "string", "format": "uri"}, "client_reference": {"title": "Cliëntreferentie", "description": "Het kenmerk / de referentie voor documenten voor deze cliënt", "type": "string", "maxLength": 255}, "court_reference_number": {"title": "Kenmerk rechtbank", "type": "string", "maxLength": 255, "x-nullable": true}, "created_by": {"title": "Created by", "type": "string", "format": "uri", "readOnly": true}, "currency": {"$ref": "#/definitions/DerivedCurrency"}, "custom_fields": {"type": "array", "items": {"$ref": "#/definitions/MatterCustomField"}}, "date": {"title": "Datum", "type": "string", "format": "date"}, "display": {"title": "Display", "type": "string", "readOnly": true, "minLength": 1}, "display_select": {"title": "Display select", "type": "string", "readOnly": true, "minLength": 1}, "default_invoice_kind": {"title": "Standaard declaratietemplate", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "description": {"title": "Omschrijving", "type": "string"}, "docket_number": {"title": "Rolnummer", "type": "string", "maxLength": 255, "x-nullable": true}, "engagement_letter_status": {"$ref": "#/definitions/DerivedEngagementLetterStatus"}, "firm": {"$ref": "#/definitions/DerivedFirm"}, "insolvency_number": {"title": "Faillissementsnummer", "type": "string", "maxLength": 255, "x-nullable": true}, "invoice_language": {"$ref": "#/definitions/DerivedInvoiceLanguage"}, "is_billable": {"$ref": "#/definitions/DerivedIsBillable"}, "is_recofa": {"title": "Recofadossier?", "type": "boolean"}, "is_time_entry_blocked": {"title": "Is time entry blocked", "type": "string", "readOnly": true}, "legal_aid_number": {"title": "Toevoegingsnummer", "type": "string", "maxLength": 255, "x-nullable": true}, "logline_submatter_required": {"title": "Logline submatter required", "type": "boolean"}, "magistrate": {"title": "Rechter-Commissaris", "type": "string", "maxLength": 255, "x-nullable": true}, "matter_status": {"title": "Matter status", "type": "string", "format": "uri", "default": {"display_name": "Actief", "id": 1, "url": "http://localhost:8000/api/v3/matterstatuses/1/?format=openapi"}}, "matter_type": {"title": "Matter type", "type": "string", "format": "uri", "x-nullable": true}, "name": {"title": "Dossiernaam", "type": "string", "maxLength": 255, "minLength": 1}, "number": {"title": "Nummer", "description": "Laat dit veld leeg om automatisch een waarde toe te wijzen", "type": "string", "maxLength": 255, "x-nullable": true}, "office_expenses_rate": {"$ref": "#/definitions/DerivedOfficeExpensesRate"}, "on_hold": {"title": "Declareren stopgezet", "type": "boolean"}, "on_hold_until": {"title": "Stopgezet t/m", "type": "string", "format": "date", "x-nullable": true}, "on_hold_comments": {"title": "Opmerkingen stopzetting declareren", "type": "string", "x-nullable": true}, "originating_user": {"title": "Originating user", "type": "string", "format": "uri", "x-nullable": true}, "points": {"title": "Punten", "type": "string", "format": "decimal", "x-nullable": true}, "practice_area": {"title": "Practice area", "type": "string", "format": "uri", "x-nullable": true}, "practice_group": {"title": "Practice group", "type": "string", "format": "uri", "x-nullable": true}, "price_list": {"title": "Price list", "type": "string", "format": "uri", "readOnly": true}, "recofa_cap": {"title": "Boedelsaldo", "description": "Het boedelsaldo bepaalt het maximaal in rekening te brengen bedrag", "type": "string", "format": "decimal", "x-nullable": true}, "recofa_inventory": {"title": "Boedelomvang (vrij actief)", "description": "De boedelomvang is bepalend voor boedelfactor", "type": "string", "format": "decimal", "x-nullable": true}, "recofa_court_decision_date": {"title": "Datum uitspraak rechtbank", "type": "string", "format": "date", "x-nullable": true}, "reduction_rate": {"$ref": "#/definitions/DerivedReductionRate"}, "referrer": {"$ref": "#/definitions/DerivedReferrer"}, "rvr_approval_date": {"title": "Datum toekenning RvR", "type": "string", "format": "date", "x-nullable": true}, "submatters": {"type": "array", "items": {"type": "string", "format": "uri"}, "readOnly": true, "uniqueItems": true}, "supervising_user": {"title": "Supervising user", "type": "string", "format": "uri", "x-nullable": true}, "users": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "wip_percentage": {"title": "OHW percentage", "type": "string", "format": "decimal", "x-nullable": true}}}, "MatterXmlCodex": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "archived_date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "softkill_status": {"title": "Softkill status", "type": "string"}}}, "MatterActionArchive": {"type": "object", "properties": {"archive_date": {"title": "Archive date", "type": "string", "format": "date", "default": "2026-06-29"}, "archive_number": {"title": "Archive number", "type": "string", "minLength": 1}, "notes": {"title": "Notes", "type": "string", "default": "", "minLength": 1}, "retention_period": {"title": "Retention period", "type": "integer", "x-nullable": true}}}, "MatterActionUnarchive": {"required": ["keep_archive_number"], "type": "object", "properties": {"keep_archive_number": {"title": "Keep archive number", "type": "boolean"}}}, "MatterStatus": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "is_default": {"title": "Is standaard", "description": "Deze status wordt als standaardwaarde gebruikt", "type": "boolean"}, "billing_on_hold": {"title": "Declareren stopgezet", "type": "boolean"}, "block_time_entry": {"title": "Blokkeer tijdinvoer", "type": "boolean"}}}, "MatterType": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "code": {"title": "Code", "type": "string", "maxLength": 16, "x-nullable": true}, "is_wwft_required": {"title": "Wwft-plicht", "type": "boolean", "readOnly": true, "x-nullable": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}}}, "Office": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}}}, "OrganizationKindSubtype": {"required": ["name", "organization_kind"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "organization_kind": {"title": "Rechtsvorm type", "type": "integer", "enum": [1, 2, 3, 4]}}}, "PartialPaymentInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "partially_paid_invoice": {"title": "Partially paid invoice", "type": "string", "format": "uri", "readOnly": true}, "partially_paid_section": {"title": "Partially paid section", "type": "string", "format": "uri", "readOnly": true}, "split_type": {"title": "Verdeeltype", "type": "integer", "enum": [0, 1, 2]}, "partial_amount": {"title": "Bedrag", "type": "string", "format": "decimal", "x-nullable": true}, "partial_percentage": {"title": "Percentage", "type": "string", "format": "decimal", "x-nullable": true}, "tax_percentage": {"title": "Tax percentage", "type": "string", "format": "uri", "readOnly": true}}}, "Payment": {"required": ["amount", "invoice"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "comments": {"title": "Betalingstoelichting", "type": "string"}, "date": {"title": "Betaaldatum", "type": "string", "format": "date", "x-nullable": true}, "invoice": {"title": "Invoice", "type": "string", "format": "uri"}, "is_outstanding_correction": {"title": "Is outstanding correction", "type": "boolean", "readOnly": true}, "is_sent_by_email": {"title": "Is sent by email", "type": "boolean", "readOnly": true}}}, "PracticeArea": {"required": ["name", "short_name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "short_name": {"title": "Verkorte naam", "type": "string", "maxLength": 10, "minLength": 1}}}, "PracticeGroupCurrentMembers": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}}}, "PracticeGroup": {"required": ["boss", "short_name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "boss": {"title": "Boss", "type": "string", "format": "uri"}, "chinese_wall_kind": {"title": "Chinese wall type", "description": "Chinese wall types kunnen alleen ingesteld worden tijdens het aanmaken van een praktijkgroep.", "type": "integer", "enum": [1, 2], "readOnly": true, "x-nullable": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "short_name": {"title": "Verkorte naam", "type": "string", "maxLength": 255, "minLength": 1}, "current_members": {"type": "array", "items": {"$ref": "#/definitions/PracticeGroupCurrentMembers"}, "readOnly": true}}}, "PriceKey": {"required": ["is_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "object_type": {"title": "Object type", "type": "string", "readOnly": true, "minLength": 1}, "is_rate": {"title": "Is rate", "type": "boolean"}}}, "PriceList": {"required": ["pricing_scheme", "underlying_list", "fixed_fee_underlying_scheme", "fallback_list"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "x-nullable": true}, "pricing_scheme": {"title": "Pricing scheme", "type": "string"}, "underlying_list": {"title": "Underlying list", "type": "string", "format": "uri"}, "fixed_fee_underlying_scheme": {"title": "Fixed fee underlying scheme", "type": "string"}, "fallback_list": {"title": "Fallback list", "type": "string", "format": "uri"}, "is_template": {"title": "Is template", "type": "string", "readOnly": true}}}, "Price": {"required": ["list", "key"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "list": {"title": "List", "type": "string", "format": "uri"}, "key": {"title": "Key", "type": "string", "format": "uri"}, "value": {"title": "Waarde", "type": "string", "format": "decimal", "x-nullable": true}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "ProductInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate", "unit_price", "quantity", "office_expenses_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "unit_price": {"title": "Stukprijs", "type": "string", "format": "decimal"}, "quantity": {"title": "Aantal", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "submatter": {"title": "Submatter", "type": "string", "format": "uri", "readOnly": true}, "office_expenses_rate": {"title": "Office expenses rate", "type": "string", "format": "decimal"}}}, "RecofaCategory": {"required": ["code", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "code": {"title": "Code", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "name": {"title": "Name", "type": "string", "maxLength": 255, "minLength": 1}}}, "Referrer": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Naam referentie", "type": "string", "maxLength": 255, "minLength": 1}}}, "Sector": {"required": ["name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "name": {"title": "Sector", "type": "string", "maxLength": 255, "minLength": 1}}}, "SplitFactor": {"required": ["user", "matter", "factor"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "user": {"title": "User", "type": "string", "format": "uri"}, "matter": {"title": "Matter", "type": "string", "format": "uri"}, "factor": {"title": "Factor", "type": "string", "format": "decimal"}, "begin_date": {"title": "Begin date", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "End date", "type": "string", "format": "date", "x-nullable": true}}}, "SubmatterBudget": {"required": ["submatter"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Bedrag", "type": "string", "format": "decimal", "x-nullable": true}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}, "hours": {"title": "Uren", "type": "integer", "maximum": 2147483647, "minimum": 1, "x-nullable": true}, "kind": {"title": "Type budget", "type": "integer", "enum": [4, 1, 2, 3]}, "notify_billing_user": {"title": "Notificaties aan verantwoordelijke declaratieproces", "type": "boolean"}, "notify_supervising_user": {"title": "Notificaties aan verantwoordelijk advocaat", "type": "boolean"}, "notify_user": {"title": "Notificaties aan tijdschrijvende gebruiker", "type": "boolean"}, "object_type": {"title": "Object type", "type": "string", "readOnly": true, "minLength": 1}, "amount_used": {"title": "Amount used", "type": "string", "format": "decimal", "readOnly": true}, "hours_used": {"title": "Hours used", "type": "string", "readOnly": true}, "submatter": {"title": "Submatter", "type": "string", "format": "uri"}, "matter": {"title": "Matter", "type": "string", "format": "uri", "readOnly": true}, "client": {"title": "Client", "type": "string", "format": "uri", "readOnly": true}}}, "SubmatterKindRate": {"required": ["rate"], "type": "object", "properties": {"rate": {"title": "Tarief", "type": "string", "format": "decimal"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "SubmatterKind": {"required": ["name", "name_on_invoice"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "current_unit_price": {"title": "Current unit price", "type": "string", "readOnly": true}, "is_product": {"title": "Is product", "type": "boolean"}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "name_on_invoice": {"title": "Name on invoice", "type": "string"}, "rates": {"type": "array", "items": {"$ref": "#/definitions/SubmatterKindRate"}}, "ledes_task_code": {"title": "LEDES taak code", "description": "LEDES taak code die zal worden gebruikt voor alle verrichtingen geschreven op dit type subdossier.", "type": "string", "maxLength": 255, "x-nullable": true}}}, "DerivedDisplayName": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "minLength": 1, "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "readOnly": true, "minLength": 1}}}, "DerivedUnitPrice": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "format": "decimal", "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "format": "decimal", "readOnly": true}}}, "Submatter": {"required": ["kind", "name", "matter"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "billed_on_invoice": {"title": "Billed on invoice", "type": "string", "format": "uri", "readOnly": true}, "billed_on_invoice_draft": {"title": "Billed on invoice draft", "type": "string", "format": "uri", "readOnly": true}, "billed_elsewhere": {"title": "Billed elsewhere", "type": "boolean", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "archived_date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "softkill_status": {"title": "Softkill status", "type": "string"}, "billing_date": {"title": "Vroegste declaratie-datum", "type": "string", "format": "date", "x-nullable": true}, "fixed_fee_underlying_scheme": {"title": "Schema voor onderhanden werk", "type": "integer", "enum": [1, 2]}, "name_on_invoice": {"$ref": "#/definitions/DerivedDisplayName"}, "kind": {"title": "Kind", "type": "string", "format": "uri"}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "matter": {"title": "Matter", "type": "string", "format": "uri"}, "originating_subscription": {"title": "Originating subscription", "type": "string", "format": "uri", "readOnly": true}, "quantity": {"title": "Aantal", "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "x-nullable": true}, "unit_price": {"$ref": "#/definitions/DerivedUnitPrice"}}}, "DerivedName": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "minLength": 1, "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "readOnly": true, "minLength": 1}}}, "DerivedNameOnInvoice": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "minLength": 1, "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "readOnly": true, "minLength": 1}}}, "Subscription": {"required": ["begin_date", "kind", "matter", "recurrences"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "archived_date": {"title": "Datum", "type": "string", "format": "date", "x-nullable": true}, "softkill_status": {"title": "Softkill status", "type": "string"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date"}, "billing_date_days_offset": {"title": "Datumverschil declaratie-moment", "description": "In dagen. Gebruik een negatieve waarde om \"voor de referentie-datum\" mee aan te duiden.", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "billing_date_period_reference": {"title": "Declareer op", "type": "string", "enum": ["BEGIN", "END"]}, "default_quantity": {"title": "Standaard aantal", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "kind": {"title": "Kind", "type": "string", "format": "uri"}, "matter": {"title": "Matter", "type": "string", "format": "uri"}, "name": {"$ref": "#/definitions/DerivedName"}, "name_on_invoice": {"$ref": "#/definitions/DerivedNameOnInvoice"}, "recurrences": {"title": "Frequentie", "type": "string"}, "unit_price": {"title": "Stukprijs", "description": "Indien leeggelaten: de standaardprijs", "type": "string", "format": "decimal", "x-nullable": true}}}, "DerivedTotalTime": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "integer", "x-nullable": true}, "representation": {"title": "Representation", "type": "integer", "readOnly": true}}}, "Target": {"required": ["amount", "begin_date", "billable_time", "end_date", "total_time", "user"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Bedrag", "type": "string", "format": "decimal"}, "amount2": {"title": "Bedrag 2", "type": "string", "format": "decimal"}, "begin_date": {"title": "Van (datum)", "type": "string", "format": "date"}, "billable_time": {"title": "Target declarabele tijd", "description": "Tijd in volledige uren", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "billable_time2": {"title": "Target declarabele tijd 2", "description": "Tijd in volledige uren", "type": "integer", "maximum": 2147483647, "minimum": -2147483648}, "comments": {"title": "Opmerkingen", "type": "string"}, "end_date": {"title": "T/m", "type": "string", "format": "date"}, "total_time": {"$ref": "#/definitions/DerivedTotalTime"}, "user": {"title": "User", "type": "string", "format": "uri"}}}, "TaxCountry": {"required": ["country", "example_tax_number"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "country": {"title": "Land", "type": "string", "enum": ["AF", "AX", "AL", "DZ", "AS", "VI", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AZ", "BS", "BH", "BD", "BB", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CA", "KY", "CF", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "CU", "CW", "CY", "CD", "DK", "DJ", "DM", "DO", "DE", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FO", "FK", "FJ", "PH", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "GH", "GI", "GD", "GR", "GL", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "IM", "HN", "HU", "HK", "IS", "IE", "IN", "ID", "IQ", "IR", "IL", "IT", "CI", "JM", "JP", "YE", "JE", "JO", "CV", "CM", "KZ", "KE", "KG", "KI", "UM", "KW", "XK", "HR", "LA", "LS", "LV", "LB", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MV", "MY", "ML", "MT", "MA", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MZ", "MM", "NA", "NR", "NL", "NP", "NI", "NC", "NZ", "NE", "NG", "NU", "KP", "MK", "MP", "NO", "NF", "UG", "UA", "UZ", "OM", "ZZ", "TL", "AT", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "KN", "LC", "VC", "BL", "PM", "SB", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SH", "SX", "MF", "SI", "SK", "SD", "SO", "ES", "SJ", "LK", "SR", "SY", "TJ", "TW", "TZ", "TH", "TG", "TK", "TO", "TT", "TD", "CZ", "TN", "TR", "TM", "TC", "TV", "UY", "VU", "VE", "GB", "AE", "US", "VN", "WF", "EH", "BY", "ZM", "ZW", "SS", "ZA", "GS", "KR", "SE", "CH"]}, "example_tax_number": {"title": "Voorbeeld btw-nummer", "type": "string", "maxLength": 30, "minLength": 1}}}, "TaxPercentage": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}, "rate": {"title": "Rate", "type": "string", "format": "uri", "readOnly": true}, "value": {"title": "Percentage", "type": "string", "format": "decimal", "x-nullable": true}}}, "TaxRate": {"required": ["short_name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "country": {"title": "Country", "type": "string", "format": "uri", "readOnly": true}, "is_default_advance_tax_rate": {"title": "Standaard btw-tarief voor voorschotten", "description": "Standaard btw-tarief voor voorschotten van een kantoor/belasting-land", "type": "boolean"}, "is_default_logline_tax_rate": {"title": "Standaard btw-tarief voor tijdregels", "description": "Standaard btw-tarief voor tijdregels van een kantoor/belasting-land", "type": "boolean"}, "is_default_tax_rate": {"title": "Standaard btw-tarief", "description": "Standaard btw-tarief van een kantoor/belasting-land", "type": "boolean"}, "is_selectable_logline_tax_rate": {"title": "Selecteerbaar btw tarief voor tijdregel", "description": "Selecteerbaar btw-tarief van een kantoor/belasting-land voor een tijdregel op de declaratie.", "type": "boolean"}, "short_name": {"title": "Verkorte naam", "type": "string", "maxLength": 25, "minLength": 1}}}, "TaxScheme": {"required": ["kind", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean"}, "applicable_tax_rates": {"type": "array", "items": {"type": "string", "format": "uri"}, "readOnly": true, "uniqueItems": true}, "country": {"title": "Country", "type": "string", "format": "uri", "readOnly": true}, "is_tax_free": {"title": "Is tax free", "type": "string", "readOnly": true}, "kind": {"title": "Kind", "type": "integer", "enum": [1, 2, 3, 4, 5]}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}}}, "TrustAccountingSettlementInvoiceline": {"required": ["amount", "billed_amount", "billed_amount_ex_office_expenses", "description", "object_type", "paid_amount", "reduction_amount", "reduction_rate"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "amount": {"title": "Amount", "type": "string", "format": "decimal"}, "billables_are_dependent": {"title": "Billables are dependent", "type": "boolean"}, "billed_amount": {"title": "Billed amount", "type": "string", "format": "decimal"}, "billed_amount_ex_office_expenses": {"title": "Billed amount ex office expenses", "type": "string", "format": "decimal"}, "description": {"title": "Description", "type": "string", "minLength": 1}, "object_type": {"title": "Object type", "type": "string", "minLength": 1}, "no_details": {"title": "Geen details", "description": "Deze regel niet tonen in declaratie detail.", "type": "boolean"}, "paid_amount": {"title": "Paid amount", "type": "string", "format": "decimal"}, "reduction_amount": {"title": "Reduction amount", "type": "string", "format": "decimal"}, "reduction_rate": {"title": "Reduction rate", "type": "string", "format": "decimal"}, "section": {"title": "Section", "type": "string", "format": "uri", "readOnly": true}, "trust_account": {"title": "Trust account", "type": "string", "format": "uri", "readOnly": true}}}, "TrustAccountingTransaction": {"required": ["account", "amount", "date", "description", "matter"], "type": "object", "properties": {"created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "account": {"title": "Account", "type": "string", "format": "uri"}, "amount": {"title": "Bedrag", "type": "string", "format": "decimal"}, "date": {"title": "Datum", "type": "string", "format": "date"}, "description": {"title": "Omschrijving", "type": "string", "minLength": 1}, "matter": {"title": "Matter", "type": "string", "format": "uri"}}}, "DerivedDefaultReportingCurrency": {"required": ["internal"], "type": "object", "properties": {"is_derived": {"title": "Is derived", "type": "boolean", "readOnly": true}, "internal": {"title": "Internal", "type": "string", "minLength": 1, "x-nullable": true}, "representation": {"title": "Representation", "type": "string", "readOnly": true, "minLength": 1}}}, "UserPreference": {"required": ["default_reporting_currency"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "default_reporting_currency": {"$ref": "#/definitions/DerivedDefaultReportingCurrency"}, "user": {"title": "User", "type": "string", "format": "uri", "readOnly": true}}}, "UserProfileCustomFieldDefinition": {"required": ["identifier", "name"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "is_active": {"title": "Is active", "type": "boolean", "readOnly": true}, "default": {"title": "Standaard", "description": "Deze waarde wordt gebruikt als standaard waarde voor nieuwe objecten. Voor velden die de widget \"Keuzelijst\" gebruiken, kies een waarde, niet de weergegeven tekst.", "type": "string", "maxLength": 255, "x-nullable": true}, "excel_export": {"title": "Voeg toe bij een Excel export", "type": "boolean"}, "excel_export_value": {"title": "Excel export waarde", "description": "Als dit veld naar Excel wordt geëxporteerd en het is een keuzeveld, kies dan wat er moet worden weergegeven in Excel: de waarde van het veld of de tekst uit het keuzeveld.", "type": "integer", "enum": [1, 2, 3]}, "extra_info": {"title": "Extra informatie", "description": "Als de 'Keuzelijst' widget is gekozen, geef dan hier de mogelijke keuzes op. Eén optie per regel, in de vorm van '2|Tweede optie'.", "type": "string", "x-nullable": true}, "help_text": {"title": "Helptekst", "description": "Wordt getoond onder het invoerveld.", "type": "string"}, "identifier": {"title": "Systeemnaam", "type": "string", "pattern": "^[0-9a-zA-Z_-]+$", "maxLength": 255, "minLength": 1}, "name": {"title": "Naam", "type": "string", "maxLength": 255, "minLength": 1}, "read_only": {"title": "Read-only veld", "type": "boolean"}, "required": {"title": "Verplicht veld", "type": "boolean"}, "widget": {"title": "Widget", "type": "integer", "enum": [1, 2, 3, 4, 5, 6, 7]}}}, "UserCostRate": {"type": "object", "properties": {"rate": {"title": "Kostprijs", "type": "string", "format": "decimal"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "UserProfileCustomField": {"required": ["identifier", "value"], "type": "object", "properties": {"identifier": {"title": "Identifier", "type": "string", "maxLength": 255, "minLength": 1}, "value": {"title": "Value", "type": "string", "maxLength": 255}}}, "UserFunction": {"required": ["function"], "type": "object", "properties": {"function": {"title": "Function", "type": "string", "format": "uri"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "UserLeverageTeam": {"required": ["leverage_team"], "type": "object", "properties": {"leverage_team": {"title": "Leverage team", "type": "string", "format": "uri"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "UserOffice": {"required": ["office"], "type": "object", "properties": {"office": {"title": "Office", "type": "string", "format": "uri"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "UserPracticeGroup": {"required": ["practice_group"], "type": "object", "properties": {"practice_group": {"title": "Practice group", "type": "string", "format": "uri"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "UserRate": {"required": ["rate"], "type": "object", "properties": {"rate": {"title": "Tarief", "type": "string", "format": "decimal"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "UserVariableCostRate": {"type": "object", "properties": {"rate": {"title": "Variabele kostprijs", "type": "string", "format": "decimal"}, "begin_date": {"title": "Startdatum", "type": "string", "format": "date", "x-nullable": true}, "end_date": {"title": "Einddatum", "type": "string", "format": "date", "x-nullable": true}}}, "User": {"required": ["begin_date", "email", "expected_hours_factor", "first_name", "functions", "groups", "is_fee_earner", "last_name", "username"], "type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "display_name": {"title": "Display name", "type": "string", "readOnly": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}, "abbreviation": {"title": "Abbreviation", "type": "string", "minLength": 1}, "begin_date": {"title": "Begin date", "type": "string", "format": "date"}, "billing_assistant": {"title": "Billing assistant", "type": "string", "format": "uri", "x-nullable": true}, "cost_rates": {"type": "array", "items": {"$ref": "#/definitions/UserCostRate"}}, "custom_fields": {"type": "array", "items": {"$ref": "#/definitions/UserProfileCustomField"}}, "dashboard_note": {"title": "Dashboard note", "type": "string", "minLength": 1}, "email": {"title": "E-mailadres", "type": "string", "format": "email", "maxLength": 254}, "employee_number": {"title": "Employee number", "type": "string", "minLength": 1, "x-nullable": true}, "end_date": {"title": "End date", "type": "string", "format": "date", "x-nullable": true}, "expected_hours_factor": {"title": "Expected hours factor", "type": "string", "format": "decimal"}, "first_name": {"title": "First name", "type": "string", "minLength": 1}, "functions": {"type": "array", "items": {"$ref": "#/definitions/UserFunction"}}, "groups": {"type": "array", "items": {"type": "string", "format": "uri"}, "uniqueItems": true}, "initials": {"title": "Initials", "type": "string", "minLength": 1}, "is_fee_earner": {"title": "Is fee earner", "type": "boolean"}, "is_selectable": {"title": "Is selectable", "type": "boolean"}, "last_name": {"title": "Last name", "type": "string", "minLength": 1}, "last_release": {"title": "Last release", "type": "string", "default": "26.03", "minLength": 1}, "leverage_teams": {"type": "array", "items": {"$ref": "#/definitions/UserLeverageTeam"}, "readOnly": true}, "name_prefix": {"title": "Name prefix", "type": "string", "minLength": 1}, "offices": {"type": "array", "items": {"$ref": "#/definitions/UserOffice"}, "readOnly": true}, "practice_groups": {"type": "array", "items": {"$ref": "#/definitions/UserPracticeGroup"}, "readOnly": true}, "rates": {"type": "array", "items": {"$ref": "#/definitions/UserRate"}}, "receive_security_email": {"title": "Receive security email", "type": "boolean"}, "recofa_begin_date": {"title": "Recofa begin date", "type": "string", "format": "date", "x-nullable": true}, "recofa_sworn_in_date": {"title": "Recofa sworn in date", "type": "string", "format": "date", "x-nullable": true}, "title": {"title": "Title", "type": "string"}, "username": {"title": "Gebruikersnaam", "description": "Vereist. 150 tekens of minder. Alleen letters, cijfers en de tekens @/,/+/-/_ zijn toegestaan.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1}, "variable_cost_rates": {"type": "array", "items": {"$ref": "#/definitions/UserVariableCostRate"}}}}, "VoiceToTimeSubmission": {"type": "object", "properties": {"audio_file": {"title": "Audio file", "type": "string", "readOnly": true, "format": "uri"}, "created_date": {"title": "Aanmaakdatum", "type": "string", "format": "date-time", "readOnly": true}, "id": {"title": "ID", "type": "integer", "readOnly": true}, "modified_date": {"title": "Laatst gewijzigd", "type": "string", "format": "date-time", "readOnly": true}, "status": {"title": "Status", "type": "integer", "enum": [1, 2, 3, 4], "readOnly": true, "x-nullable": true}, "structured_data": {"title": "Structured data", "type": "object", "readOnly": true, "x-nullable": true}, "transcription": {"title": "Transcription", "type": "string", "readOnly": true, "minLength": 1, "x-nullable": true}, "url": {"title": "Url", "type": "string", "format": "uri", "readOnly": true}}}}}