{ "openapi": "3.0.3", "info": { "title": "Provet REST API", "version": "0.1" }, "paths": { "/accountingreport/": { "get": { "operationId": "accountingreport_list", "description": "Required permissions:\n- Financial: End of day and accounting reports\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Accounting reports" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAccountingReportList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAccountingReportList" } } }, "description": "" } }, "summary": "List Accountingreport" } }, "/accountingreport/{id}/": { "get": { "operationId": "accountingreport_retrieve", "description": "Required permissions:\n- Financial: End of day and accounting reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cash report accounting.", "required": true } ], "tags": [ "Accounting reports" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingReportDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AccountingReportDetail" } } }, "description": "" } }, "summary": "Get Accountingreport" } }, "/accountnumber/": { "get": { "operationId": "accountnumber_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Account numbers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAccountNumberList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAccountNumberList" } } }, "description": "" } }, "summary": "List Accountnumber" }, "post": { "operationId": "accountnumber_create", "description": "Create Account Number\n\nDeduplicates on the combination of `number`, `description`, and\n`department`: if an Account Number already exists with the same\nvalues for all three, that existing record is returned (and\nunarchived, if it was archived) instead of creating a new one. A\ndifferent `description` or `department` for the same `number` is\nnot treated as a duplicate and creates a separate Account Number.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Account numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountNumberRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountNumberRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AccountNumberRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountNumber" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AccountNumber" } } }, "description": "" } }, "summary": "Create Accountnumber" } }, "/accountnumber/{id}/": { "get": { "operationId": "accountnumber_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this account number.", "required": true } ], "tags": [ "Account numbers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountNumber" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AccountNumber" } } }, "description": "" } }, "summary": "Get Accountnumber" }, "put": { "operationId": "accountnumber_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this account number.", "required": true } ], "tags": [ "Account numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountNumberRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountNumberRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AccountNumberRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountNumber" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AccountNumber" } } }, "description": "" } }, "summary": "Update Accountnumber" }, "patch": { "operationId": "accountnumber_partial_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this account number.", "required": true } ], "tags": [ "Account numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAccountNumberRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAccountNumberRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAccountNumberRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountNumber" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AccountNumber" } } }, "description": "" } }, "summary": "Patch Accountnumber" } }, "/alternative_payer/": { "get": { "operationId": "alternative_payer_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Alternative payers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAlternativePayerList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAlternativePayerList" } } }, "description": "" } }, "summary": "List Alternative Payer" }, "post": { "operationId": "alternative_payer_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Alternative payers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePayerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlternativePayerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlternativePayerRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePayer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AlternativePayer" } } }, "description": "" } }, "summary": "Create Alternative Payer" } }, "/alternative_payer/{id}/": { "get": { "operationId": "alternative_payer_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alternative payer.", "required": true } ], "tags": [ "Alternative payers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePayer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AlternativePayer" } } }, "description": "" } }, "summary": "Get Alternative Payer" }, "put": { "operationId": "alternative_payer_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alternative payer.", "required": true } ], "tags": [ "Alternative payers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePayerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlternativePayerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlternativePayerRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePayer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AlternativePayer" } } }, "description": "" } }, "summary": "Update Alternative Payer" }, "patch": { "operationId": "alternative_payer_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alternative payer.", "required": true } ], "tags": [ "Alternative payers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAlternativePayerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAlternativePayerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAlternativePayerRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePayer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AlternativePayer" } } }, "description": "" } }, "summary": "Patch Alternative Payer" }, "delete": { "operationId": "alternative_payer_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alternative payer.", "required": true } ], "tags": [ "Alternative payers" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Alternative Payer" } }, "/alternativepricing/": { "get": { "operationId": "alternativepricing_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Alternative pricings" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAlternativePricingList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAlternativePricingList" } } }, "description": "" } }, "summary": "List Alternativepricing" }, "post": { "operationId": "alternativepricing_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Alternative pricings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePricingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlternativePricingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlternativePricingRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePricing" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AlternativePricing" } } }, "description": "" } }, "summary": "Create Alternativepricing" } }, "/alternativepricing/{id}/": { "get": { "operationId": "alternativepricing_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alternative pricing.", "required": true } ], "tags": [ "Alternative pricings" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePricing" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AlternativePricing" } } }, "description": "" } }, "summary": "Get Alternativepricing" }, "put": { "operationId": "alternativepricing_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alternative pricing.", "required": true } ], "tags": [ "Alternative pricings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePricingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AlternativePricingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AlternativePricingRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePricing" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AlternativePricing" } } }, "description": "" } }, "summary": "Update Alternativepricing" }, "patch": { "operationId": "alternativepricing_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alternative pricing.", "required": true } ], "tags": [ "Alternative pricings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAlternativePricingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAlternativePricingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAlternativePricingRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlternativePricing" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AlternativePricing" } } }, "description": "" } }, "summary": "Patch Alternativepricing" }, "delete": { "operationId": "alternativepricing_destroy", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this alternative pricing.", "required": true } ], "tags": [ "Alternative pricings" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Alternativepricing" } }, "/antibiotic/": { "get": { "operationId": "antibiotic_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAntibioticList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAntibioticList" } } }, "description": "" } }, "summary": "List Antibiotic" } }, "/antibiotic/{id}/": { "get": { "operationId": "antibiotic_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this antibiotic.", "required": true } ], "tags": [ "Antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Antibiotic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Antibiotic" } } }, "description": "" } }, "summary": "Get Antibiotic" } }, "/antibioticpanel/": { "get": { "operationId": "antibioticpanel_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAntibioticPanelList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAntibioticPanelList" } } }, "description": "" } }, "summary": "List Antibioticpanel" } }, "/antibioticpanel/{id}/": { "get": { "operationId": "antibioticpanel_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this antibiotic panel.", "required": true } ], "tags": [ "Antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AntibioticPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AntibioticPanel" } } }, "description": "" } }, "summary": "Get Antibioticpanel" } }, "/appointment/": { "get": { "operationId": "appointment_list", "description": "List Appointments\n\nType values:\n- TYPE_CONSULTATION = 1\n- TYPE_ONLINE_BOOKING = 2\n- TYPE_OTHER = 3\n\nQuery Parameters:\n- include_shared_wards (bool): When true and department filter is set,\n includes appointments from other departments that use wards shared\n with the filtered department.\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "additional_users__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "additional_users__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "complaint_type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "complaint_type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "complaint_type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "complaint_type__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "complaint_type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__eq", "schema": { "type": "string" }, "description": "eq filter on department" }, { "in": "query", "name": "department__neq", "schema": { "type": "string" }, "description": "neq filter on department" }, { "in": "query", "name": "end__eq", "schema": { "type": "string" }, "description": "eq filter on end" }, { "in": "query", "name": "end__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "end__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "end__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "end__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "end__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "end__neq", "schema": { "type": "string" }, "description": "neq filter on end" }, { "in": "query", "name": "end__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "end__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "end__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__eq", "schema": { "type": "string" }, "description": "eq filter on id" }, { "in": "query", "name": "id__neq", "schema": { "type": "string" }, "description": "neq filter on id" }, { "in": "query", "name": "invoice_extras__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice_extras__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice_extras__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice_extras__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice_extras__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_show__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "no_show__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patients__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patients__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patients__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patients__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patients__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "related_shifts__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "related_shifts__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "related_shifts__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "related_shifts__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "related_shifts__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "related_shifts__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "related_shifts__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "related_shifts__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "related_shifts__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "related_shifts__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "related_shifts__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "request_hash__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "request_hash__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "request_hash__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "request_hash__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "request_hash__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "resources__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "resources__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "resources__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "start__eq", "schema": { "type": "string" }, "description": "eq filter on start" }, { "in": "query", "name": "start__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "start__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "start__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "start__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "start__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "start__neq", "schema": { "type": "string" }, "description": "neq filter on start" }, { "in": "query", "name": "start__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "start__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "start__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "telemedicine_room__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "telemedicine_room__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "telemedicine_room__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "telemedicine_room__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "telemedicine_room__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "type__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "type__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "type__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "user__eq", "schema": { "type": "string" }, "description": "eq filter on user" }, { "in": "query", "name": "user__neq", "schema": { "type": "string" }, "description": "neq filter on user" } ], "tags": [ "Appointments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAppointmentDetailList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAppointmentDetailList" } } }, "description": "" } }, "summary": "List Appointment" }, "post": { "operationId": "appointment_create", "description": "Create new Appointment\n\nParameters:\n - allow_double_booking (bool) - If set to false, or not provided,\n creating double bookings will not be permitted.\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 500 requests per minute.", "parameters": [], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentCreate" } } }, "description": "" } }, "summary": "Create Appointment" } }, "/appointment/{parent_lookup_appointment}/multi_upload/": { "post": { "operationId": "appointment_multi_upload_create", "description": "Upload multiple files to Appointment\n\nMaximum of five (5) files can be uploaded in a single request.\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_appointment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentMultiUploadRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentMultiUploadRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentMultiUploadRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentMultiUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentMultiUpload" } } }, "description": "" } }, "summary": "Create Appointment Multi Upload" } }, "/appointment/{parent_lookup_appointment}/upload/": { "get": { "operationId": "appointment_upload_list", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_appointment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Appointments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAppointmentUploadList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAppointmentUploadList" } } }, "description": "" } }, "summary": "List Appointment Upload" }, "post": { "operationId": "appointment_upload_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_appointment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentUploadRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentUpload" } } }, "description": "" } }, "summary": "Create Appointment Upload" } }, "/appointment/{parent_lookup_appointment}/upload/{id}/": { "get": { "operationId": "appointment_upload_retrieve", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this upload.", "required": true }, { "in": "path", "name": "parent_lookup_appointment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Appointments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentUpload" } } }, "description": "" } }, "summary": "Get Appointment Upload" }, "delete": { "operationId": "appointment_upload_destroy", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this upload.", "required": true }, { "in": "path", "name": "parent_lookup_appointment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Appointments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Appointment Upload" } }, "/appointment/{id}/": { "get": { "operationId": "appointment_retrieve", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 900 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Appointments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentDetail" } } }, "description": "" } }, "summary": "Get Appointment" }, "put": { "operationId": "appointment_update", "description": "Update Appointment\n\nParameters:\n - allow_double_booking (bool) - If set to false, or not provided,\n creating double bookings will not be permitted.\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 500 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } } }, "description": "" } }, "summary": "Update Appointment" }, "patch": { "operationId": "appointment_partial_update", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 500 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAppointmentCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAppointmentCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAppointmentCreateUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } } }, "description": "" } }, "summary": "Patch Appointment" } }, "/appointment/{id}/admit/": { "post": { "operationId": "appointment_admit_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmitConsultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AdmitConsultation" } } }, "description": "" } }, "summary": "Create Appointment Admit" } }, "/appointment/{id}/cancel_appointment/": { "post": { "operationId": "appointment_cancel_appointment_create", "description": "Cancel an appointment\n\nParameters:\n - external (bool) - Requires the cancellation reason to be\n set as external and \"Allow client to cancel appointment\"\n department setting to be enabled.\n - cancellation_reason (int) - Id for the cancellation reason\n - cancellation_reason_text (str)\n - send_cancellation_email (bool) - Send cancellation\n confirmation email. If `external` is `true`, the email will\n be sent to both the clinic and the client. If `false` or not\n provided, email will be sent to the client only.\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } } }, "description": "" } }, "summary": "Create Appointment Cancel Appointment" } }, "/appointment/{id}/create_advance_payment/": { "post": { "operationId": "appointment_create_advance_payment_create", "description": "Create advance payment\n\nCreate invoice if Appointment's complaint type that has \"advance payment item\"\nlinked to it.\nParameters:\n - request_hash (str)\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } } }, "description": "" } }, "summary": "Create Appointment Create Advance Payment" } }, "/appointment/{id}/create_telemedicine_room/": { "post": { "operationId": "appointment_create_telemedicine_room_create", "description": "Create telemedicine room\n\nCreate telemedicine room for the Appointment.\n\nParameters:\n - request_hash (str)\n - dont_send_email_confirmation (any) - If given, does not send email\n - dont_send_sms_confirmation (any) - If given, does not send SMS\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } } }, "description": "" } }, "summary": "Create Appointment Create Telemedicine Room" } }, "/appointment/{id}/send_appointment_confirmation/": { "post": { "operationId": "appointment_send_appointment_confirmation_create", "description": "Send Appointment confirmation\n\nSend Appointment confirmation for client. Requires Appointment to have client set\nand [request_hash] value received when creating Appointment.\n\nWhen sending confirmations for online booking appointments, a client and patient\nmust first be created via the /onlinebookingclient/ and /onlinebookingpatient/\nendpoints.\n\nParameters:\n - request_hash (str)\n - dont_send_email_confirmation (any) - If given, does not send email\n - dont_send_sms_confirmation (any) - If given, does not send SMS\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Appointments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentCreateUpdate" } } }, "description": "" } }, "summary": "Create Appointment Send Appointment Confirmation" } }, "/appointment/check_conflicts/": { "get": { "operationId": "appointment_check_conflicts_list", "description": "Check appointment overlap and shift coverage for a proposed slot.\n\nToken-authenticated REST equivalent of the legacy web-calendar conflict\ncheck at /personnel/appointments/check_conflicts/. Returns the same\nwarning set: overlapping appointments, time outside veterinarian's or\nresource's shift, unbookable shift, slot length mismatch, and the\nmismatching-reason flag.\n\nQuery parameters:\n\n- start (required): ISO 8601 start datetime of the proposed appointment.\n- end (required): ISO 8601 end datetime of the proposed appointment.\n Must be strictly after start.\n- user_ids: Veterinarian user id (e.g. user_ids=1) or a comma-separated\n list of ids (e.g. user_ids=1,2,3). Used for shift coverage and\n per-user overlap checks.\n- resource_ids: Resource id or a comma-separated list of ids. Same\n shape as user_ids. Used for shift coverage and per-resource overlap\n checks.\n- complaint_type: Complaint type id; enables the shift-type reason\n warning when the department setting is on.\n- appointment: Id of the appointment being edited; excluded from the\n overlap calculation. Omit when checking for a brand-new appointment.\n\nAt least one of user_ids or resource_ids must be provided — the\nendpoint returns HTTP 400 otherwise (an empty scope would always\nreturn \"ok\" without checking anything meaningful).\n\nResponse shape:\n\n- status: \"ok\" when no warnings, otherwise \"error\".\n- errors: List of warning objects. Each has status, message, and\n (usually) details. Status values, as defined:\n \"overlapping\", \"outside shift\", \"unbookable shift\",\n \"prevent_scheduling\".\n- shift_ids: List of shift ids relevant to the slot.\n- mismatching_reason_warning: Boolean. True when the selected complaint\n type does not match the shift's allowed complaint types.\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "appointment", "schema": { "type": "integer" }, "description": "Id of the appointment being edited; excluded from overlap." }, { "in": "query", "name": "complaint_type", "schema": { "type": "integer" }, "description": "Complaint type id used for the shift-type reason warning." }, { "in": "query", "name": "end", "schema": { "type": "string" }, "description": "ISO 8601 end datetime of the proposed appointment.", "required": true }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "resource_ids", "schema": { "type": "string" }, "description": "Resource id, or comma-separated list of ids (e.g. resource_ids=1 or resource_ids=1,2,3). At least one of user_ids or resource_ids is required." }, { "in": "query", "name": "start", "schema": { "type": "string" }, "description": "ISO 8601 start datetime of the proposed appointment.", "required": true }, { "in": "query", "name": "user_ids", "schema": { "type": "string" }, "description": "Veterinarian user id, or comma-separated list of ids (e.g. user_ids=1 or user_ids=1,2,3). At least one of user_ids or resource_ids is required." } ], "tags": [ "Appointments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAppointmentCheckConflictsQueryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAppointmentCheckConflictsQueryList" } } }, "description": "" } }, "summary": "List Appointment Check Conflicts" } }, "/appointment/combined/": { "get": { "operationId": "appointment_combined_retrieve", "description": "Combined endpoint for fetching appointments by email and/or phone\n\nThis endpoint is accessed at /appointment/combined/?email=test@example.com\n&cutoff_date=2025-10-01 or /appointment/combined/?phone=+1234567890\n&cutoff_date=2025-10-01\nReturns all appointments for clients/onlinebookingclients matching the\nemail and/or phone. At least one of email or phone is required.\n\nWhen both email and phone are provided, both must match the same\nclient/onlinebookingclient (AND logic).\n\nThere's three cases:\n- a) client, who booked with a patient (existing pet)\n- b) client, who booked with an onlinebookingpatient (new pet)\n- c) onlinebookingclient, who booked with an onlinebookingpatient\n\nFor online-booking, if auto-matching is enabled, the appointment might\nhave both client and onlinebookingclient. However, client.email might be different\nthan onlinebookingclient.email. Therefore we need to search with both.\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Appointments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CombinedAppointment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CombinedAppointment" } } }, "description": "" } }, "summary": "Get Appointment Combined" } }, "/appointment_reminder/": { "get": { "operationId": "appointment_reminder_list", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "scheduling_event__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "scheduling_event__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "scheduling_event__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "scheduling_event__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "scheduling_event__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "send_datetime__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "send_datetime__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "send_datetime__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "send_datetime__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "send_datetime__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "send_datetime__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "send_datetime__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "send_datetime__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "sent_datetime__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "sent_datetime__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "sent_datetime__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "sent_datetime__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "sent_datetime__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "sent_datetime__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "sent_datetime__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "sent_datetime__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "sent_datetime__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "type_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type_code__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "type_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Appointment reminders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAppointmentReminderList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAppointmentReminderList" } } }, "description": "" } }, "summary": "List Appointment Reminder" }, "post": { "operationId": "appointment_reminder_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Appointment reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentReminderCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentReminderCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentReminderCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentReminderCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentReminderCreate" } } }, "description": "" } }, "summary": "Create Appointment Reminder" } }, "/appointment_reminder/{id}/": { "get": { "operationId": "appointment_reminder_retrieve", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment reminder.", "required": true } ], "tags": [ "Appointment reminders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetail" } } }, "description": "" } }, "summary": "Get Appointment Reminder" }, "put": { "operationId": "appointment_reminder_update", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment reminder.", "required": true } ], "tags": [ "Appointment reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetailRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetail" } } }, "description": "" } }, "summary": "Update Appointment Reminder" }, "patch": { "operationId": "appointment_reminder_partial_update", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment reminder.", "required": true } ], "tags": [ "Appointment reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAppointmentReminderDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAppointmentReminderDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAppointmentReminderDetailRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentReminderDetail" } } }, "description": "" } }, "summary": "Patch Appointment Reminder" } }, "/appointment_reminder/{id}/mark_external_sending/": { "post": { "operationId": "appointment_reminder_mark_external_sending_create", "description": "Mark external sending for this appointment reminder\n\nAppointment reminder sending will not be triggered from Provet if set,\ninstead external system is doing the sending and should use /mark_sent/ endpoint\nafter sending is done.\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment reminder.", "required": true } ], "tags": [ "Appointment reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentReminderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AppointmentReminderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AppointmentReminderRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentReminder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AppointmentReminder" } } }, "description": "" } }, "summary": "Create Appointment Reminder Mark External Sending" } }, "/appointment_reminder/{id}/mark_sent/": { "put": { "operationId": "appointment_reminder_mark_sent_update", "description": "Mark an Appointment Reminder sent\n\nThe reminder must not have been marked as sent before for this to work.\n\nParameters:\n - sms_text_sent (string): Text of sent SMS message\n\nRequired permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment reminder.", "required": true } ], "tags": [ "Appointment reminders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update Appointment Reminder Mark Sent" } }, "/archive_import_job/": { "get": { "operationId": "archive_import_job_list", "description": "Archive Import Job API.\n\nProvides read-only access to import job history and status.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled (same as archived invoice endpoints). Returns 501 when not enabled.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "archive_import_job" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedArchiveImportJobList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedArchiveImportJobList" } } }, "description": "" } }, "summary": "List Archive Import Job" } }, "/archive_import_job/{id}/": { "get": { "operationId": "archive_import_job_retrieve", "description": "Archive Import Job API.\n\nProvides read-only access to import job history and status.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled (same as archived invoice endpoints). Returns 501 when not enabled.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Archive Import Job.", "required": true } ], "tags": [ "archive_import_job" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveImportJob" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ArchiveImportJob" } } }, "description": "" } }, "summary": "Get Archive Import Job" } }, "/archived_invoice/": { "get": { "operationId": "archived_invoice_list", "description": "Archived Invoice API.\n\nProvides endpoints for managing archived invoices imported from external PMS systems.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled for the organization. When not enabled, returns 501 Not Implemented.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "client", "schema": { "type": "integer" } }, { "in": "query", "name": "department", "schema": { "type": "integer" } }, { "in": "query", "name": "invoice_date_from", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "invoice_date_to", "schema": { "type": "string", "format": "date" } }, { "in": "query", "name": "is_countersale", "schema": { "type": "boolean" } }, { "in": "query", "name": "is_credit_note", "schema": { "type": "boolean" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patients", "schema": { "type": "array", "items": { "type": "integer" } }, "explode": true, "style": "form" }, { "in": "query", "name": "patients__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "source", "schema": { "type": "string" } }, { "in": "query", "name": "source__in", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "source_invoice_number", "schema": { "type": "string" } }, { "in": "query", "name": "source_invoice_number__icontains", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string", "enum": [ "CANCELLED", "DRAFT", "FINALIZED", "OVERPAID", "PAID", "PARTIALLY_PAID" ] }, "description": "* `DRAFT` - Draft\n* `FINALIZED` - Finalized\n* `PAID` - Paid\n* `PARTIALLY_PAID` - Partially Paid\n* `OVERPAID` - Overpaid\n* `CANCELLED` - Cancelled" }, { "in": "query", "name": "status__in", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" } ], "tags": [ "archived_invoice" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedArchivedInvoiceReadList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedArchivedInvoiceReadList" } } }, "description": "" } }, "summary": "List Archived Invoice" }, "post": { "operationId": "archived_invoice_create", "description": "Create an archived invoice (async).\n\nValidates the request, creates an import job (RUNNING), enqueues processing,\nand returns 202 with the job. Poll GET /archive_import_job// for status.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "archived_invoice" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceWriteRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceWriteRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceWriteRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceWrite" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceWrite" } } }, "description": "" } }, "summary": "Create Archived Invoice" } }, "/archived_invoice/{id}/": { "get": { "operationId": "archived_invoice_retrieve", "description": "Archived Invoice API.\n\nProvides endpoints for managing archived invoices imported from external PMS systems.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled for the organization. When not enabled, returns 501 Not Implemented.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Archived Invoice.", "required": true } ], "tags": [ "archived_invoice" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceRead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceRead" } } }, "description": "" } }, "summary": "Get Archived Invoice" }, "put": { "operationId": "archived_invoice_update", "description": "Archived Invoice API.\n\nProvides endpoints for managing archived invoices imported from external PMS systems.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled for the organization. When not enabled, returns 501 Not Implemented.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Archived Invoice.", "required": true } ], "tags": [ "archived_invoice" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceUpdate" } } }, "description": "" } }, "summary": "Update Archived Invoice" }, "patch": { "operationId": "archived_invoice_partial_update", "description": "Archived Invoice API.\n\nProvides endpoints for managing archived invoices imported from external PMS systems.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled for the organization. When not enabled, returns 501 Not Implemented.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Archived Invoice.", "required": true } ], "tags": [ "archived_invoice" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedArchivedInvoiceUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedArchivedInvoiceUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedArchivedInvoiceUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceUpdate" } } }, "description": "" } }, "summary": "Patch Archived Invoice" } }, "/archived_invoice/{id}/attachments/": { "post": { "operationId": "archived_invoice_attachments_create", "description": "Return S3 pre-signed POST data for uploading attachments to this archived invoice.\n\nBody: {\"attachments\": [\"file1.pdf\", \"file2.pdf\"]} (max 5, no path traversal).\nClient uploads to the returned URL with the given fields; S3 event creates Upload\nand links to this invoice via attachment/tasks.py.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Archived Invoice.", "required": true } ], "tags": [ "archived_invoice" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceReadRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceReadRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceReadRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceRead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceRead" } } }, "description": "" } }, "summary": "Create Archived Invoice Attachments" } }, "/archived_invoice/bulk-import/": { "post": { "operationId": "archived_invoice_bulk_import_create", "description": "Bulk import multiple archived invoices (async).\n\nValidates the request, creates an import job (RUNNING), enqueues processing,\nand returns 202 with the job. Poll GET /archive_import_job// for status.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "archived_invoice" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportRequestRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BulkImportRequestRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BulkImportRequestRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkImportRequest" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BulkImportRequest" } } }, "description": "" } }, "summary": "Create Archived Invoice Bulk Import" } }, "/archived_invoice_row/": { "get": { "operationId": "archived_invoice_row_list", "description": "Archived Invoice Row API.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled (same as archived invoice endpoints). Returns 501 when not enabled.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "archived_invoice_row" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedArchivedInvoiceRowReadList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedArchivedInvoiceRowReadList" } } }, "description": "" } }, "summary": "List Archived Invoice Row" } }, "/archived_invoice_row/{id}/": { "get": { "operationId": "archived_invoice_row_retrieve", "description": "Archived Invoice Row API.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled (same as archived invoice endpoints). Returns 501 when not enabled.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Archived Invoice Row.", "required": true } ], "tags": [ "archived_invoice_row" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceRowRead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ArchivedInvoiceRowRead" } } }, "description": "" } }, "summary": "Get Archived Invoice Row" } }, "/archived_payment/": { "get": { "operationId": "archived_payment_list", "description": "Archived Payment API.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled (same as archived invoice endpoints). Returns 501 when not enabled.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "archived_payment" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedArchivedPaymentReadList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedArchivedPaymentReadList" } } }, "description": "" } }, "summary": "List Archived Payment" } }, "/archived_payment/{id}/": { "get": { "operationId": "archived_payment_retrieve", "description": "Archived Payment API.\n\n**Feature flag:** Requires the archived invoices feature to be explicitly\nenabled (same as archived invoice endpoints). Returns 501 when not enabled.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Archived Payment.", "required": true } ], "tags": [ "archived_payment" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivedPaymentRead" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ArchivedPaymentRead" } } }, "description": "" } }, "summary": "Get Archived Payment" } }, "/available_wholesaler/": { "get": { "operationId": "available_wholesaler_list", "description": "Available wholesalers.\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "email__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "email__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "email__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "email__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "email__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "email__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "email__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "email__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "register_number__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "register_number__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "register_number__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "register_number__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "register_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "register_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "register_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "register_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Wholesaler API" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedAvailableWholesalerList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedAvailableWholesalerList" } } }, "description": "" } }, "summary": "List Available Wholesaler" }, "post": { "operationId": "available_wholesaler_create", "description": "Available wholesalers.\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableWholesalerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AvailableWholesalerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AvailableWholesalerRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableWholesaler" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AvailableWholesaler" } } }, "description": "" } }, "summary": "Create Available Wholesaler" } }, "/available_wholesaler/{id}/": { "get": { "operationId": "available_wholesaler_retrieve", "description": "Available wholesalers.\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this available wholesaler.", "required": true } ], "tags": [ "Wholesaler API" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableWholesaler" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AvailableWholesaler" } } }, "description": "" } }, "summary": "Get Available Wholesaler" }, "put": { "operationId": "available_wholesaler_update", "description": "Available wholesalers.\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this available wholesaler.", "required": true } ], "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableWholesalerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AvailableWholesalerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AvailableWholesalerRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableWholesaler" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AvailableWholesaler" } } }, "description": "" } }, "summary": "Update Available Wholesaler" }, "patch": { "operationId": "available_wholesaler_partial_update", "description": "Available wholesalers.\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this available wholesaler.", "required": true } ], "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAvailableWholesalerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAvailableWholesalerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAvailableWholesalerRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableWholesaler" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AvailableWholesaler" } } }, "description": "" } }, "summary": "Patch Available Wholesaler" }, "delete": { "operationId": "available_wholesaler_destroy", "description": "Available wholesalers.\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this available wholesaler.", "required": true } ], "tags": [ "Wholesaler API" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Available Wholesaler" } }, "/cancellationreason/": { "get": { "operationId": "cancellationreason_list", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Cancellation reasons" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCancellationReasonList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCancellationReasonList" } } }, "description": "" } }, "summary": "List Cancellationreason" }, "post": { "operationId": "cancellationreason_create", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Cancellation reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationReasonRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CancellationReasonRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CancellationReasonRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationReason" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CancellationReason" } } }, "description": "" } }, "summary": "Create Cancellationreason" } }, "/cancellationreason/{id}/": { "get": { "operationId": "cancellationreason_retrieve", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cancellation reason.", "required": true } ], "tags": [ "Cancellation reasons" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationReason" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CancellationReason" } } }, "description": "" } }, "summary": "Get Cancellationreason" }, "put": { "operationId": "cancellationreason_update", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cancellation reason.", "required": true } ], "tags": [ "Cancellation reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationReasonRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CancellationReasonRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CancellationReasonRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationReason" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CancellationReason" } } }, "description": "" } }, "summary": "Update Cancellationreason" }, "patch": { "operationId": "cancellationreason_partial_update", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cancellation reason.", "required": true } ], "tags": [ "Cancellation reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCancellationReasonRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCancellationReasonRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCancellationReasonRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancellationReason" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CancellationReason" } } }, "description": "" } }, "summary": "Patch Cancellationreason" }, "delete": { "operationId": "cancellationreason_destroy", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cancellation reason.", "required": true } ], "tags": [ "Cancellation reasons" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Cancellationreason" } }, "/cashbookentry/": { "get": { "operationId": "cashbookentry_list", "description": "Cash book entries (Kassenbewegung).\n\nRead-only mirror of the JSON:API ``cash_book_entries`` resource,\nused by the EFSTA tentacle to fetch entry details when signing a\nKassenbewegung under KassenSichV. Writes go through the JSON:API\nviewset (``CashBookEntryViewSet`` at ``cashregister/api/views.py``).\n\nRequired permissions:\n- Financial: End of day and accounting reports\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "cash_register__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "cash_register__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "cash_register__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "cash_register__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "cash_register__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "timestamp__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "timestamp__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "timestamp__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "timestamp__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "timestamp__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "timestamp__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "timestamp__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "timestamp__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "cashbookentry" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCashBookEntryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCashBookEntryList" } } }, "description": "" } }, "summary": "List Cashbookentry" } }, "/cashbookentry/{id}/": { "get": { "operationId": "cashbookentry_retrieve", "description": "Cash book entries (Kassenbewegung).\n\nRead-only mirror of the JSON:API ``cash_book_entries`` resource,\nused by the EFSTA tentacle to fetch entry details when signing a\nKassenbewegung under KassenSichV. Writes go through the JSON:API\nviewset (``CashBookEntryViewSet`` at ``cashregister/api/views.py``).\n\nRequired permissions:\n- Financial: End of day and accounting reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Cash Book Entry.", "required": true } ], "tags": [ "cashbookentry" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashBookEntry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CashBookEntry" } } }, "description": "" } }, "summary": "Get Cashbookentry" } }, "/client/": { "get": { "operationId": "client_list", "description": "List all clients with optional filtering.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 125 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "email__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "email__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "email__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "email__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "email__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "email__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "email__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "email__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "farm_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "farm_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "farm_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "farm_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "farm_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "farm_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "farm_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "farm_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "filter_type", "schema": { "type": "string", "enum": [ "or" ] }, "description": "Set to 'or' to combine firstname__icontains, lastname__icontains, and organization_name__icontains filters with OR logic" }, { "in": "query", "name": "firstname__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "firstname__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "firstname__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "firstname__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "firstname__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "firstname__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "firstname__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "firstname__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "has_alive_patients__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "has_alive_patients__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "home_department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "home_department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "home_department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "lastname__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "lastname__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "lastname__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "lastname__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "lastname__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "lastname__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "lastname__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "lastname__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "old_client_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "old_client_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "old_client_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "old_client_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "old_client_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "in": "query", "name": "organization_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "organization_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "organization_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "organization_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "organization_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "organization_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "organization_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "organization_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "phonenumbers__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "phonenumbers__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "phonenumbers__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "phonenumbers__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "phonenumbers__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "phonenumbers__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "phonenumbers__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "phonenumbers__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "phonenumbers__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "secondary_owner_first_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "secondary_owner_first_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "secondary_owner_first_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "secondary_owner_first_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "secondary_owner_first_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "secondary_owner_first_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "secondary_owner_first_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "secondary_owner_first_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "secondary_owner_last_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "secondary_owner_last_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "secondary_owner_last_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "secondary_owner_last_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "secondary_owner_last_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "secondary_owner_last_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "secondary_owner_last_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "secondary_owner_last_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "street_address_2__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "street_address_2__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "street_address_2__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "street_address_2__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "street_address_2__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "street_address_2__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "street_address_2__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "street_address_2__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "street_address_3__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "street_address_3__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "street_address_3__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "street_address_3__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "street_address_3__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "street_address_3__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "street_address_3__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "street_address_3__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "street_address__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "street_address__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "street_address__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "street_address__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "street_address__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "street_address__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "street_address__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "street_address__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "zip_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "zip_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "zip_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "zip_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "zip_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "zip_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "zip_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "zip_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Clients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedClientList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedClientList" } } }, "description": "" } }, "summary": "List Client" }, "post": { "operationId": "client_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Clients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ClientRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Client" } } }, "description": "" } }, "summary": "Create Client" } }, "/client/{parent_lookup_client}/custom_field_values/": { "get": { "operationId": "client_custom_field_values_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_client", "schema": { "type": "string" }, "required": true } ], "tags": [ "Clients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldValueList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldValueList" } } }, "description": "" } }, "summary": "List Client Custom Field Values" }, "post": { "operationId": "client_custom_field_values_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_client", "schema": { "type": "string" }, "required": true } ], "tags": [ "Clients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } } }, "description": "" } }, "summary": "Create Client Custom Field Values" } }, "/client/{parent_lookup_client}/custom_field_values/{id}/": { "get": { "operationId": "client_custom_field_values_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true }, { "in": "path", "name": "parent_lookup_client", "schema": { "type": "string" }, "required": true } ], "tags": [ "Clients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } } }, "description": "" } }, "summary": "Get Client Custom Field Values" }, "put": { "operationId": "client_custom_field_values_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true }, { "in": "path", "name": "parent_lookup_client", "schema": { "type": "string" }, "required": true } ], "tags": [ "Clients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } } }, "description": "" } }, "summary": "Update Client Custom Field Values" }, "patch": { "operationId": "client_custom_field_values_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true }, { "in": "path", "name": "parent_lookup_client", "schema": { "type": "string" }, "required": true } ], "tags": [ "Clients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } } }, "description": "" } }, "summary": "Patch Client Custom Field Values" }, "delete": { "operationId": "client_custom_field_values_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true }, { "in": "path", "name": "parent_lookup_client", "schema": { "type": "string" }, "required": true } ], "tags": [ "Clients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Client Custom Field Values" } }, "/client/{id}/": { "get": { "operationId": "client_retrieve", "description": "Retrieve a single client by ID.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 500 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client.", "required": true } ], "tags": [ "Clients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Client" } } }, "description": "" } }, "summary": "Get Client" }, "put": { "operationId": "client_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 200 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client.", "required": true } ], "tags": [ "Clients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ClientRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Client" } } }, "description": "" } }, "summary": "Update Client" }, "patch": { "operationId": "client_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 200 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client.", "required": true } ], "tags": [ "Clients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedClientRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedClientRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedClientRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Client" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Client" } } }, "description": "" } }, "summary": "Patch Client" }, "delete": { "operationId": "client_destroy", "description": "Archives an item.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client.", "required": true } ], "tags": [ "Clients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Client" } }, "/client_communication_preference_row/": { "get": { "operationId": "client_communication_preference_row_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Client communication preference rows" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedClientCommunicationPreferenceRowList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedClientCommunicationPreferenceRowList" } } }, "description": "" } }, "summary": "List Client Communication Preference Row" }, "post": { "operationId": "client_communication_preference_row_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Client communication preference rows" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRowRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } } }, "description": "" } }, "summary": "Create Client Communication Preference Row" } }, "/client_communication_preference_row/{id}/": { "get": { "operationId": "client_communication_preference_row_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client communication preference row.", "required": true } ], "tags": [ "Client communication preference rows" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } } }, "description": "" } }, "summary": "Get Client Communication Preference Row" }, "put": { "operationId": "client_communication_preference_row_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client communication preference row.", "required": true } ], "tags": [ "Client communication preference rows" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRowRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } } }, "description": "" } }, "summary": "Update Client Communication Preference Row" }, "patch": { "operationId": "client_communication_preference_row_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client communication preference row.", "required": true } ], "tags": [ "Client communication preference rows" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedClientCommunicationPreferenceRowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedClientCommunicationPreferenceRowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedClientCommunicationPreferenceRowRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } } }, "description": "" } }, "summary": "Patch Client Communication Preference Row" }, "delete": { "operationId": "client_communication_preference_row_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client communication preference row.", "required": true } ], "tags": [ "Client communication preference rows" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Client Communication Preference Row" } }, "/client_communication_preferences/": { "get": { "operationId": "client_communication_preferences_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Client communication preferences" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedClientCommunicationPreferencesList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedClientCommunicationPreferencesList" } } }, "description": "" } }, "summary": "List Client Communication Preferences" }, "post": { "operationId": "client_communication_preferences_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Client communication preferences" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferencesRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferencesRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferencesRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } } }, "description": "" } }, "summary": "Create Client Communication Preferences" } }, "/client_communication_preferences/{id}/": { "get": { "operationId": "client_communication_preferences_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client communication preferences.", "required": true } ], "tags": [ "Client communication preferences" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } } }, "description": "" } }, "summary": "Get Client Communication Preferences" }, "put": { "operationId": "client_communication_preferences_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client communication preferences.", "required": true } ], "tags": [ "Client communication preferences" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferencesRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferencesRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferencesRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } } }, "description": "" } }, "summary": "Update Client Communication Preferences" }, "patch": { "operationId": "client_communication_preferences_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client communication preferences.", "required": true } ], "tags": [ "Client communication preferences" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedClientCommunicationPreferencesRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedClientCommunicationPreferencesRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedClientCommunicationPreferencesRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } } }, "description": "" } }, "summary": "Patch Client Communication Preferences" }, "delete": { "operationId": "client_communication_preferences_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this client communication preferences.", "required": true } ], "tags": [ "Client communication preferences" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Client Communication Preferences" } }, "/client_export/": { "post": { "operationId": "client_export_create", "description": "Bulk client export for the patient-portal client index.\n\nTriggers a background export of ``(client_id, email, alt_emails)`` to S3\nand exposes manifest-based status polling with a presigned download URL.\nNo DB model: the caller keeps the returned ``export_id`` and polls it;\nterminal state lives in the S3 manifest (its absence means the export is\nstill running).\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "client_export" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientExportTriggerResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientExportTriggerResponse" } } }, "description": "" } }, "summary": "Create Client Export" } }, "/client_export/{id}/": { "get": { "operationId": "client_export_retrieve", "description": "Bulk client export for the patient-portal client index.\n\nTriggers a background export of ``(client_id, email, alt_emails)`` to S3\nand exposes manifest-based status polling with a presigned download URL.\nNo DB model: the caller keeps the returned ``export_id`` and polls it;\nterminal state lives in the S3 manifest (its absence means the export is\nstill running).\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "client_export" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientExportStatusResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientExportStatusResponse" } } }, "description": "" } }, "summary": "Get Client Export" } }, "/cloud_printer/": { "get": { "operationId": "cloud_printer_list", "description": "Required permissions:\n- Settings: Print settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "apitype__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "apitype__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "apitype__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "apitype__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "apitype__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "apitype__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "apitype__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "apitype__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "apitype__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "apitype__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "label__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "label__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "label__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "label__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "label__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "label__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "label__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "label__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "cloud_printer" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCloudPrinterList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCloudPrinterList" } } }, "description": "" } }, "summary": "List Cloud Printer" } }, "/cloud_printer/{id}/": { "get": { "operationId": "cloud_printer_retrieve", "description": "Required permissions:\n- Settings: Print settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this printer.", "required": true } ], "tags": [ "cloud_printer" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudPrinter" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CloudPrinter" } } }, "description": "" } }, "summary": "Get Cloud Printer" } }, "/codelist/breeds/": { "get": { "operationId": "codelist_breeds_retrieve", "description": "Breed Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Codelist Breeds" } }, "/codelist/breeds/{id}/": { "get": { "operationId": "codelist_breeds_retrieve_2", "description": "Breed Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Codelist Breeds" }, "patch": { "operationId": "codelist_breeds_partial_update", "description": "Breed Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch Codelist Breeds" } }, "/codelist/diagnoses/": { "get": { "operationId": "codelist_diagnoses_retrieve", "description": "Diagnosis Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Codelist Diagnoses" } }, "/codelist/diagnoses/{id}/": { "get": { "operationId": "codelist_diagnoses_retrieve_2", "description": "Diagnosis Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Codelist Diagnoses" }, "patch": { "operationId": "codelist_diagnoses_partial_update", "description": "Diagnosis Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch Codelist Diagnoses" } }, "/codelist/insurancecompanies/": { "get": { "operationId": "codelist_insurancecompanies_retrieve", "description": "Insurance Company\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Codelist Insurancecompanies" } }, "/codelist/insurancecompanies/{id}/": { "get": { "operationId": "codelist_insurancecompanies_retrieve_2", "description": "Insurance Company\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Codelist Insurancecompanies" }, "patch": { "operationId": "codelist_insurancecompanies_partial_update", "description": "Insurance Company\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch Codelist Insurancecompanies" } }, "/codelist/species/": { "get": { "operationId": "codelist_species_retrieve", "description": "Species Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Codelist Species" } }, "/codelist/species/{id}/": { "get": { "operationId": "codelist_species_retrieve_2", "description": "Species Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Codelist Species" }, "patch": { "operationId": "codelist_species_partial_update", "description": "Species Codes\n\nThis view does not require permissions because code list items are usually not secret.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Codelists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch Codelist Species" } }, "/communication_preference_row/": { "get": { "operationId": "communication_preference_row_list", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Communication preference rows" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCommunicationPreferenceRowList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCommunicationPreferenceRowList" } } }, "description": "" } }, "summary": "List Communication Preference Row" }, "post": { "operationId": "communication_preference_row_create", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Communication preference rows" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRowRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } } }, "description": "" } }, "summary": "Create Communication Preference Row" } }, "/communication_preference_row/{id}/": { "get": { "operationId": "communication_preference_row_retrieve", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this communication preference row.", "required": true } ], "tags": [ "Communication preference rows" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } } }, "description": "" } }, "summary": "Get Communication Preference Row" }, "put": { "operationId": "communication_preference_row_update", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this communication preference row.", "required": true } ], "tags": [ "Communication preference rows" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRowRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } } }, "description": "" } }, "summary": "Update Communication Preference Row" }, "patch": { "operationId": "communication_preference_row_partial_update", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this communication preference row.", "required": true } ], "tags": [ "Communication preference rows" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCommunicationPreferenceRowRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCommunicationPreferenceRowRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCommunicationPreferenceRowRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } } }, "description": "" } }, "summary": "Patch Communication Preference Row" }, "delete": { "operationId": "communication_preference_row_destroy", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this communication preference row.", "required": true } ], "tags": [ "Communication preference rows" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Communication Preference Row" } }, "/conditional_price_item_override/": { "get": { "operationId": "conditional_price_item_override_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "conditional_price_item_override" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemConditionalPriceOverrideList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemConditionalPriceOverrideList" } } }, "description": "" } }, "summary": "List Conditional Price Item Override" }, "post": { "operationId": "conditional_price_item_override_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "conditional_price_item_override" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemConditionalPriceOverrideRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemConditionalPriceOverrideRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemConditionalPriceOverrideRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemConditionalPriceOverride" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemConditionalPriceOverride" } } }, "description": "" } }, "summary": "Create Conditional Price Item Override" } }, "/conditional_price_item_override/{id}/": { "get": { "operationId": "conditional_price_item_override_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item conditional price override.", "required": true } ], "tags": [ "conditional_price_item_override" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemConditionalPriceOverride" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemConditionalPriceOverride" } } }, "description": "" } }, "summary": "Get Conditional Price Item Override" }, "delete": { "operationId": "conditional_price_item_override_destroy", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item conditional price override.", "required": true } ], "tags": [ "conditional_price_item_override" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Conditional Price Item Override" } }, "/consultation/": { "get": { "operationId": "consultation_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "admitted_time__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "admitted_time__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "admitted_time__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "admitted_time__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "admitted_time__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "admitted_time__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "complaint__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "complaint__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "complaint__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "complaint__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "complaint__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "complaint__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "complaint__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "complaint__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation_diagnosis__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "consultation_diagnosis__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "consultation_diagnosis__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "consultation_diagnosis__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "consultation_diagnosis__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "consultation_diagnosis__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "consultation_diagnosis__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_diagnosis__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_diagnosis__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_diagnosis__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "consultation_diagnosis__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "consultation_diagnosis__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation_diagnosis__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "consultation_diagnosis__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "consultation_extras__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "consultation_extras__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "consultation_extras__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "consultation_extras__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "consultation_extras__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "consultation_extras__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "consultation_extras__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_extras__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_extras__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_extras__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation_extras__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "consultation_extras__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "consultation_extras__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation_extras__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "consultation_extras__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "custom_fields__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "custom_fields__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "custom_fields__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "custom_fields__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "custom_fields__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "ended__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "ended__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "ended__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "ended__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "ended__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "ended__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "external_sent__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "external_sent__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "external_sent__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_sent__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_sent__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "external_sent__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "external_sent__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "integration_status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "integration_status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "integration_status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "integration_status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "integration_status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "integration_status__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "integration_status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "integration_status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "integration_status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "integration_status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "integration_status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patients__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patients__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patients__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patients__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "report_to_authorities__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "report_to_authorities__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "started__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "started__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "started__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "started__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "started__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "started__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "supervising_veterinarian__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "supervising_veterinarian__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "supervising_veterinarian__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "supervising_veterinarian__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationList" } } }, "description": "" } }, "summary": "List Consultation" }, "post": { "operationId": "consultation_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationCreate" } } }, "description": "" } }, "summary": "Create Consultation" } }, "/consultation/{parent_lookup_consultation}/analyses/": { "get": { "operationId": "consultation_analyses_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 150 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "referral__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "referral__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "referral__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "referral__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "referral__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationLaboratoryAnalysisList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationLaboratoryAnalysisList" } } }, "description": "" } }, "summary": "List Consultation Analyses" }, "post": { "operationId": "consultation_analyses_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } } }, "description": "" } }, "summary": "Create Consultation Analyses" } }, "/consultation/{parent_lookup_consultation}/analyses/{id}/": { "get": { "operationId": "consultation_analyses_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 600 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory analysis.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysis" } } }, "description": "" } }, "summary": "Get Consultation Analyses" }, "put": { "operationId": "consultation_analyses_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory analysis.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } } }, "description": "" } }, "summary": "Update Consultation Analyses" }, "patch": { "operationId": "consultation_analyses_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory analysis.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryAnalysisUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryAnalysisUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryAnalysisUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } } }, "description": "" } }, "summary": "Patch Consultation Analyses" }, "delete": { "operationId": "consultation_analyses_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory analysis.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Analyses" } }, "/consultation/{parent_lookup_consultation}/consultation_json_history/": { "get": { "operationId": "consultation_consultation_json_history_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Consultation Consultation Json History" } }, "/consultation/{parent_lookup_consultation}/consultationclinicalsign/": { "get": { "operationId": "consultation_consultationclinicalsign_list", "description": "Consultation Clinical Signs\n\nCategory values:\n- CLINICAL_SIGN_CATEGORY_PRIMARY = 0\n- CLINICAL_SIGN_CATEGORY_SECONDARY = 1\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedClinicalSignList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedClinicalSignList" } } }, "description": "" } }, "summary": "List Consultation Consultationclinicalsign" } }, "/consultation/{parent_lookup_consultation}/consultationclinicalsign/{id}/": { "get": { "operationId": "consultation_consultationclinicalsign_retrieve", "description": "Consultation Clinical Signs\n\nCategory values:\n- CLINICAL_SIGN_CATEGORY_PRIMARY = 0\n- CLINICAL_SIGN_CATEGORY_SECONDARY = 1\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation clinical sign.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClinicalSign" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClinicalSign" } } }, "description": "" } }, "summary": "Get Consultation Consultationclinicalsign" } }, "/consultation/{parent_lookup_consultation}/consultationdiagnosis/": { "get": { "operationId": "consultation_consultationdiagnosis_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDiagnosisList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDiagnosisList" } } }, "description": "" } }, "summary": "List Consultation Consultationdiagnosis" }, "post": { "operationId": "consultation_consultationdiagnosis_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosisRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiagnosisRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiagnosisRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Diagnosis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Diagnosis" } } }, "description": "" } }, "summary": "Create Consultation Consultationdiagnosis" } }, "/consultation/{parent_lookup_consultation}/consultationdiagnosis/{id}/": { "get": { "operationId": "consultation_consultationdiagnosis_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation diagnosis.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Diagnosis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Diagnosis" } } }, "description": "" } }, "summary": "Get Consultation Consultationdiagnosis" }, "put": { "operationId": "consultation_consultationdiagnosis_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation diagnosis.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosisRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiagnosisRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiagnosisRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Diagnosis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Diagnosis" } } }, "description": "" } }, "summary": "Update Consultation Consultationdiagnosis" }, "patch": { "operationId": "consultation_consultationdiagnosis_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation diagnosis.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosisRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosisRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosisRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Diagnosis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Diagnosis" } } }, "description": "" } }, "summary": "Patch Consultation Consultationdiagnosis" }, "delete": { "operationId": "consultation_consultationdiagnosis_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation diagnosis.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Consultationdiagnosis" } }, "/consultation/{parent_lookup_consultation}/consultationdischargeinstruction/": { "get": { "operationId": "consultation_consultationdischargeinstruction_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDischargeInstructionsList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDischargeInstructionsList" } } }, "description": "" } }, "summary": "List Consultation Consultationdischargeinstruction" }, "post": { "operationId": "consultation_consultationdischargeinstruction_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DischargeInstructionsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DischargeInstructionsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DischargeInstructionsRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DischargeInstructions" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DischargeInstructions" } } }, "description": "" } }, "summary": "Create Consultation Consultationdischargeinstruction" } }, "/consultation/{parent_lookup_consultation}/consultationdischargeinstruction/{id}/": { "get": { "operationId": "consultation_consultationdischargeinstruction_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation dischargeinstruction.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DischargeInstructions" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DischargeInstructions" } } }, "description": "" } }, "summary": "Get Consultation Consultationdischargeinstruction" }, "put": { "operationId": "consultation_consultationdischargeinstruction_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation dischargeinstruction.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DischargeInstructionsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DischargeInstructionsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DischargeInstructionsRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DischargeInstructions" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DischargeInstructions" } } }, "description": "" } }, "summary": "Update Consultation Consultationdischargeinstruction" }, "patch": { "operationId": "consultation_consultationdischargeinstruction_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation dischargeinstruction.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDischargeInstructionsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDischargeInstructionsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDischargeInstructionsRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DischargeInstructions" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DischargeInstructions" } } }, "description": "" } }, "summary": "Patch Consultation Consultationdischargeinstruction" }, "delete": { "operationId": "consultation_consultationdischargeinstruction_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation dischargeinstruction.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Consultationdischargeinstruction" } }, "/consultation/{parent_lookup_consultation}/consultationnote/": { "get": { "operationId": "consultation_consultationnote_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Consultation Consultationnote" }, "post": { "operationId": "consultation_consultationnote_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Consultation Consultationnote" } }, "/consultation/{parent_lookup_consultation}/consultationnote/{id}/": { "get": { "operationId": "consultation_consultationnote_retrieve_2", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation note.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Consultation Consultationnote" }, "put": { "operationId": "consultation_consultationnote_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation note.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update Consultation Consultationnote" }, "patch": { "operationId": "consultation_consultationnote_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation note.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch Consultation Consultationnote" }, "delete": { "operationId": "consultation_consultationnote_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation note.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Consultationnote" } }, "/consultation/{parent_lookup_consultation}/consultationpatientstatus/": { "get": { "operationId": "consultation_consultationpatientstatus_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientStatusList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientStatusList" } } }, "description": "" } }, "summary": "List Consultation Consultationpatientstatus" }, "post": { "operationId": "consultation_consultationpatientstatus_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientStatusRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientStatus" } } }, "description": "" } }, "summary": "Create Consultation Consultationpatientstatus" } }, "/consultation/{parent_lookup_consultation}/consultationpatientstatus/{id}/": { "get": { "operationId": "consultation_consultationpatientstatus_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation patient status.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientStatus" } } }, "description": "" } }, "summary": "Get Consultation Consultationpatientstatus" }, "put": { "operationId": "consultation_consultationpatientstatus_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation patient status.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientStatusRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientStatus" } } }, "description": "" } }, "summary": "Update Consultation Consultationpatientstatus" }, "patch": { "operationId": "consultation_consultationpatientstatus_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation patient status.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientStatusRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientStatus" } } }, "description": "" } }, "summary": "Patch Consultation Consultationpatientstatus" }, "delete": { "operationId": "consultation_consultationpatientstatus_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation patient status.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Consultationpatientstatus" } }, "/consultation/{parent_lookup_consultation}/extras/": { "get": { "operationId": "consultation_extras_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationExtrasList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationExtrasList" } } }, "description": "" } }, "summary": "List Consultation Extras" }, "post": { "operationId": "consultation_extras_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExtras" } } }, "description": "" } }, "summary": "Create Consultation Extras" } }, "/consultation/{parent_lookup_consultation}/extras/{id}/": { "get": { "operationId": "consultation_extras_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation extras.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExtras" } } }, "description": "" } }, "summary": "Get Consultation Extras" }, "put": { "operationId": "consultation_extras_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation extras.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExtras" } } }, "description": "" } }, "summary": "Update Consultation Extras" }, "patch": { "operationId": "consultation_extras_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation extras.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExtras" } } }, "description": "" } }, "summary": "Patch Consultation Extras" }, "delete": { "operationId": "consultation_extras_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation extras.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Extras" } }, "/consultation/{parent_lookup_consultation}/foods/": { "get": { "operationId": "consultation_foods_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationFoodList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationFoodList" } } }, "description": "" } }, "summary": "List Consultation Foods" }, "post": { "operationId": "consultation_foods_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } } }, "description": "" } }, "summary": "Create Consultation Foods" } }, "/consultation/{parent_lookup_consultation}/foods/{id}/": { "get": { "operationId": "consultation_foods_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation food.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } } }, "description": "" } }, "summary": "Get Consultation Foods" }, "put": { "operationId": "consultation_foods_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation food.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } } }, "description": "" } }, "summary": "Update Consultation Foods" }, "patch": { "operationId": "consultation_foods_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation food.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationFoodRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationFoodRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationFoodRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } } }, "description": "" } }, "summary": "Patch Consultation Foods" }, "delete": { "operationId": "consultation_foods_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation food.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Foods" } }, "/consultation/{parent_lookup_consultation}/medicines/": { "get": { "operationId": "consultation_medicines_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "vaccination__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "vaccination__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationMedicineList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationMedicineList" } } }, "description": "" } }, "summary": "List Consultation Medicines" }, "post": { "operationId": "consultation_medicines_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Create Consultation Medicines" } }, "/consultation/{parent_lookup_consultation}/medicines/{id}/": { "get": { "operationId": "consultation_medicines_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Get Consultation Medicines" }, "put": { "operationId": "consultation_medicines_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Update Consultation Medicines" }, "patch": { "operationId": "consultation_medicines_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationMedicineRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Patch Consultation Medicines" }, "delete": { "operationId": "consultation_medicines_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Medicines" } }, "/consultation/{parent_lookup_consultation}/medicines/{id}/delete_withdrawal_period/": { "post": { "operationId": "consultation_medicines_delete_withdrawal_period_create", "description": "Delete withdrawal period related to consultation item\nParameters:\n - pk\nReturns:\n Response whetever deletion was successful\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Create Consultation Medicines Delete Withdrawal Period" } }, "/consultation/{parent_lookup_consultation}/patient_groups/": { "get": { "operationId": "consultation_patient_groups_list", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientGroupList" } } }, "description": "" } }, "summary": "List Consultation Patient Groups" } }, "/consultation/{parent_lookup_consultation}/patient_groups/{id}/": { "get": { "operationId": "consultation_patient_groups_retrieve", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation patient group.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientGroup" } } }, "description": "" } }, "summary": "Get Consultation Patient Groups" } }, "/consultation/{parent_lookup_consultation}/procedures/": { "get": { "operationId": "consultation_procedures_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationProcedureList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationProcedureList" } } }, "description": "" } }, "summary": "List Consultation Procedures" }, "post": { "operationId": "consultation_procedures_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } } }, "description": "" } }, "summary": "Create Consultation Procedures" } }, "/consultation/{parent_lookup_consultation}/procedures/{id}/": { "get": { "operationId": "consultation_procedures_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation procedure.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } } }, "description": "" } }, "summary": "Get Consultation Procedures" }, "put": { "operationId": "consultation_procedures_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation procedure.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } } }, "description": "" } }, "summary": "Update Consultation Procedures" }, "patch": { "operationId": "consultation_procedures_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation procedure.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationProcedureRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } } }, "description": "" } }, "summary": "Patch Consultation Procedures" }, "delete": { "operationId": "consultation_procedures_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation procedure.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Procedures" } }, "/consultation/{parent_lookup_consultation}/supplies/": { "get": { "operationId": "consultation_supplies_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationSupplyList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationSupplyList" } } }, "description": "" } }, "summary": "List Consultation Supplies" }, "post": { "operationId": "consultation_supplies_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } } }, "description": "" } }, "summary": "Create Consultation Supplies" } }, "/consultation/{parent_lookup_consultation}/supplies/{id}/": { "get": { "operationId": "consultation_supplies_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation supply.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } } }, "description": "" } }, "summary": "Get Consultation Supplies" }, "put": { "operationId": "consultation_supplies_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation supply.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } } }, "description": "" } }, "summary": "Update Consultation Supplies" }, "patch": { "operationId": "consultation_supplies_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation supply.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSupplyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSupplyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSupplyRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } } }, "description": "" } }, "summary": "Patch Consultation Supplies" }, "delete": { "operationId": "consultation_supplies_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation supply.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Supplies" } }, "/consultation/{parent_lookup_consultation}/treatmentplans/": { "get": { "operationId": "consultation_treatmentplans_list", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanListList" } } }, "description": "" } }, "summary": "List Consultation Treatmentplans" }, "post": { "operationId": "consultation_treatmentplans_create", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlan" } } }, "description": "" } }, "summary": "Create Consultation Treatmentplans" } }, "/consultation/{parent_lookup_consultation}/treatmentplans/{id}/": { "get": { "operationId": "consultation_treatmentplans_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan.", "required": true }, { "in": "path", "name": "parent_lookup_consultation", "schema": { "type": "string" }, "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlan" } } }, "description": "" } }, "summary": "Get Consultation Treatmentplans" } }, "/consultation/{id}/": { "get": { "operationId": "consultation_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationDetail" } } }, "description": "" } }, "summary": "Get Consultation" }, "put": { "operationId": "consultation_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationCreate" } } }, "description": "" } }, "summary": "Update Consultation" }, "patch": { "operationId": "consultation_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Consultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Consultation" } } }, "description": "" } }, "summary": "Patch Consultation" } }, "/consultation/{id}/mark_sent/": { "get": { "operationId": "consultation_mark_sent_retrieve", "description": "External sent timestamp\n\nAllows setting timestamp for external sent field (default null/None)\nthe API can filter consultations according to this field.\n\nParameters:\n - external_sent (datetime)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } } }, "description": "" } }, "summary": "Get Consultation Mark Sent" }, "post": { "operationId": "consultation_mark_sent_create", "description": "External sent timestamp\n\nAllows setting timestamp for external sent field (default null/None)\nthe API can filter consultations according to this field.\n\nParameters:\n - external_sent (datetime)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } } }, "description": "" } }, "summary": "Create Consultation Mark Sent" }, "put": { "operationId": "consultation_mark_sent_update", "description": "External sent timestamp\n\nAllows setting timestamp for external sent field (default null/None)\nthe API can filter consultations according to this field.\n\nParameters:\n - external_sent (datetime)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } } }, "description": "" } }, "summary": "Update Consultation Mark Sent" }, "patch": { "operationId": "consultation_mark_sent_partial_update", "description": "External sent timestamp\n\nAllows setting timestamp for external sent field (default null/None)\nthe API can filter consultations according to this field.\n\nParameters:\n - external_sent (datetime)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExternalSentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExternalSentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExternalSentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } } }, "description": "" } }, "summary": "Patch Consultation Mark Sent" } }, "/consultation/{id}/set_integration_status/": { "get": { "operationId": "consultation_set_integration_status_retrieve", "description": "Integration status\n\nAllows setting an integer value for integration status field (default null/None).\nThe actual meaning for the value is defined by the external system.\n\nParameters:\n - integration_status (integer)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } } }, "description": "" } }, "summary": "Get Consultation Set Integration Status" }, "post": { "operationId": "consultation_set_integration_status_create", "description": "Integration status\n\nAllows setting an integer value for integration status field (default null/None).\nThe actual meaning for the value is defined by the external system.\n\nParameters:\n - integration_status (integer)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } } }, "description": "" } }, "summary": "Create Consultation Set Integration Status" }, "put": { "operationId": "consultation_set_integration_status_update", "description": "Integration status\n\nAllows setting an integer value for integration status field (default null/None).\nThe actual meaning for the value is defined by the external system.\n\nParameters:\n - integration_status (integer)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } } }, "description": "" } }, "summary": "Update Consultation Set Integration Status" }, "patch": { "operationId": "consultation_set_integration_status_partial_update", "description": "Integration status\n\nAllows setting an integer value for integration status field (default null/None).\nThe actual meaning for the value is defined by the external system.\n\nParameters:\n - integration_status (integer)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationIntegrationStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationIntegrationStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationIntegrationStatusRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } } }, "description": "" } }, "summary": "Patch Consultation Set Integration Status" } }, "/consultation/{id}/update_started_time/": { "post": { "operationId": "consultation_update_started_time_create", "description": "Allow updating started time.\nDo not allow updating started if Consultation is not editable.\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTimeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTimeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTimeRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTime" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTime" } } }, "description": "" } }, "summary": "Create Consultation Update Started Time" } }, "/consultation/{id}/update_status/": { "post": { "operationId": "consultation_update_status_create", "description": "Allow updating status from \"Arrived\" -> \"Consultation\".\nAllow updating status to \"Finalized\".\nDo not allow updating status if Consultation is not editable.\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationStatusRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationStatus" } } }, "description": "" } }, "summary": "Create Consultation Update Status" } }, "/consultation/admit/": { "post": { "operationId": "consultation_admit_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmitConsultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AdmitConsultation" } } }, "description": "" } }, "summary": "Create Consultation Admit" } }, "/consultation/admit/{id}/": { "put": { "operationId": "consultation_admit_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/AdmitConsultationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmitConsultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AdmitConsultation" } } }, "description": "" } }, "summary": "Update Consultation Admit" }, "patch": { "operationId": "consultation_admit_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Consultations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedAdmitConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedAdmitConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedAdmitConsultationRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdmitConsultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/AdmitConsultation" } } }, "description": "" } }, "summary": "Patch Consultation Admit" } }, "/consultation_items/analysis/": { "get": { "operationId": "consultation_items_analysis_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 150 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "referral__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "referral__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "referral__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "referral__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "referral__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationLaboratoryAnalysisList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationLaboratoryAnalysisList" } } }, "description": "" } }, "summary": "List Consultation Items Analysis" }, "post": { "operationId": "consultation_items_analysis_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } } }, "description": "" } }, "summary": "Create Consultation Items Analysis" } }, "/consultation_items/analysis/{id}/": { "get": { "operationId": "consultation_items_analysis_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 600 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory analysis.", "required": true } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysis" } } }, "description": "" } }, "summary": "Get Consultation Items Analysis" }, "put": { "operationId": "consultation_items_analysis_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory analysis.", "required": true } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } } }, "description": "" } }, "summary": "Update Consultation Items Analysis" }, "patch": { "operationId": "consultation_items_analysis_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory analysis.", "required": true } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryAnalysisUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryAnalysisUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryAnalysisUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysisUpdate" } } }, "description": "" } }, "summary": "Patch Consultation Items Analysis" }, "delete": { "operationId": "consultation_items_analysis_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory analysis.", "required": true } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Items Analysis" } }, "/consultation_items/food/": { "get": { "operationId": "consultation_items_food_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationFoodList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationFoodList" } } }, "description": "" } }, "summary": "List Consultation Items Food" }, "post": { "operationId": "consultation_items_food_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } } }, "description": "" } }, "summary": "Create Consultation Items Food" } }, "/consultation_items/food/{id}/": { "get": { "operationId": "consultation_items_food_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation food.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } } }, "description": "" } }, "summary": "Get Consultation Items Food" }, "put": { "operationId": "consultation_items_food_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation food.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationFoodRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } } }, "description": "" } }, "summary": "Update Consultation Items Food" }, "patch": { "operationId": "consultation_items_food_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation food.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationFoodRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationFoodRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationFoodRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationFood" } } }, "description": "" } }, "summary": "Patch Consultation Items Food" }, "delete": { "operationId": "consultation_items_food_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation food.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Items Food" } }, "/consultation_items/medicine/": { "get": { "operationId": "consultation_items_medicine_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "vaccination__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "vaccination__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationMedicineList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationMedicineList" } } }, "description": "" } }, "summary": "List Consultation Items Medicine" }, "post": { "operationId": "consultation_items_medicine_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Create Consultation Items Medicine" } }, "/consultation_items/medicine/{id}/": { "get": { "operationId": "consultation_items_medicine_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Get Consultation Items Medicine" }, "put": { "operationId": "consultation_items_medicine_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Update Consultation Items Medicine" }, "patch": { "operationId": "consultation_items_medicine_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationMedicineRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Patch Consultation Items Medicine" }, "delete": { "operationId": "consultation_items_medicine_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Items Medicine" } }, "/consultation_items/medicine/{id}/delete_withdrawal_period/": { "post": { "operationId": "consultation_items_medicine_delete_withdrawal_period_create", "description": "Delete withdrawal period related to consultation item\nParameters:\n - pk\nReturns:\n Response whetever deletion was successful\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation medicine.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationMedicineRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationMedicine" } } }, "description": "" } }, "summary": "Create Consultation Items Medicine Delete Withdrawal Period" } }, "/consultation_items/procedure/": { "get": { "operationId": "consultation_items_procedure_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationProcedureList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationProcedureList" } } }, "description": "" } }, "summary": "List Consultation Items Procedure" }, "post": { "operationId": "consultation_items_procedure_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } } }, "description": "" } }, "summary": "Create Consultation Items Procedure" } }, "/consultation_items/procedure/{id}/": { "get": { "operationId": "consultation_items_procedure_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation procedure.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } } }, "description": "" } }, "summary": "Get Consultation Items Procedure" }, "put": { "operationId": "consultation_items_procedure_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation procedure.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationProcedureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } } }, "description": "" } }, "summary": "Update Consultation Items Procedure" }, "patch": { "operationId": "consultation_items_procedure_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation procedure.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationProcedureRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationProcedure" } } }, "description": "" } }, "summary": "Patch Consultation Items Procedure" }, "delete": { "operationId": "consultation_items_procedure_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation procedure.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Items Procedure" } }, "/consultation_items/supply/": { "get": { "operationId": "consultation_items_supply_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationSupplyList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationSupplyList" } } }, "description": "" } }, "summary": "List Consultation Items Supply" }, "post": { "operationId": "consultation_items_supply_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } } }, "description": "" } }, "summary": "Create Consultation Items Supply" } }, "/consultation_items/supply/{id}/": { "get": { "operationId": "consultation_items_supply_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation supply.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } } }, "description": "" } }, "summary": "Get Consultation Items Supply" }, "put": { "operationId": "consultation_items_supply_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation supply.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationSupplyRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } } }, "description": "" } }, "summary": "Update Consultation Items Supply" }, "patch": { "operationId": "consultation_items_supply_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation supply.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSupplyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSupplyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSupplyRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSupply" } } }, "description": "" } }, "summary": "Patch Consultation Items Supply" }, "delete": { "operationId": "consultation_items_supply_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation supply.", "required": true }, { "in": "query", "name": "no_multiplier", "schema": { "type": "boolean" }, "description": "Ignore herd size multiplier in calculations" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Items Supply" } }, "/consultation_laboratory_referral/": { "get": { "operationId": "consultation_laboratory_referral_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 150 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "inhouse_status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "inhouse_status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "inhouse_status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "inhouse_status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "inhouse_status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "inhouse_status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "inhouse_status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "inhouse_status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "inhouse_status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "inhouse_status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Consultation laboratory referrals" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationLaboratoryReferralList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationLaboratoryReferralList" } } }, "description": "" } }, "summary": "List Consultation Laboratory Referral" }, "post": { "operationId": "consultation_laboratory_referral_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultation laboratory referrals" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferralRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferralRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferralRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } } }, "description": "" } }, "summary": "Create Consultation Laboratory Referral" } }, "/consultation_laboratory_referral/{id}/": { "get": { "operationId": "consultation_laboratory_referral_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 500 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory referral.", "required": true } ], "tags": [ "Consultation laboratory referrals" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } } }, "description": "" } }, "summary": "Get Consultation Laboratory Referral" }, "put": { "operationId": "consultation_laboratory_referral_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory referral.", "required": true } ], "tags": [ "Consultation laboratory referrals" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferralRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferralRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferralRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } } }, "description": "" } }, "summary": "Update Consultation Laboratory Referral" }, "patch": { "operationId": "consultation_laboratory_referral_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory referral.", "required": true } ], "tags": [ "Consultation laboratory referrals" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryReferralRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryReferralRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationLaboratoryReferralRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } } }, "description": "" } }, "summary": "Patch Consultation Laboratory Referral" }, "delete": { "operationId": "consultation_laboratory_referral_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation laboratory referral.", "required": true } ], "tags": [ "Consultation laboratory referrals" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Laboratory Referral" } }, "/consultation_sample/": { "get": { "operationId": "consultation_sample_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "referral__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "referral__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "referral__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "referral__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "referral__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Consultation samples" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationSampleList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationSampleList" } } }, "description": "" } }, "summary": "List Consultation Sample" }, "post": { "operationId": "consultation_sample_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultation samples" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdate" } } }, "description": "" } }, "summary": "Create Consultation Sample" } }, "/consultation_sample/{id}/": { "get": { "operationId": "consultation_sample_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation sample.", "required": true } ], "tags": [ "Consultation samples" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSample" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSample" } } }, "description": "" } }, "summary": "Get Consultation Sample" }, "put": { "operationId": "consultation_sample_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation sample.", "required": true } ], "tags": [ "Consultation samples" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdate" } } }, "description": "" } }, "summary": "Update Consultation Sample" }, "patch": { "operationId": "consultation_sample_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation sample.", "required": true } ], "tags": [ "Consultation samples" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSampleUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSampleUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationSampleUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSampleUpdate" } } }, "description": "" } }, "summary": "Patch Consultation Sample" } }, "/consultation_targetarea/": { "get": { "operationId": "consultation_targetarea_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "sub_category_id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "sub_category_id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "sub_category_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "sub_category_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "sub_category_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "sub_category_id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "sub_category_id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "sub_category_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "sub_category_id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "sub_category_id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "target_area__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "target_area__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "target_area__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "target_area__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "target_area__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "worklist__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "worklist__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "worklist__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "worklist__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "worklist__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Consultation target areas" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationTargetAreaList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationTargetAreaList" } } }, "description": "" } }, "summary": "List Consultation Targetarea" }, "post": { "operationId": "consultation_targetarea_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultation target areas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationTargetAreaRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationTargetAreaRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationTargetAreaRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationTargetArea" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationTargetArea" } } }, "description": "" } }, "summary": "Create Consultation Targetarea" } }, "/consultation_targetarea/{id}/": { "get": { "operationId": "consultation_targetarea_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation target area.", "required": true } ], "tags": [ "Consultation target areas" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationTargetArea" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationTargetArea" } } }, "description": "" } }, "summary": "Get Consultation Targetarea" }, "put": { "operationId": "consultation_targetarea_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation target area.", "required": true } ], "tags": [ "Consultation target areas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationTargetAreaRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationTargetAreaRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationTargetAreaRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationTargetArea" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationTargetArea" } } }, "description": "" } }, "summary": "Update Consultation Targetarea" }, "patch": { "operationId": "consultation_targetarea_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation target area.", "required": true } ], "tags": [ "Consultation target areas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationTargetAreaRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationTargetAreaRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationTargetAreaRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationTargetArea" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationTargetArea" } } }, "description": "" } }, "summary": "Patch Consultation Targetarea" }, "delete": { "operationId": "consultation_targetarea_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation target area.", "required": true } ], "tags": [ "Consultation target areas" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultation Targetarea" } }, "/consultationantibiotic/": { "get": { "operationId": "consultationantibiotic_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "antibiotic__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "antibiotic__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "antibiotic__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "antibiotic__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "antibiotic__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation_organism__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_organism__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_organism__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_organism__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation_organism__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "panel__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "panel__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "panel__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "panel__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "panel__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Consultation antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationAntibioticList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationAntibioticList" } } }, "description": "" } }, "summary": "List Consultationantibiotic" }, "post": { "operationId": "consultationantibiotic_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultation antibiotics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibiotic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationAntibiotic" } } }, "description": "" } }, "summary": "Create Consultationantibiotic" } }, "/consultationantibiotic/{id}/": { "get": { "operationId": "consultationantibiotic_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation antibiotic.", "required": true } ], "tags": [ "Consultation antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibiotic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationAntibiotic" } } }, "description": "" } }, "summary": "Get Consultationantibiotic" }, "put": { "operationId": "consultationantibiotic_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation antibiotic.", "required": true } ], "tags": [ "Consultation antibiotics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibiotic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationAntibiotic" } } }, "description": "" } }, "summary": "Update Consultationantibiotic" }, "patch": { "operationId": "consultationantibiotic_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation antibiotic.", "required": true } ], "tags": [ "Consultation antibiotics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationAntibioticRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationAntibioticRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationAntibioticRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibiotic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationAntibiotic" } } }, "description": "" } }, "summary": "Patch Consultationantibiotic" }, "delete": { "operationId": "consultationantibiotic_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation antibiotic.", "required": true } ], "tags": [ "Consultation antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultationantibiotic" } }, "/consultationantibioticpanel/": { "get": { "operationId": "consultationantibioticpanel_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "antibiotic_panel__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "antibiotic_panel__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "antibiotic_panel__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "antibiotic_panel__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "antibiotic_panel__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation_organism__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_organism__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_organism__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_organism__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation_organism__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Consultation antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationAntibioticPanelList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationAntibioticPanelList" } } }, "description": "" } }, "summary": "List Consultationantibioticpanel" }, "post": { "operationId": "consultationantibioticpanel_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultation antibiotics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanelRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } } }, "description": "" } }, "summary": "Create Consultationantibioticpanel" } }, "/consultationantibioticpanel/{id}/": { "get": { "operationId": "consultationantibioticpanel_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation antibiotic panel.", "required": true } ], "tags": [ "Consultation antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } } }, "description": "" } }, "summary": "Get Consultationantibioticpanel" }, "put": { "operationId": "consultationantibioticpanel_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation antibiotic panel.", "required": true } ], "tags": [ "Consultation antibiotics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanelRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } } }, "description": "" } }, "summary": "Update Consultationantibioticpanel" }, "patch": { "operationId": "consultationantibioticpanel_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation antibiotic panel.", "required": true } ], "tags": [ "Consultation antibiotics" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationAntibioticPanelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationAntibioticPanelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationAntibioticPanelRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } } }, "description": "" } }, "summary": "Patch Consultationantibioticpanel" }, "delete": { "operationId": "consultationantibioticpanel_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation antibiotic panel.", "required": true } ], "tags": [ "Consultation antibiotics" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultationantibioticpanel" } }, "/consultationitem/": { "get": { "operationId": "consultationitem_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "type_code__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "type_code__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "type_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type_code__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "type_code__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "type_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type_code__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "type_code__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationItemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationItemList" } } }, "description": "" } }, "summary": "List Consultationitem" } }, "/consultationitem/{id}/": { "get": { "operationId": "consultationitem_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation item.", "required": true } ], "tags": [ "Consultation items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationItem" } } }, "description": "" } }, "summary": "Get Consultationitem" } }, "/consultationitemtemplate/": { "get": { "operationId": "consultationitemtemplate_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Consultation bundles" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationItemTemplateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationItemTemplateList" } } }, "description": "" } }, "summary": "List Consultationitemtemplate" }, "post": { "operationId": "consultationitemtemplate_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultation bundles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdate" } } }, "description": "" } }, "summary": "Create Consultationitemtemplate" } }, "/consultationitemtemplate/{id}/": { "get": { "operationId": "consultationitemtemplate_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation item template.", "required": true } ], "tags": [ "Consultation bundles" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateDetail" } } }, "description": "" } }, "summary": "Get Consultationitemtemplate" }, "put": { "operationId": "consultationitemtemplate_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation item template.", "required": true } ], "tags": [ "Consultation bundles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdate" } } }, "description": "" } }, "summary": "Update Consultationitemtemplate" }, "patch": { "operationId": "consultationitemtemplate_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation item template.", "required": true } ], "tags": [ "Consultation bundles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationItemTemplateCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationItemTemplateCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationItemTemplateCreateUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationItemTemplateCreateUpdate" } } }, "description": "" } }, "summary": "Patch Consultationitemtemplate" } }, "/consultationorganism/": { "get": { "operationId": "consultationorganism_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation_analysis__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_analysis__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_analysis__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_analysis__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation_analysis__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Consultation organisms" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationOrganismList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationOrganismList" } } }, "description": "" } }, "summary": "List Consultationorganism" }, "post": { "operationId": "consultationorganism_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Consultation organisms" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationOrganismRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationOrganismRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationOrganismRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationOrganism" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationOrganism" } } }, "description": "" } }, "summary": "Create Consultationorganism" } }, "/consultationorganism/{id}/": { "get": { "operationId": "consultationorganism_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation organism.", "required": true } ], "tags": [ "Consultation organisms" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationOrganism" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationOrganism" } } }, "description": "" } }, "summary": "Get Consultationorganism" }, "put": { "operationId": "consultationorganism_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation organism.", "required": true } ], "tags": [ "Consultation organisms" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationOrganismRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationOrganismRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationOrganismRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationOrganism" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationOrganism" } } }, "description": "" } }, "summary": "Update Consultationorganism" }, "patch": { "operationId": "consultationorganism_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation organism.", "required": true } ], "tags": [ "Consultation organisms" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationOrganismRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationOrganismRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationOrganismRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationOrganism" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationOrganism" } } }, "description": "" } }, "summary": "Patch Consultationorganism" }, "delete": { "operationId": "consultationorganism_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation organism.", "required": true } ], "tags": [ "Consultation organisms" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Consultationorganism" } }, "/consultationsubcategory/": { "get": { "operationId": "consultationsubcategory_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "is_fixed__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_fixed__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "is_package__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_package__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "consultationsubcategory" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationSubCategoryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationSubCategoryList" } } }, "description": "" } }, "summary": "List Consultationsubcategory" } }, "/consultationsubcategory/{id}/": { "get": { "operationId": "consultationsubcategory_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation sub category.", "required": true } ], "tags": [ "consultationsubcategory" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationSubCategory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationSubCategory" } } }, "description": "" } }, "summary": "Get Consultationsubcategory" } }, "/contenttype/": { "get": { "operationId": "contenttype_list", "description": "Content Types\n\nThis view does not require permissions because content types are trivial information.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Content types" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedContentTypeList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedContentTypeList" } } }, "description": "" } }, "summary": "List Contenttype" } }, "/contenttype/{id}/": { "get": { "operationId": "contenttype_retrieve", "description": "Content Types\n\nThis view does not require permissions because content types are trivial information.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this content type.", "required": true } ], "tags": [ "Content types" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContentType" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ContentType" } } }, "description": "" } }, "summary": "Get Contenttype" } }, "/countersale/": { "get": { "operationId": "countersale_list", "description": "Counter Sales\n\nThe details view allows creation and updating of Counter Sales.\ninvoice_detail is a read-only field which links to the actual invoice data.\nupdates are only possible during draft status.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "_status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "_status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "invoice_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "invoice_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "invoice_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "invoice_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "invoice_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "invoice_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Counter sales" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCountersaleList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCountersaleList" } } }, "description": "" } }, "summary": "List Countersale" }, "post": { "operationId": "countersale_create", "description": "Counter Sales\n\nThe details view allows creation and updating of Counter Sales.\ninvoice_detail is a read-only field which links to the actual invoice data.\nupdates are only possible during draft status.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Counter sales" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdate" } } }, "description": "" } }, "summary": "Create Countersale" } }, "/countersale/{id}/": { "get": { "operationId": "countersale_retrieve", "description": "Counter Sales\n\nThe details view allows creation and updating of Counter Sales.\ninvoice_detail is a read-only field which links to the actual invoice data.\nupdates are only possible during draft status.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountersaleDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CountersaleDetail" } } }, "description": "" } }, "summary": "Get Countersale" }, "put": { "operationId": "countersale_update", "description": "Update Counter Sale\n\nUpdates are not allowed if the Counter Sale is finalized.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CountersaleCreateUpdate" } } }, "description": "" } }, "summary": "Update Countersale" }, "patch": { "operationId": "countersale_partial_update", "description": "Counter Sales\n\nThe details view allows creation and updating of Counter Sales.\ninvoice_detail is a read-only field which links to the actual invoice data.\nupdates are only possible during draft status.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCountersaleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCountersaleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCountersaleRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Countersale" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Countersale" } } }, "description": "" } }, "summary": "Patch Countersale" }, "delete": { "operationId": "countersale_destroy", "description": "Archive Counter Sale\n\nArchiving is not allowed if the Counter Sale is finalized or has been synced to InvoiceXpress.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Countersale" } }, "/countersale/{id}/add_item/": { "get": { "operationId": "countersale_add_item_retrieve", "description": "Add new item to Counter Sale\n\nParameters:\n- item (int) - ID for Item\n- quantity (int)\n- usage_size (int|choice) - options:1 (Package), 2 (Units)\n- price (float) - default:Uses amount found from item\n- price_with_vat (float) - default:Uses amount found from item\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Countersale Add Item" }, "post": { "operationId": "countersale_add_item_create", "description": "Add new item to Counter Sale\n\nParameters:\n- item (int) - ID for Item\n- quantity (int)\n- usage_size (int|choice) - options:1 (Package), 2 (Units)\n- price (float) - default:Uses amount found from item\n- price_with_vat (float) - default:Uses amount found from item\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Countersale Add Item" }, "put": { "operationId": "countersale_add_item_update", "description": "Add new item to Counter Sale\n\nParameters:\n- item (int) - ID for Item\n- quantity (int)\n- usage_size (int|choice) - options:1 (Package), 2 (Units)\n- price (float) - default:Uses amount found from item\n- price_with_vat (float) - default:Uses amount found from item\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update Countersale Add Item" } }, "/countersale/{id}/finalize/": { "post": { "operationId": "countersale_finalize_create", "description": "Finalize Counter Sale\n\nUpdates are not allowed after finalizing the Counter Sale.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountersaleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CountersaleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CountersaleRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Countersale" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Countersale" } } }, "description": "" } }, "summary": "Create Countersale Finalize" }, "put": { "operationId": "countersale_finalize_update", "description": "Finalize Counter Sale\n\nUpdates are not allowed after finalizing the Counter Sale.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountersaleRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CountersaleRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CountersaleRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Countersale" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Countersale" } } }, "description": "" } }, "summary": "Update Countersale Finalize" } }, "/countersale/{id}/invoice_date/": { "post": { "operationId": "countersale_invoice_date_create", "description": "Backdate invoice\n\nUsed for backdating the invoice by manually setting invoice_date.\nSets both invoice_date and manual_invoice_date to preserve the invoice_date when\ninvoice is finalized.\nNot for general use.\n - Requires api_staff_token access token to use\n - This endpoint is only enabled for select few provets.\n\n Parameters:\n - invoice_date (datetime) - ISO 8601 format\n - api_staff_token (string) - token for authenticating the request\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Counter sales" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDateEditRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceDateEditRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceDateEditRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDateEdit" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceDateEdit" } } }, "description": "" } }, "summary": "Create Countersale Invoice Date" } }, "/create_consultation/": { "get": { "operationId": "create_consultation_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "admitted_time__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "admitted_time__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "admitted_time__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "admitted_time__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "admitted_time__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "admitted_time__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "complaint__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "complaint__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "complaint__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "complaint__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "complaint__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "complaint__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "complaint__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "complaint__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation_diagnosis__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "consultation_diagnosis__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "consultation_diagnosis__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "consultation_diagnosis__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "consultation_diagnosis__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "consultation_diagnosis__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "consultation_diagnosis__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_diagnosis__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_diagnosis__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_diagnosis__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "consultation_diagnosis__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "consultation_diagnosis__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation_diagnosis__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "consultation_diagnosis__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "consultation_extras__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "consultation_extras__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "consultation_extras__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "consultation_extras__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "consultation_extras__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "consultation_extras__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "consultation_extras__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_extras__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_extras__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_extras__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation_extras__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "consultation_extras__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "consultation_extras__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation_extras__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "consultation_extras__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "custom_fields__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "custom_fields__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "custom_fields__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "custom_fields__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "custom_fields__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "ended__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "ended__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "ended__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "ended__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "ended__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "ended__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "external_sent__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "external_sent__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "external_sent__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_sent__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_sent__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "external_sent__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "external_sent__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "integration_status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "integration_status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "integration_status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "integration_status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "integration_status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "integration_status__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "integration_status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "integration_status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "integration_status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "integration_status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "integration_status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patients__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patients__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patients__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patients__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "report_to_authorities__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "report_to_authorities__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "started__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "started__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "started__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "started__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "started__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "started__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "supervising_veterinarian__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "supervising_veterinarian__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "supervising_veterinarian__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "supervising_veterinarian__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Create consultation" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedConsultationList" } } }, "description": "" } }, "summary": "List Create Consultation" }, "post": { "operationId": "create_consultation_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationCreate" } } }, "description": "" } }, "summary": "Create Create Consultation" } }, "/create_consultation/{id}/": { "get": { "operationId": "create_consultation_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationDetail" } } }, "description": "" } }, "summary": "Get Create Consultation" }, "put": { "operationId": "create_consultation_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationCreate" } } }, "description": "" } }, "summary": "Update Create Consultation" }, "patch": { "operationId": "create_consultation_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Consultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Consultation" } } }, "description": "" } }, "summary": "Patch Create Consultation" } }, "/create_consultation/{id}/mark_sent/": { "get": { "operationId": "create_consultation_mark_sent_retrieve", "description": "External sent timestamp\n\nAllows setting timestamp for external sent field (default null/None)\nthe API can filter consultations according to this field.\n\nParameters:\n - external_sent (datetime)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } } }, "description": "" } }, "summary": "Get Create Consultation Mark Sent" }, "post": { "operationId": "create_consultation_mark_sent_create", "description": "External sent timestamp\n\nAllows setting timestamp for external sent field (default null/None)\nthe API can filter consultations according to this field.\n\nParameters:\n - external_sent (datetime)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } } }, "description": "" } }, "summary": "Create Create Consultation Mark Sent" }, "put": { "operationId": "create_consultation_mark_sent_update", "description": "External sent timestamp\n\nAllows setting timestamp for external sent field (default null/None)\nthe API can filter consultations according to this field.\n\nParameters:\n - external_sent (datetime)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } } }, "description": "" } }, "summary": "Update Create Consultation Mark Sent" }, "patch": { "operationId": "create_consultation_mark_sent_partial_update", "description": "External sent timestamp\n\nAllows setting timestamp for external sent field (default null/None)\nthe API can filter consultations according to this field.\n\nParameters:\n - external_sent (datetime)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExternalSentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExternalSentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationExternalSentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationExternalSent" } } }, "description": "" } }, "summary": "Patch Create Consultation Mark Sent" } }, "/create_consultation/{id}/set_integration_status/": { "get": { "operationId": "create_consultation_set_integration_status_retrieve", "description": "Integration status\n\nAllows setting an integer value for integration status field (default null/None).\nThe actual meaning for the value is defined by the external system.\n\nParameters:\n - integration_status (integer)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } } }, "description": "" } }, "summary": "Get Create Consultation Set Integration Status" }, "post": { "operationId": "create_consultation_set_integration_status_create", "description": "Integration status\n\nAllows setting an integer value for integration status field (default null/None).\nThe actual meaning for the value is defined by the external system.\n\nParameters:\n - integration_status (integer)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } } }, "description": "" } }, "summary": "Create Create Consultation Set Integration Status" }, "put": { "operationId": "create_consultation_set_integration_status_update", "description": "Integration status\n\nAllows setting an integer value for integration status field (default null/None).\nThe actual meaning for the value is defined by the external system.\n\nParameters:\n - integration_status (integer)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatusRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } } }, "description": "" } }, "summary": "Update Create Consultation Set Integration Status" }, "patch": { "operationId": "create_consultation_set_integration_status_partial_update", "description": "Integration status\n\nAllows setting an integer value for integration status field (default null/None).\nThe actual meaning for the value is defined by the external system.\n\nParameters:\n - integration_status (integer)\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedConsultationIntegrationStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedConsultationIntegrationStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedConsultationIntegrationStatusRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationIntegrationStatus" } } }, "description": "" } }, "summary": "Patch Create Consultation Set Integration Status" } }, "/create_consultation/{id}/update_started_time/": { "post": { "operationId": "create_consultation_update_started_time_create", "description": "Allow updating started time.\nDo not allow updating started if Consultation is not editable.\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTimeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTimeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTimeRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTime" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationStartedTime" } } }, "description": "" } }, "summary": "Create Create Consultation Update Started Time" } }, "/create_consultation/{id}/update_status/": { "post": { "operationId": "create_consultation_update_status_create", "description": "Allow updating status from \"Arrived\" -> \"Consultation\".\nAllow updating status to \"Finalized\".\nDo not allow updating status if Consultation is not editable.\n\nRequired permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this consultation.", "required": true } ], "tags": [ "Create consultation" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationStatusRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ConsultationStatusRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ConsultationStatusRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsultationStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ConsultationStatus" } } }, "description": "" } }, "summary": "Create Create Consultation Update Status" } }, "/custom_field_values/": { "get": { "operationId": "custom_field_values_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "content_type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "content_type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "content_type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "content_type__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "content_type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "field__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "field__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "field__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "field__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "field__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "object_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "object_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "object_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "object_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "object_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "value__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "value__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "value__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "value__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "value__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "value__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "value__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "value__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldValueList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldValueList" } } }, "description": "" } }, "summary": "List Custom Field Values" }, "post": { "operationId": "custom_field_values_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Custom fields" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } } }, "description": "" } }, "summary": "Create Custom Field Values" } }, "/custom_field_values/{parent_lookup_custom_field}/customfieldoption/": { "get": { "operationId": "custom_field_values_customfieldoption_list", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_custom_field", "schema": { "type": "string" }, "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldOptionValueList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldOptionValueList" } } }, "description": "" } }, "summary": "List Custom Field Values Customfieldoption" }, "post": { "operationId": "custom_field_values_customfieldoption_create", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_custom_field", "schema": { "type": "string" }, "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionValue" } } }, "description": "" } }, "summary": "Create Custom Field Values Customfieldoption" } }, "/custom_field_values/{parent_lookup_custom_field}/customfieldoption/{id}/": { "get": { "operationId": "custom_field_values_customfieldoption_retrieve", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field option value.", "required": true }, { "in": "path", "name": "parent_lookup_custom_field", "schema": { "type": "string" }, "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionValue" } } }, "description": "" } }, "summary": "Get Custom Field Values Customfieldoption" }, "put": { "operationId": "custom_field_values_customfieldoption_update", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field option value.", "required": true }, { "in": "path", "name": "parent_lookup_custom_field", "schema": { "type": "string" }, "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionValue" } } }, "description": "" } }, "summary": "Update Custom Field Values Customfieldoption" }, "patch": { "operationId": "custom_field_values_customfieldoption_partial_update", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field option value.", "required": true }, { "in": "path", "name": "parent_lookup_custom_field", "schema": { "type": "string" }, "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldOptionValue" } } }, "description": "" } }, "summary": "Patch Custom Field Values Customfieldoption" }, "delete": { "operationId": "custom_field_values_customfieldoption_destroy", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field option value.", "required": true }, { "in": "path", "name": "parent_lookup_custom_field", "schema": { "type": "string" }, "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Custom Field Values Customfieldoption" } }, "/custom_field_values/{id}/": { "get": { "operationId": "custom_field_values_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } } }, "description": "" } }, "summary": "Get Custom Field Values" }, "put": { "operationId": "custom_field_values_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true } ], "tags": [ "Custom fields" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } } }, "description": "" } }, "summary": "Update Custom Field Values" }, "patch": { "operationId": "custom_field_values_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true } ], "tags": [ "Custom fields" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } } }, "description": "" } }, "summary": "Patch Custom Field Values" }, "delete": { "operationId": "custom_field_values_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Custom Field Values" } }, "/custom_fields/": { "get": { "operationId": "custom_fields_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "field_type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "field_type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "field_type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "field_type__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "field_type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldList" } } }, "description": "" } }, "summary": "List Custom Fields" } }, "/custom_fields/{id}/": { "get": { "operationId": "custom_fields_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field.", "required": true } ], "tags": [ "Custom fields" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomField" } } }, "description": "" } }, "summary": "Get Custom Fields" } }, "/custom_integration/": { "get": { "operationId": "custom_integration_list", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Custom integrations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCustomIntegrationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCustomIntegrationList" } } }, "description": "" } }, "summary": "List Custom Integration" }, "post": { "operationId": "custom_integration_create", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Custom integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomIntegrationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomIntegrationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomIntegrationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomIntegration" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomIntegration" } } }, "description": "" } }, "summary": "Create Custom Integration" } }, "/custom_integration/{id}/": { "get": { "operationId": "custom_integration_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom integration.", "required": true } ], "tags": [ "Custom integrations" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomIntegration" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomIntegration" } } }, "description": "" } }, "summary": "Get Custom Integration" }, "put": { "operationId": "custom_integration_update", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom integration.", "required": true } ], "tags": [ "Custom integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomIntegrationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomIntegrationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomIntegrationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomIntegration" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomIntegration" } } }, "description": "" } }, "summary": "Update Custom Integration" }, "patch": { "operationId": "custom_integration_partial_update", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom integration.", "required": true } ], "tags": [ "Custom integrations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCustomIntegrationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCustomIntegrationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCustomIntegrationRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomIntegration" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomIntegration" } } }, "description": "" } }, "summary": "Patch Custom Integration" }, "delete": { "operationId": "custom_integration_destroy", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom integration.", "required": true } ], "tags": [ "Custom integrations" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Custom Integration" } }, "/department/": { "get": { "operationId": "department_list", "description": "Departments\n\nThis view does not require permissions because we don't generally restrict reading\ndepartment and department group information.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDepartmentList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDepartmentList" } } }, "description": "" } }, "summary": "List Department" } }, "/department/{parent_lookup_department}/mobileapp_settings/": { "get": { "operationId": "department_mobileapp_settings_list", "description": "Required permissions:\n- Profile: Login credentials to Provet mobile app\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentSettings" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentSettings" } } } }, "description": "" } }, "summary": "List Department Mobileapp Settings" } }, "/department/{parent_lookup_department}/mobileapp_settings/logo/": { "put": { "operationId": "department_mobileapp_settings_logo_update", "description": "Set or clear the department logo.\n\nRequired permissions:\n- Profile: Login credentials to Provet mobile app\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DepartmentLogoRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DepartmentLogoRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Update Department Mobileapp Settings Logo" }, "delete": { "operationId": "department_mobileapp_settings_logo_destroy", "description": "Set or clear the department logo.\n\nRequired permissions:\n- Profile: Login credentials to Provet mobile app\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Department Mobileapp Settings Logo" } }, "/department/{parent_lookup_department}/patient_location/": { "get": { "operationId": "department_patient_location_list", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientLocationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientLocationList" } } }, "description": "" } }, "summary": "List Department Patient Location" }, "post": { "operationId": "department_patient_location_create", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientLocationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientLocationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientLocation" } } }, "description": "" } }, "summary": "Create Department Patient Location" } }, "/department/{parent_lookup_department}/patient_location/{id}/": { "get": { "operationId": "department_patient_location_retrieve", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient location.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientLocation" } } }, "description": "" } }, "summary": "Get Department Patient Location" }, "put": { "operationId": "department_patient_location_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient location.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientLocationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientLocationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientLocation" } } }, "description": "" } }, "summary": "Update Department Patient Location" }, "patch": { "operationId": "department_patient_location_partial_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient location.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientLocationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientLocationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientLocationRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientLocation" } } }, "description": "" } }, "summary": "Patch Department Patient Location" }, "delete": { "operationId": "department_patient_location_destroy", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient location.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Department Patient Location" } }, "/department/{parent_lookup_department}/settings/": { "get": { "operationId": "department_settings_list", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentSettings" } } }, "text/html": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentSettings" } } } }, "description": "" } }, "summary": "List Department Settings" } }, "/department/{parent_lookup_department}/settings/logo/": { "put": { "operationId": "department_settings_logo_update", "description": "Set or clear the department logo.\n\nRequired permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DepartmentLogoRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DepartmentLogoRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Update Department Settings Logo" }, "delete": { "operationId": "department_settings_logo_destroy", "description": "Set or clear the department logo.\n\nRequired permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Department Settings Logo" } }, "/department/{parent_lookup_department}/team/": { "get": { "operationId": "department_team_list", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "is_active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "ward__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "ward__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "ward__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "ward__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "ward__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTeamList" } } }, "description": "" } }, "summary": "List Department Team" }, "post": { "operationId": "department_team_create", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TeamRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } }, "summary": "Create Department Team" } }, "/department/{parent_lookup_department}/team/{id}/": { "get": { "operationId": "department_team_retrieve", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this team.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } }, "summary": "Get Department Team" }, "put": { "operationId": "department_team_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this team.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TeamRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } }, "summary": "Update Department Team" }, "patch": { "operationId": "department_team_partial_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this team.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTeamRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTeamRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTeamRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Team" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Team" } } }, "description": "" } }, "summary": "Patch Department Team" }, "delete": { "operationId": "department_team_destroy", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this team.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Department Team" } }, "/department/{parent_lookup_department}/ward/": { "get": { "operationId": "department_ward_list", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "is_active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWardList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedWardList" } } }, "description": "" } }, "summary": "List Department Ward" }, "post": { "operationId": "department_ward_create", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WardRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ward" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Ward" } } }, "description": "" } }, "summary": "Create Department Ward" } }, "/department/{parent_lookup_department}/ward/{id}/": { "get": { "operationId": "department_ward_retrieve", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ward.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ward" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Ward" } } }, "description": "" } }, "summary": "Get Department Ward" }, "put": { "operationId": "department_ward_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ward.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WardRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ward" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Ward" } } }, "description": "" } }, "summary": "Update Department Ward" }, "patch": { "operationId": "department_ward_partial_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ward.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedWardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedWardRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ward" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Ward" } } }, "description": "" } }, "summary": "Patch Department Ward" }, "delete": { "operationId": "department_ward_destroy", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this ward.", "required": true }, { "in": "path", "name": "parent_lookup_department", "schema": { "type": "string" }, "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Department Ward" } }, "/department/{id}/": { "get": { "operationId": "department_retrieve", "description": "Departments\n\nThis view does not require permissions because we don't generally restrict reading\ndepartment and department group information.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 1200 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this department.", "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Department" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Department" } } }, "description": "" } }, "summary": "Get Department" } }, "/departmentgroup/": { "get": { "operationId": "departmentgroup_list", "description": "Department Groups\n\nThis view does not require permissions because we don't generally restrict reading\ndepartment and department group information.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDepartmentGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDepartmentGroupList" } } }, "description": "" } }, "summary": "List Departmentgroup" } }, "/departmentgroup/{id}/": { "get": { "operationId": "departmentgroup_retrieve", "description": "Department Groups\n\nThis view does not require permissions because we don't generally restrict reading\ndepartment and department group information.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this department group.", "required": true } ], "tags": [ "Departments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DepartmentGroup" } } }, "description": "" } }, "summary": "Get Departmentgroup" } }, "/diagnosticimaging_referral/": { "get": { "operationId": "diagnosticimaging_referral_list", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_id__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_id__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_id__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_id__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Diagnostic imaging" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDiagnosticImagingReferralList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDiagnosticImagingReferralList" } } }, "description": "" } }, "summary": "List Diagnosticimaging Referral" }, "post": { "operationId": "diagnosticimaging_referral_create", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Diagnostic imaging" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferralRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferralRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferralRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } } }, "description": "" } }, "summary": "Create Diagnosticimaging Referral" } }, "/diagnosticimaging_referral/{id}/": { "get": { "operationId": "diagnosticimaging_referral_retrieve", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this diagnostic imaging referral.", "required": true } ], "tags": [ "Diagnostic imaging" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } } }, "description": "" } }, "summary": "Get Diagnosticimaging Referral" }, "put": { "operationId": "diagnosticimaging_referral_update", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this diagnostic imaging referral.", "required": true } ], "tags": [ "Diagnostic imaging" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferralRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferralRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferralRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } } }, "description": "" } }, "summary": "Update Diagnosticimaging Referral" }, "patch": { "operationId": "diagnosticimaging_referral_partial_update", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this diagnostic imaging referral.", "required": true } ], "tags": [ "Diagnostic imaging" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosticImagingReferralRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosticImagingReferralRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosticImagingReferralRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } } }, "description": "" } }, "summary": "Patch Diagnosticimaging Referral" }, "delete": { "operationId": "diagnosticimaging_referral_destroy", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this diagnostic imaging referral.", "required": true } ], "tags": [ "Diagnostic imaging" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Diagnosticimaging Referral" } }, "/diagnosticimaging_worklist/": { "get": { "operationId": "diagnosticimaging_worklist_list", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 250 requests per minute.", "parameters": [ { "in": "query", "name": "department", "schema": { "type": "integer" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Diagnostic imaging" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDiagnosticImagingWorklistList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDiagnosticImagingWorklistList" } } }, "description": "" } }, "summary": "List Diagnosticimaging Worklist" }, "post": { "operationId": "diagnosticimaging_worklist_create", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Diagnostic imaging" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdate" } } }, "description": "" } }, "summary": "Create Diagnosticimaging Worklist" } }, "/diagnosticimaging_worklist/{id}/": { "get": { "operationId": "diagnosticimaging_worklist_retrieve", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 1000 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this diagnostic imaging worklist.", "required": true } ], "tags": [ "Diagnostic imaging" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklist" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklist" } } }, "description": "" } }, "summary": "Get Diagnosticimaging Worklist" }, "put": { "operationId": "diagnosticimaging_worklist_update", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this diagnostic imaging worklist.", "required": true } ], "tags": [ "Diagnostic imaging" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdate" } } }, "description": "" } }, "summary": "Update Diagnosticimaging Worklist" }, "patch": { "operationId": "diagnosticimaging_worklist_partial_update", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this diagnostic imaging worklist.", "required": true } ], "tags": [ "Diagnostic imaging" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosticImagingWorklistCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosticImagingWorklistCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDiagnosticImagingWorklistCreateUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiagnosticImagingWorklistCreateUpdate" } } }, "description": "" } }, "summary": "Patch Diagnosticimaging Worklist" }, "delete": { "operationId": "diagnosticimaging_worklist_destroy", "description": "Required permissions:\n- Diagnostic imaging: Diagnostic imaging referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this diagnostic imaging worklist.", "required": true } ], "tags": [ "Diagnostic imaging" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Diagnosticimaging Worklist" } }, "/discountscheme/": { "get": { "operationId": "discountscheme_list", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "default_discount__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "default_discount__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "default_discount__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "default_discount__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "default_discount__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "default_discount__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "default_discount__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "default_discount__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "default_discount__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "default_discount__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "end_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "end_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "end_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "end_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "end_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "end_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "end_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "end_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "start_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "start_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "start_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "start_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "start_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "start_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "start_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "start_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeList" } } }, "description": "" } }, "summary": "List Discountscheme" }, "post": { "operationId": "discountscheme_create", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Discount schemes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdate" } } }, "description": "" } }, "summary": "Create Discountscheme" } }, "/discountscheme/{id}/": { "get": { "operationId": "discountscheme_retrieve", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discount scheme.", "required": true } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountScheme" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiscountScheme" } } }, "description": "" } }, "summary": "Get Discountscheme" }, "put": { "operationId": "discountscheme_update", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discount scheme.", "required": true } ], "tags": [ "Discount schemes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiscountSchemeUpdate" } } }, "description": "" } }, "summary": "Update Discountscheme" }, "patch": { "operationId": "discountscheme_partial_update", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discount scheme.", "required": true } ], "tags": [ "Discount schemes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDiscountSchemePartialUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDiscountSchemePartialUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDiscountSchemePartialUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemePartialUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiscountSchemePartialUpdate" } } }, "description": "" } }, "summary": "Patch Discountscheme" }, "delete": { "operationId": "discountscheme_destroy", "description": "Archives an item.\n\nRequired permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discount scheme.", "required": true } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Discountscheme" } }, "/discountscheme_bulk_discounts/": { "get": { "operationId": "discountscheme_bulk_discounts_list", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeBulkDiscountDetailsList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeBulkDiscountDetailsList" } } }, "description": "" } }, "summary": "List Discountscheme Bulk Discounts" } }, "/discountscheme_bulk_discounts/{id}/": { "get": { "operationId": "discountscheme_bulk_discounts_retrieve", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discount scheme bulk discount.", "required": true } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemeBulkDiscountDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiscountSchemeBulkDiscountDetails" } } }, "description": "" } }, "summary": "Get Discountscheme Bulk Discounts" } }, "/discountscheme_item/": { "get": { "operationId": "discountscheme_item_list", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeItemDetailsList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeItemDetailsList" } } }, "description": "" } }, "summary": "List Discountscheme Item" } }, "/discountscheme_item/{id}/": { "get": { "operationId": "discountscheme_item_retrieve", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discount scheme item.", "required": true } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemeItemDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiscountSchemeItemDetails" } } }, "description": "" } }, "summary": "Get Discountscheme Item" } }, "/discountscheme_target/": { "get": { "operationId": "discountscheme_target_list", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeTargetDetailsList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeTargetDetailsList" } } }, "description": "" } }, "summary": "List Discountscheme Target" } }, "/discountscheme_target/{id}/": { "get": { "operationId": "discountscheme_target_retrieve", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discount scheme target.", "required": true } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemeTargetDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiscountSchemeTargetDetails" } } }, "description": "" } }, "summary": "Get Discountscheme Target" } }, "/discountscheme_time/": { "get": { "operationId": "discountscheme_time_list", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeTimeDetailsList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDiscountSchemeTimeDetailsList" } } }, "description": "" } }, "summary": "List Discountscheme Time" } }, "/discountscheme_time/{id}/": { "get": { "operationId": "discountscheme_time_retrieve", "description": "Required permissions:\n- Settings: Discount settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this discount scheme time.", "required": true } ], "tags": [ "Discount schemes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountSchemeTimeDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DiscountSchemeTimeDetails" } } }, "description": "" } }, "summary": "Get Discountscheme Time" } }, "/email/send/": { "post": { "operationId": "email_send_create", "description": "Send email using organization SMTP configuration.\n\nRequired parameters (JSON object):\n- to (string) - recipient email address\n- subject (string) - email subject\n- body (string) - HTML content, either plain or base64-encoded.\n Plain HTML is sanitized before sending. Base64-encoded bodies\n are decoded and used for pre-built email templates.\n- department (int) - department ID for SMTP/from_email resolution\n- online_booking (bool, optional) - use online booking email path\n (defaults to false)\n\nRequired permissions:\n- General: Customer communication via email (API only)\n\n\nThis endpoint is rate-limited to 30 requests per minute.", "parameters": [], "tags": [ "email" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Email Send" } }, "/endofdayreport/": { "get": { "operationId": "endofdayreport_list", "description": "Required permissions:\n- Financial: End of day and accounting reports\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "end_timestamp__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "end_timestamp__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "end_timestamp__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "end_timestamp__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "end_timestamp__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "end_timestamp__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "end_timestamp__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "end_timestamp__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "start_timestamp__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "start_timestamp__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "start_timestamp__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "start_timestamp__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "start_timestamp__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "start_timestamp__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "start_timestamp__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "start_timestamp__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "End of day reports" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEndOfDayReportList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedEndOfDayReportList" } } }, "description": "" } }, "summary": "List Endofdayreport" } }, "/endofdayreport/{id}/": { "get": { "operationId": "endofdayreport_retrieve", "description": "Get Report by ID.\n\nDefault response is the full detail payload; ``?lean=1`` returns\nthe flat list serializer instead — the EFSTA tentacle only needs\nthe fiscal envelope (department, timestamps) and each detail\nmethod-field fires its own DB query. Schema advertises the\ndetail shape either way; lean mode is a documented shortcut,\nnot a schema variant.\n\nRequired permissions:\n- Financial: End of day and accounting reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this cash report.", "required": true }, { "in": "query", "name": "lean", "schema": { "type": "boolean" }, "description": "When ``1``, returns the flat ``EndOfDayReportSerializer`` (fiscal envelope only: department + timestamps) instead of the full detail payload. Used by the EFSTA tentacle when signing a Z-Bon, to avoid the per-field detail queries." } ], "tags": [ "End of day reports" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndOfDayReportDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/EndOfDayReportDetail" } } }, "description": "" } }, "summary": "Get Endofdayreport" } }, "/eprescription/prescription/": { "get": { "operationId": "eprescription_prescription_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "items__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "items__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "items__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "items__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "items__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Electronic prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedElectronicPrescriptionList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedElectronicPrescriptionList" } } }, "description": "" } }, "summary": "List Eprescription Prescription" }, "post": { "operationId": "eprescription_prescription_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Electronic prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Eprescription Prescription" } }, "/eprescription/prescription/{id}/": { "get": { "operationId": "eprescription_prescription_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this prescription.", "required": true } ], "tags": [ "Electronic prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElectronicPrescriptionDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ElectronicPrescriptionDetail" } } }, "description": "" } }, "summary": "Get Eprescription Prescription" }, "put": { "operationId": "eprescription_prescription_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this prescription.", "required": true } ], "tags": [ "Electronic prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update Eprescription Prescription" }, "patch": { "operationId": "eprescription_prescription_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this prescription.", "required": true } ], "tags": [ "Electronic prescriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedElectronicPrescriptionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedElectronicPrescriptionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedElectronicPrescriptionRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElectronicPrescription" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ElectronicPrescription" } } }, "description": "" } }, "summary": "Patch Eprescription Prescription" } }, "/eprescription/prescription_item/": { "get": { "operationId": "eprescription_prescription_item_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "article_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "article_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "article_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "article_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "article_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "license_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "license_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "license_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "license_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "license_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patients__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patients__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patients__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patients__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patients__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "pharmacy_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "pharmacy_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "pharmacy_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "pharmacy_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "pharmacy_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "prescription__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "prescription__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "prescription__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "prescription__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "prescription__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "product_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "product_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "product_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "product_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "product_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "row_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "row_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "row_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "row_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "row_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Electronic prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedElectronicPrescriptionItemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedElectronicPrescriptionItemList" } } }, "description": "" } }, "summary": "List Eprescription Prescription Item" } }, "/eprescription/prescription_item/{id}/": { "get": { "operationId": "eprescription_prescription_item_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this prescription item.", "required": true } ], "tags": [ "Electronic prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElectronicPrescriptionItemDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ElectronicPrescriptionItemDetail" } } }, "description": "" } }, "summary": "Get Eprescription Prescription Item" } }, "/estimate/": { "get": { "operationId": "estimate_list", "description": "Required permissions:\n- Financial: Estimates\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patients__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patients__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patients__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patients__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patients__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Estimates" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEstimateListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedEstimateListList" } } }, "description": "" } }, "summary": "List Estimate" } }, "/estimate/{id}/": { "get": { "operationId": "estimate_retrieve", "description": "Required permissions:\n- Financial: Estimates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate.", "required": true } ], "tags": [ "Estimates" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/EstimateDetail" } } }, "description": "" } }, "summary": "Get Estimate" } }, "/estimateitem/": { "get": { "operationId": "estimateitem_list", "description": "Required permissions:\n- Financial: Estimates\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "estimate__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "estimate__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "estimate__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "estimate__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "estimate__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "type_code__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "type_code__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "type_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type_code__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "type_code__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "type_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type_code__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "type_code__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Estimates" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEstimateItemListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedEstimateItemListList" } } }, "description": "" } }, "summary": "List Estimateitem" } }, "/estimateitem/{id}/": { "get": { "operationId": "estimateitem_retrieve", "description": "Required permissions:\n- Financial: Estimates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate item.", "required": true } ], "tags": [ "Estimates" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateItemDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/EstimateItemDetail" } } }, "description": "" } }, "summary": "Get Estimateitem" } }, "/estimateitemtemplateuse/": { "get": { "operationId": "estimateitemtemplateuse_list", "description": "Required permissions:\n- Financial: Estimates\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "base_template__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "base_template__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "base_template__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "base_template__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "base_template__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "estimate__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "estimate__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "estimate__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "estimate__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "estimate__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "estimateitemtemplateuse" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEstimateItemTemplateUseList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedEstimateItemTemplateUseList" } } }, "description": "" } }, "summary": "List Estimateitemtemplateuse" } }, "/estimateitemtemplateuse/{id}/": { "get": { "operationId": "estimateitemtemplateuse_retrieve", "description": "Required permissions:\n- Financial: Estimates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate item template use.", "required": true } ], "tags": [ "estimateitemtemplateuse" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateItemTemplateUse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/EstimateItemTemplateUse" } } }, "description": "" } }, "summary": "Get Estimateitemtemplateuse" } }, "/fiscal_data/": { "get": { "operationId": "fiscal_data_list", "description": "Fiscal Data\n\nManage fiscal data records for invoices and transactions.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "fiscal_data" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedFiscalDataList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedFiscalDataList" } } }, "description": "" } }, "summary": "List Fiscal Data" }, "post": { "operationId": "fiscal_data_create", "description": "Fiscal Data\n\nManage fiscal data records for invoices and transactions.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "fiscal_data" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDataRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FiscalDataRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FiscalDataRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalData" } }, "text/html": { "schema": { "$ref": "#/components/schemas/FiscalData" } } }, "description": "" } }, "summary": "Create Fiscal Data" } }, "/fiscal_data/{id}/": { "get": { "operationId": "fiscal_data_retrieve", "description": "Fiscal Data\n\nManage fiscal data records for invoices and transactions.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this fiscal data.", "required": true } ], "tags": [ "fiscal_data" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalData" } }, "text/html": { "schema": { "$ref": "#/components/schemas/FiscalData" } } }, "description": "" } }, "summary": "Get Fiscal Data" }, "put": { "operationId": "fiscal_data_update", "description": "Fiscal Data\n\nManage fiscal data records for invoices and transactions.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this fiscal data.", "required": true } ], "tags": [ "fiscal_data" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalDataRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FiscalDataRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FiscalDataRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalData" } }, "text/html": { "schema": { "$ref": "#/components/schemas/FiscalData" } } }, "description": "" } }, "summary": "Update Fiscal Data" }, "patch": { "operationId": "fiscal_data_partial_update", "description": "Fiscal Data\n\nManage fiscal data records for invoices and transactions.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this fiscal data.", "required": true } ], "tags": [ "fiscal_data" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedFiscalDataRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedFiscalDataRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedFiscalDataRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FiscalData" } }, "text/html": { "schema": { "$ref": "#/components/schemas/FiscalData" } } }, "description": "" } }, "summary": "Patch Fiscal Data" }, "delete": { "operationId": "fiscal_data_destroy", "description": "Fiscal Data\n\nManage fiscal data records for invoices and transactions.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this fiscal data.", "required": true } ], "tags": [ "fiscal_data" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Fiscal Data" } }, "/food/": { "get": { "operationId": "food_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "created_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "created_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_2__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_2__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_3__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_3__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modified_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modified_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Foods" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedFoodListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedFoodListList" } } }, "description": "" } }, "summary": "List Food" }, "post": { "operationId": "food_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Foods" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Food" } }, "/food/{id}/": { "get": { "operationId": "food_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this food.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Foods" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Food" }, "put": { "operationId": "food_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this food.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Foods" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update Food" }, "patch": { "operationId": "food_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this food.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Foods" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch Food" }, "delete": { "operationId": "food_destroy", "description": "Archives an item.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this food.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Foods" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Food" } }, "/form_assignment/": { "get": { "operationId": "form_assignment_retrieve", "description": "List form assignments with metadata (without PDF content).\n\nReturns form assignment metadata including the context (what entity type\nthe form is attached to) and resolved client_id/patient_id for migration.\n\nThe `context` field indicates what the `reference_id` points to:\n- \"patient\" → reference_id is a Patient.id\n- \"client\" → reference_id is a Client.id\n- \"consultation\" → reference_id is a Consultation.id\n- \"discharge_note\" → reference_id is a ConsultationDischargeinstruction.id\n- etc.\n\nThe `client_id` and `patient_id` fields are resolved from the reference,\nnavigating through consultations/discharge instructions as needed.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "form_assignment" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Form Assignment" } }, "/form_assignment/{id}/": { "get": { "operationId": "form_assignment_retrieve_2", "description": "Get form assignment as PDF.\n\nReturns the form assignment rendered as a PDF document in base64 format.\nSupports all form types: Build, Document, PDF, and E-signature forms.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "form_assignment" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Form Assignment" } }, "/general_prescription/": { "get": { "operationId": "general_prescription_list", "description": "Category view for general prescription APIs.\n\nThis view does not require permissions because it only lists other APIs.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } } } }, "text/html": { "schema": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } } } } }, "description": "" } }, "summary": "List General Prescription" } }, "/general_prescription/medicine_metadata/": { "get": { "operationId": "general_prescription_medicine_metadata_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMedicineMetaDataList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedMedicineMetaDataList" } } }, "description": "" } }, "summary": "List General Prescription Medicine Metadata" } }, "/general_prescription/medicine_metadata/{id}/": { "get": { "operationId": "general_prescription_medicine_metadata_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this medicine meta data.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MedicineMetaDataDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/MedicineMetaDataDetail" } } }, "description": "" } }, "summary": "Get Metadata for General Prescription Medicine" } }, "/general_prescription/prescription_item/": { "get": { "operationId": "general_prescription_prescription_item_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "modified__gt", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "modified__gte", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "modified__lt", "schema": { "type": "string", "format": "date-time" } }, { "in": "query", "name": "modified__lte", "schema": { "type": "string", "format": "date-time" } }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGeneralPrescriptionItemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedGeneralPrescriptionItemList" } } }, "description": "" } }, "summary": "List General Prescription Prescription Item" }, "post": { "operationId": "general_prescription_prescription_item_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create General Prescription Prescription Item" } }, "/general_prescription/prescription_item/{id}/": { "get": { "operationId": "general_prescription_prescription_item_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this general prescription item.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralPrescriptionItemDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/GeneralPrescriptionItemDetail" } } }, "description": "" } }, "summary": "Get General Prescription Prescription Item" }, "delete": { "operationId": "general_prescription_prescription_item_destroy", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this general prescription item.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete General Prescription Prescription Item" } }, "/general_prescription/written_prescription/": { "get": { "operationId": "general_prescription_written_prescription_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "issue_time__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "issue_time__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "issue_time__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "issue_time__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "issue_time__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "issue_time__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "issue_time__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "issue_time__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "written_prescription_extras__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "written_prescription_extras__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "written_prescription_extras__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "written_prescription_extras__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "written_prescription_extras__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "written_prescription_extras__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "written_prescription_extras__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "written_prescription_extras__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "written_prescription_extras__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "written_prescription_extras__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "written_prescription_extras__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "written_prescription_extras__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "written_prescription_extras__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "written_prescription_extras__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "written_prescription_extras__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWrittenPrescriptionList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedWrittenPrescriptionList" } } }, "description": "" } }, "summary": "List General Prescription Written Prescription" }, "post": { "operationId": "general_prescription_written_prescription_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create General Prescription Written Prescription" } }, "/general_prescription/written_prescription/{id}/": { "get": { "operationId": "general_prescription_written_prescription_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this written prescription.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionDetail" } } }, "description": "" } }, "summary": "Get General Prescription Written Prescription" }, "put": { "operationId": "general_prescription_written_prescription_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this written prescription.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update General Prescription Written Prescription" }, "patch": { "operationId": "general_prescription_written_prescription_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this written prescription.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch General Prescription Written Prescription" }, "delete": { "operationId": "general_prescription_written_prescription_destroy", "description": "Archives an item.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this written prescription.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete General Prescription Written Prescription" } }, "/general_prescription/written_prescription_extras/": { "get": { "operationId": "general_prescription_written_prescription_extras_list", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWrittenPrescriptionExtrasList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedWrittenPrescriptionExtrasList" } } }, "description": "" } }, "summary": "List General Prescription Written Prescription Extras" }, "post": { "operationId": "general_prescription_written_prescription_extras_create", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Written prescriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdate" } } }, "description": "" } }, "summary": "Create General Prescription Written Prescription Extras" } }, "/general_prescription/written_prescription_extras/{id}/": { "get": { "operationId": "general_prescription_written_prescription_extras_retrieve", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this written prescription extras.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtras" } } }, "description": "" } }, "summary": "Get General Prescription Written Prescription Extras" }, "put": { "operationId": "general_prescription_written_prescription_extras_update", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this written prescription extras.", "required": true } ], "tags": [ "Written prescriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdate" } } }, "description": "" } }, "summary": "Update General Prescription Written Prescription Extras" }, "patch": { "operationId": "general_prescription_written_prescription_extras_partial_update", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this written prescription extras.", "required": true } ], "tags": [ "Written prescriptions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWrittenPrescriptionExtrasCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedWrittenPrescriptionExtrasCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedWrittenPrescriptionExtrasCreateUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WrittenPrescriptionExtrasCreateUpdate" } } }, "description": "" } }, "summary": "Patch General Prescription Written Prescription Extras" }, "delete": { "operationId": "general_prescription_written_prescription_extras_destroy", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this written prescription extras.", "required": true } ], "tags": [ "Written prescriptions" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete General Prescription Written Prescription Extras" } }, "/get_max_client_id/": { "get": { "operationId": "get_max_client_id_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Clients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Get Max Client Id" } }, "/get_max_patient_id/": { "get": { "operationId": "get_max_patient_id_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Get Max Patient Id" } }, "/healthplan/": { "get": { "operationId": "healthplan_list", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "additional_departments__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "additional_departments__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "additional_departments__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "additional_departments__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "additional_departments__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department", "schema": { "type": "integer" }, "description": "With `patient`: the clinic location the shopper is buying from. Availability covers the department itself, plans listing it as an additional department, and centrally managed plans. Without `patient`: a plain equality filter on the plan's department." }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "display_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "display_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "display_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "display_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "display_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "display_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "display_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "display_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient", "schema": { "type": "integer" }, "description": "Patient id. Requires `department`. Narrows the list to the plans this patient can join at that location: species, age and weight match, and the plan is active and inside its validity window." }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Health plans", "Health plan self-service" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHealthPlanListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHealthPlanListList" } } }, "description": "" } }, "summary": "List Healthplan" }, "post": { "operationId": "healthplan_create", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HealthPlanRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HealthPlanRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlan" } } }, "description": "" } }, "summary": "Create Healthplan" } }, "/healthplan/{id}/": { "get": { "operationId": "healthplan_retrieve", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan.", "required": true } ], "tags": [ "Health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlan" } } }, "description": "" } }, "summary": "Get Healthplan" }, "put": { "operationId": "healthplan_update", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan.", "required": true } ], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HealthPlanRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HealthPlanRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlan" } } }, "description": "" } }, "summary": "Update Healthplan" }, "patch": { "operationId": "healthplan_partial_update", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan.", "required": true } ], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlan" } } }, "description": "" } }, "summary": "Patch Healthplan" } }, "/healthplanitem/": { "get": { "operationId": "healthplanitem_list", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "health_plan__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "health_plan__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "health_plan__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "health_plan__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "health_plan__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "health_plan_item_group__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "health_plan_item_group__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "health_plan_item_group__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "health_plan_item_group__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "health_plan_item_group__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "type_code__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "type_code__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "type_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type_code__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "type_code__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "type_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type_code__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "type_code__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHealthPlanItemListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHealthPlanItemListList" } } }, "description": "" } }, "summary": "List Healthplanitem" }, "post": { "operationId": "healthplanitem_create", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HealthPlanItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HealthPlanItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanItem" } } }, "description": "" } }, "summary": "Create Healthplanitem" } }, "/healthplanitem/{id}/": { "get": { "operationId": "healthplanitem_retrieve", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan item.", "required": true } ], "tags": [ "Health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanItem" } } }, "description": "" } }, "summary": "Get Healthplanitem" }, "put": { "operationId": "healthplanitem_update", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan item.", "required": true } ], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HealthPlanItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HealthPlanItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanItem" } } }, "description": "" } }, "summary": "Update Healthplanitem" }, "patch": { "operationId": "healthplanitem_partial_update", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan item.", "required": true } ], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanItemRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanItem" } } }, "description": "" } }, "summary": "Patch Healthplanitem" } }, "/healthplanitemgroup/": { "get": { "operationId": "healthplanitemgroup_list", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "health_plans__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "health_plans__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "health_plans__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "health_plans__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "health_plans__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHealthPlanItemGroupListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHealthPlanItemGroupListList" } } }, "description": "" } }, "summary": "List Healthplanitemgroup" }, "post": { "operationId": "healthplanitemgroup_create", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroup" } } }, "description": "" } }, "summary": "Create Healthplanitemgroup" } }, "/healthplanitemgroup/{id}/": { "get": { "operationId": "healthplanitemgroup_retrieve", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan item group.", "required": true } ], "tags": [ "Health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroup" } } }, "description": "" } }, "summary": "Get Healthplanitemgroup" }, "put": { "operationId": "healthplanitemgroup_update", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan item group.", "required": true } ], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroup" } } }, "description": "" } }, "summary": "Update Healthplanitemgroup" }, "patch": { "operationId": "healthplanitemgroup_partial_update", "description": "Required permissions:\n- Settings: Health plan settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this health plan item group.", "required": true } ], "tags": [ "Health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanItemGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanItemGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedHealthPlanItemGroupRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanItemGroup" } } }, "description": "" } }, "summary": "Patch Healthplanitemgroup" } }, "/holdingplacenumbers/": { "get": { "operationId": "holdingplacenumbers_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Holding place numbers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedClientHoldingPlaceList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedClientHoldingPlaceList" } } }, "description": "" } }, "summary": "List Holdingplacenumbers" }, "post": { "operationId": "holdingplacenumbers_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Holding place numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlaceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlaceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlaceRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlace" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlace" } } }, "description": "" } }, "summary": "Create Holdingplacenumbers" } }, "/holdingplacenumbers/{id}/": { "get": { "operationId": "holdingplacenumbers_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this holding place numbers.", "required": true } ], "tags": [ "Holding place numbers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlace" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlace" } } }, "description": "" } }, "summary": "Get Holdingplacenumbers" }, "put": { "operationId": "holdingplacenumbers_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this holding place numbers.", "required": true } ], "tags": [ "Holding place numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlaceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlaceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlaceRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlace" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlace" } } }, "description": "" } }, "summary": "Update Holdingplacenumbers" }, "patch": { "operationId": "holdingplacenumbers_partial_update", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this holding place numbers.", "required": true } ], "tags": [ "Holding place numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedClientHoldingPlaceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedClientHoldingPlaceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedClientHoldingPlaceRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlace" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ClientHoldingPlace" } } }, "description": "" } }, "summary": "Patch Holdingplacenumbers" }, "delete": { "operationId": "holdingplacenumbers_destroy", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this holding place numbers.", "required": true } ], "tags": [ "Holding place numbers" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Holdingplacenumbers" } }, "/home_delivery/": { "get": { "operationId": "home_delivery_list", "description": "Category view for Home Delivery APIs.\n\nThis view does not require permissions because it only lists other APIs.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } } } }, "text/html": { "schema": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "type": "object", "additionalProperties": {}, "description": "Unspecified response body" } } } } } }, "description": "" } }, "summary": "List Home Delivery" } }, "/home_delivery/client_data/": { "get": { "operationId": "home_delivery_client_data_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryClientDataList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryClientDataList" } } }, "description": "" } }, "summary": "List Home Delivery Client Data" } }, "/home_delivery/client_data/{id}/": { "get": { "operationId": "home_delivery_client_data_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this home delivery client data.", "required": true } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDeliveryClientData" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HomeDeliveryClientData" } } }, "description": "" } }, "summary": "Get Home Delivery Client Data" } }, "/home_delivery/department_data/": { "get": { "operationId": "home_delivery_department_data_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryDepartmentDataList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryDepartmentDataList" } } }, "description": "" } }, "summary": "List Home Delivery Department Data" } }, "/home_delivery/department_data/{id}/": { "get": { "operationId": "home_delivery_department_data_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this home delivery department data.", "required": true } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDeliveryDepartmentData" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HomeDeliveryDepartmentData" } } }, "description": "" } }, "summary": "Get Home Delivery Department Data" } }, "/home_delivery/item/": { "get": { "operationId": "home_delivery_item_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "invoice__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryItemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryItemList" } } }, "description": "" } }, "summary": "List Home Delivery Item" } }, "/home_delivery/item/{id}/": { "get": { "operationId": "home_delivery_item_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this home delivery item.", "required": true } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItem" } } }, "description": "" } }, "summary": "Get Home Delivery Item" } }, "/home_delivery/item/{id}/update_status/": { "put": { "operationId": "home_delivery_item_update_status_update", "description": "Update status of home delivery item\n\nParameters:\n- status (int|choice) - Status can be updated to value from listed below. Options: 0 (Received), 1 (Submitted), 2 (Quarantined), 3 (Sent to wholesaler), 4 (Not dispatched), 5 (In Delivery), 6 (Cancelled), 7 (DNP returned in Mail), 8 (DNP returned by wholesaler), 9 (Delivered)\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this home delivery item.", "required": true } ], "tags": [ "home_delivery" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItemStatusUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItemStatusUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItemStatusUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItemStatusUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItemStatusUpdate" } } }, "description": "" } }, "summary": "Update Home Delivery Item Update Status" }, "patch": { "operationId": "home_delivery_item_update_status_partial_update", "description": "Update status of home delivery item\n\nParameters:\n- status (int|choice) - Status can be updated to value from listed below. Options: 0 (Received), 1 (Submitted), 2 (Quarantined), 3 (Sent to wholesaler), 4 (Not dispatched), 5 (In Delivery), 6 (Cancelled), 7 (DNP returned in Mail), 8 (DNP returned by wholesaler), 9 (Delivered)\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this home delivery item.", "required": true } ], "tags": [ "home_delivery" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedHomeDeliveryItemStatusUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedHomeDeliveryItemStatusUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedHomeDeliveryItemStatusUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItemStatusUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HomeDeliveryItemStatusUpdate" } } }, "description": "" } }, "summary": "Patch Home Delivery Item Update Status" } }, "/home_delivery/order/": { "get": { "operationId": "home_delivery_order_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryOrderList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryOrderList" } } }, "description": "" } }, "summary": "List Home Delivery Order" } }, "/home_delivery/order/{id}/": { "get": { "operationId": "home_delivery_order_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this home delivery order.", "required": true } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDeliveryOrder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HomeDeliveryOrder" } } }, "description": "" } }, "summary": "Get Home Delivery Order" } }, "/home_delivery/patient_data/": { "get": { "operationId": "home_delivery_patient_data_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryPatientDataList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHomeDeliveryPatientDataList" } } }, "description": "" } }, "summary": "List Home Delivery Patient Data" } }, "/home_delivery/patient_data/{id}/": { "get": { "operationId": "home_delivery_patient_data_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this home delivery patient data.", "required": true } ], "tags": [ "home_delivery" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HomeDeliveryPatientData" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HomeDeliveryPatientData" } } }, "description": "" } }, "summary": "Get Home Delivery Patient Data" } }, "/hook/queue/": { "get": { "operationId": "hook_queue_list", "description": "Required permissions:\n- Settings: Integration settings\n

Or

\n- Settings: Manage webhooks via API\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "attempts__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "attempts__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "attempts__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "attempts__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "attempts__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "attempts__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "attempts__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "attempts__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "attempts__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "attempts__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "object_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "object_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "object_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "object_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "object_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "success__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "success__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "webhook__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "webhook__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "webhook__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "webhook__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "webhook__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Webhooks" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHookNotificationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHookNotificationList" } } }, "description": "" } }, "summary": "List Hook Queue" } }, "/hook/queue/{id}/": { "get": { "operationId": "hook_queue_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n

Or

\n- Settings: Manage webhooks via API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this hook notification.", "required": true } ], "tags": [ "Webhooks" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookNotification" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HookNotification" } } }, "description": "" } }, "summary": "Get Hook Queue" } }, "/hook/webhook/": { "get": { "operationId": "hook_webhook_list", "description": "Required permissions:\n- Settings: Integration settings\n

Or

\n- Settings: Manage webhooks via API\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "created_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "created_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Webhooks" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWebhookList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedWebhookList" } } }, "description": "" } }, "summary": "List Hook Webhook" }, "post": { "operationId": "hook_webhook_create", "description": "Required permissions:\n- Settings: Integration settings\n

Or

\n- Settings: Manage webhooks via API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Webhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Create Hook Webhook" } }, "/hook/webhook/{id}/": { "get": { "operationId": "hook_webhook_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n

Or

\n- Settings: Manage webhooks via API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this webhook.", "required": true } ], "tags": [ "Webhooks" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Get Hook Webhook" }, "put": { "operationId": "hook_webhook_update", "description": "Required permissions:\n- Settings: Integration settings\n

Or

\n- Settings: Manage webhooks via API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this webhook.", "required": true } ], "tags": [ "Webhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Update Hook Webhook" }, "patch": { "operationId": "hook_webhook_partial_update", "description": "Required permissions:\n- Settings: Integration settings\n

Or

\n- Settings: Manage webhooks via API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this webhook.", "required": true } ], "tags": [ "Webhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWebhookRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedWebhookRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedWebhookRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "description": "" } }, "summary": "Patch Hook Webhook" }, "delete": { "operationId": "hook_webhook_destroy", "description": "Required permissions:\n- Settings: Integration settings\n

Or

\n- Settings: Manage webhooks via API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this webhook.", "required": true } ], "tags": [ "Webhooks" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Hook Webhook" } }, "/imagingcategory/": { "get": { "operationId": "imagingcategory_list", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modality__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modality__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modality__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modality__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modality__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Imaging categories" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedImagingCategoryListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedImagingCategoryListList" } } }, "description": "" } }, "summary": "List Imagingcategory" } }, "/imagingcategory/{id}/": { "get": { "operationId": "imagingcategory_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this imaging category.", "required": true } ], "tags": [ "Imaging categories" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImagingCategoryDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ImagingCategoryDetail" } } }, "description": "" } }, "summary": "Get Imagingcategory" } }, "/imagingsubcategory/": { "get": { "operationId": "imagingsubcategory_list", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "category__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "category__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "category__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "category__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "category__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Imaging categories" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedImagingSubCategoryListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedImagingSubCategoryListList" } } }, "description": "" } }, "summary": "List Imagingsubcategory" } }, "/imagingsubcategory/{id}/": { "get": { "operationId": "imagingsubcategory_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this imaging sub category.", "required": true } ], "tags": [ "Imaging categories" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImagingSubCategoryDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ImagingSubCategoryDetail" } } }, "description": "" } }, "summary": "Get Imagingsubcategory" } }, "/importedhistory/": { "get": { "operationId": "importedhistory_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Imported histories" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedImportedHistoryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedImportedHistoryList" } } }, "description": "" } }, "summary": "List Importedhistory" }, "post": { "operationId": "importedhistory_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Imported histories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedHistoryRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ImportedHistoryRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ImportedHistoryRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedHistory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ImportedHistory" } } }, "description": "" } }, "summary": "Create Importedhistory" } }, "/importedhistory/{id}/": { "get": { "operationId": "importedhistory_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this imported history.", "required": true } ], "tags": [ "Imported histories" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedHistory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ImportedHistory" } } }, "description": "" } }, "summary": "Get Importedhistory" }, "put": { "operationId": "importedhistory_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this imported history.", "required": true } ], "tags": [ "Imported histories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedHistoryRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ImportedHistoryRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ImportedHistoryRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedHistory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ImportedHistory" } } }, "description": "" } }, "summary": "Update Importedhistory" }, "patch": { "operationId": "importedhistory_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this imported history.", "required": true } ], "tags": [ "Imported histories" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedImportedHistoryRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedImportedHistoryRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedImportedHistoryRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedHistory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ImportedHistory" } } }, "description": "" } }, "summary": "Patch Importedhistory" }, "delete": { "operationId": "importedhistory_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this imported history.", "required": true } ], "tags": [ "Imported histories" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Importedhistory" } }, "/insuranceclaim/": { "get": { "operationId": "insuranceclaim_list", "description": "Required permissions:\n- Financial: Insurance claims\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "case_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "invoice__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "reference_number__is", "schema": { "type": "string" }, "description": "Exact match" } ], "tags": [ "Insurance claims" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInsuranceClaimList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInsuranceClaimList" } } }, "description": "" } }, "summary": "List Insuranceclaim" } }, "/insuranceclaim/{id}/": { "get": { "operationId": "insuranceclaim_retrieve", "description": "Required permissions:\n- Financial: Insurance claims\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this claim.", "required": true } ], "tags": [ "Insurance claims" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsuranceClaimDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InsuranceClaimDetail" } } }, "description": "" } }, "summary": "Get Insuranceclaim" }, "put": { "operationId": "insuranceclaim_update", "description": "Required permissions:\n- Financial: Insurance claims\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this claim.", "required": true } ], "tags": [ "Insurance claims" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsuranceClaimRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InsuranceClaimRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InsuranceClaimRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsuranceClaim" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InsuranceClaim" } } }, "description": "" } }, "summary": "Update Insuranceclaim" }, "patch": { "operationId": "insuranceclaim_partial_update", "description": "Required permissions:\n- Financial: Insurance claims\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this claim.", "required": true } ], "tags": [ "Insurance claims" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedInsuranceClaimRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedInsuranceClaimRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedInsuranceClaimRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsuranceClaim" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InsuranceClaim" } } }, "description": "" } }, "summary": "Patch Insuranceclaim" } }, "/insuranceclaimclient/": { "get": { "operationId": "insuranceclaimclient_list", "description": "Required permissions:\n- Financial: Insurance claims\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Insurance claims" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInsuranceClaimClientList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInsuranceClaimClientList" } } }, "description": "" } }, "summary": "List Insuranceclaimclient" } }, "/insuranceclaimclient/{id}/": { "get": { "operationId": "insuranceclaimclient_retrieve", "description": "Required permissions:\n- Financial: Insurance claims\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this claim client.", "required": true } ], "tags": [ "Insurance claims" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsuranceClaimClientDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InsuranceClaimClientDetail" } } }, "description": "" } }, "summary": "Get Insuranceclaimclient" } }, "/insuranceclaimpatient/": { "get": { "operationId": "insuranceclaimpatient_list", "description": "Required permissions:\n- Financial: Insurance claims\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Insurance claims" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInsuranceClaimPatientList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInsuranceClaimPatientList" } } }, "description": "" } }, "summary": "List Insuranceclaimpatient" } }, "/insuranceclaimpatient/{id}/": { "get": { "operationId": "insuranceclaimpatient_retrieve", "description": "Required permissions:\n- Financial: Insurance claims\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this claim patient.", "required": true } ], "tags": [ "Insurance claims" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsuranceClaimPatientDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InsuranceClaimPatientDetail" } } }, "description": "" } }, "summary": "Get Insuranceclaimpatient" } }, "/invoice/": { "get": { "operationId": "invoice_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 60 requests per minute.", "parameters": [ { "in": "query", "name": "_invoice_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "_invoice_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "_invoice_prefix__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "_invoice_prefix__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "_invoice_prefix__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "_invoice_prefix__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "_invoice_prefix__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "_invoice_prefix__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "_invoice_prefix__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "_invoice_prefix__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "_status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "_status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "client_due_sum__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "client_due_sum__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "client_due_sum__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client_due_sum__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client_due_sum__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client_due_sum__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "client_due_sum__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "client_due_sum__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "client_due_sum__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "client_due_sum__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "consolidated_invoice__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consolidated_invoice__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "countersale__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "countersale__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "credit_note__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "credit_note__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "date_paid__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "date_paid__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "date_paid__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "date_paid__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "date_paid__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "date_paid__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "date_paid__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "date_paid__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "due_sum__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "due_sum__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "due_sum__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "due_sum__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "due_sum__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "due_sum__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "due_sum__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "due_sum__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "due_sum__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "due_sum__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "invoice_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "invoice_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "invoice_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "invoice_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "invoice_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "invoice_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "invoice_due_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "invoice_due_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "invoice_due_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice_due_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice_due_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "invoice_due_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "invoice_due_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "invoice_due_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "invoice_extras__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "invoice_extras__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "invoice_extras__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "invoice_extras__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "invoice_extras__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "invoice_extras__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "invoice_extras__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice_extras__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice_extras__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice_extras__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice_extras__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "invoice_extras__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "invoice_extras__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "invoice_extras__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "invoice_extras__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "reference_number__is", "schema": { "type": "string" }, "description": "Exact match" } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceList" } } }, "description": "" } }, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Response schema corrected: status is now documented as integer (was string), and total/total_vat/total_with_vat are documented as numeric Decimal (were strings). API behavior is unchanged; the previous documentation did not match what the endpoint has always returned.", "summary": "List Invoice" } }, "/invoice/{parent_lookup_invoice}/extras/": { "get": { "operationId": "invoice_extras_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_invoice", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceExtrasList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceExtrasList" } } }, "description": "" } }, "summary": "List Invoice Extras" }, "post": { "operationId": "invoice_extras_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_invoice", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceExtras" } } }, "description": "" } }, "summary": "Create Invoice Extras" } }, "/invoice/{parent_lookup_invoice}/extras/{id}/": { "get": { "operationId": "invoice_extras_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice extras.", "required": true }, { "in": "path", "name": "parent_lookup_invoice", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceExtras" } } }, "description": "" } }, "summary": "Get Invoice Extras" }, "put": { "operationId": "invoice_extras_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice extras.", "required": true }, { "in": "path", "name": "parent_lookup_invoice", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceExtras" } } }, "description": "" } }, "summary": "Update Invoice Extras" }, "patch": { "operationId": "invoice_extras_partial_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice extras.", "required": true }, { "in": "path", "name": "parent_lookup_invoice", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceExtras" } } }, "description": "" } }, "summary": "Patch Invoice Extras" }, "delete": { "operationId": "invoice_extras_destroy", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice extras.", "required": true }, { "in": "path", "name": "parent_lookup_invoice", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Invoice Extras" } }, "/invoice/{parent_lookup_invoice}/pdf/": { "get": { "operationId": "invoice_pdf_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_invoice", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Invoice Pdf" } }, "/invoice/{id}/": { "get": { "operationId": "invoice_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 250 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceDetail" } } }, "description": "" } }, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Response schema corrected: status is now documented as integer (was string), and total/total_vat/total_with_vat are documented as numeric Decimal (were strings). API behavior is unchanged; the previous documentation did not match what the endpoint has always returned.", "summary": "Get Invoice" }, "put": { "operationId": "invoice_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 150 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceUpdate" } } }, "description": "" } }, "summary": "Update Invoice" }, "patch": { "operationId": "invoice_partial_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 150 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceUpdate" } } }, "description": "" } }, "summary": "Patch Invoice" } }, "/invoice/{id}/add_item/": { "get": { "operationId": "invoice_add_item_retrieve", "description": "Add new item\n\nParameters:\n- item (int) - ID for Item\n- quantity (int)\n- usage_size (int|choice) - options:1 (Package), 2 (Units)\n- price (float) - default:Uses amount found from item\n- price_with_vat (float) - default:Uses amount found from item\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Invoice Add Item" }, "post": { "operationId": "invoice_add_item_create", "description": "Add new item\n\nParameters:\n- item (int) - ID for Item\n- quantity (int)\n- usage_size (int|choice) - options:1 (Package), 2 (Units)\n- price (float) - default:Uses amount found from item\n- price_with_vat (float) - default:Uses amount found from item\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Invoice Add Item" }, "put": { "operationId": "invoice_add_item_update", "description": "Add new item\n\nParameters:\n- item (int) - ID for Item\n- quantity (int)\n- usage_size (int|choice) - options:1 (Package), 2 (Units)\n- price (float) - default:Uses amount found from item\n- price_with_vat (float) - default:Uses amount found from item\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update Invoice Add Item" } }, "/invoice/{id}/cloudprnt/": { "post": { "operationId": "invoice_cloudprnt_create", "description": "Trigger cloudPRNT for the invoice\n\nParameters:\n- printer_id (int) - id of the cloud printer. Printer must not be archived.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Invoice" } } }, "description": "" } }, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Response schema corrected: status is now documented as integer (was string), and total/total_vat/total_with_vat are documented as numeric Decimal (were strings). API behavior is unchanged; the previous documentation did not match what the endpoint has always returned.", "summary": "Create Invoice Cloudprnt" } }, "/invoice/{id}/full_refund/": { "get": { "operationId": "invoice_full_refund_retrieve", "description": "Refund Invoice fully\n\nParameters:\n- use_original_invoice_date (bool)\n- create_commission_rows (bool)\n- create_as_draft (bool)\n- eu_company_without_vat (bool) - Set 0% VAT for EU company invoice\n- override_client_vat_group (bool) - Use client specific VAT\n- payments (url - invoicepayment) - Payments to refund on invoice\n- payments_action (int) - How to handle payments (1: Move, 2: Prepayment)\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceFullRefund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceFullRefund" } } }, "description": "" } }, "summary": "Get Invoice Full Refund" }, "post": { "operationId": "invoice_full_refund_create", "description": "Refund Invoice fully\n\nParameters:\n- use_original_invoice_date (bool)\n- create_commission_rows (bool)\n- create_as_draft (bool)\n- eu_company_without_vat (bool) - Set 0% VAT for EU company invoice\n- override_client_vat_group (bool) - Use client specific VAT\n- payments (url - invoicepayment) - Payments to refund on invoice\n- payments_action (int) - How to handle payments (1: Move, 2: Prepayment)\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceFullRefundRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceFullRefundRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceFullRefundRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceFullRefund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceFullRefund" } } }, "description": "" } }, "summary": "Create Invoice Full Refund" } }, "/invoice/{id}/generate_qr_code/": { "post": { "operationId": "invoice_generate_qr_code_create", "description": "Generate a QR code for the instance.\nIf a QR code already exists for the instance, the new QR code will replace the existing one.\n\nParameters:\n- title (string)\n- subtitle (string)\n- qr_code_data (string) - Data to be stored in the QR code\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QrCodeCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/QrCodeCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/QrCodeCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QrCodeCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/QrCodeCreate" } } }, "description": "" } }, "summary": "Create Invoice Generate Qr Code" } }, "/invoice/{id}/invoice_date/": { "post": { "operationId": "invoice_invoice_date_create", "description": "Backdate invoice\n\nUsed for backdating the invoice by manually setting invoice_date.\nSets both invoice_date and manual_invoice_date to preserve the invoice_date when\ninvoice is finalized.\nNot for general use.\n - Requires api_staff_token access token to use\n - This endpoint is only enabled for select few provets.\n\n Parameters:\n - invoice_date (datetime) - ISO 8601 format\n - api_staff_token (string) - token for authenticating the request\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDateEditRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceDateEditRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceDateEditRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceDateEdit" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceDateEdit" } } }, "description": "" } }, "summary": "Create Invoice Invoice Date" } }, "/invoice/{id}/partial_refund/": { "get": { "operationId": "invoice_partial_refund_retrieve", "description": "Refund Invoice partially\n\nParameters:\n- use_original_invoice_date (bool)\n- create_commission_rows (bool)\n- create_as_draft (bool)\n- eu_company_without_vat (bool) - Set 0% VAT for EU company invoice\n- override_client_vat_group (bool) - Use client specific VAT\n- payments (url) - Payments to refund on invoice\n- payments_action (int|choice) - How to handle payments. Options: 1 (Move), 2 (Prepayment)\n- invoice_rows (url|list) - Invoice rows to refund\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePartialRefund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePartialRefund" } } }, "description": "" } }, "summary": "Get Invoice Partial Refund" }, "post": { "operationId": "invoice_partial_refund_create", "description": "Refund Invoice partially\n\nParameters:\n- use_original_invoice_date (bool)\n- create_commission_rows (bool)\n- create_as_draft (bool)\n- eu_company_without_vat (bool) - Set 0% VAT for EU company invoice\n- override_client_vat_group (bool) - Use client specific VAT\n- payments (url) - Payments to refund on invoice\n- payments_action (int|choice) - How to handle payments. Options: 1 (Move), 2 (Prepayment)\n- invoice_rows (url|list) - Invoice rows to refund\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePartialRefundRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoicePartialRefundRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoicePartialRefundRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePartialRefund" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePartialRefund" } } }, "description": "" } }, "summary": "Create Invoice Partial Refund" } }, "/invoicegroup/": { "get": { "operationId": "invoicegroup_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemSubgroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemSubgroupList" } } }, "description": "" } }, "summary": "List Invoicegroup" }, "post": { "operationId": "invoicegroup_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } } }, "description": "" } }, "summary": "Create Invoicegroup" } }, "/invoicegroup/{id}/": { "get": { "operationId": "invoicegroup_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Item subgroup.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } } }, "description": "" } }, "summary": "Get Invoicegroup" }, "put": { "operationId": "invoicegroup_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Item subgroup.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } } }, "description": "" } }, "summary": "Update Invoicegroup" }, "patch": { "operationId": "invoicegroup_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Item subgroup.", "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedItemSubgroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedItemSubgroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedItemSubgroupRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } } }, "description": "" } }, "summary": "Patch Invoicegroup" }, "delete": { "operationId": "invoicegroup_destroy", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Item subgroup.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Invoicegroup" } }, "/invoicepayment/": { "get": { "operationId": "invoicepayment_list", "description": "List Payments\n\nReturns a paginated list of all Invoice Payments.\n\nCurrent payment_types are:\n- Credit card = 0\n- Cash = 1\n- Bank payment = 2\n- Rounding = 3\n- Cheque = 4\n- Voucher = 5\n- Consolidated invoice = 6\n- Mobile payment = 7\n- Prepayment = 8\n- Present card = 9\n- Financing company = 10\n- Other = 11\n- Credit invoice = 12\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "claim_payment__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "claim_payment__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "claim_payment__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "claim_payment__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "claim_payment__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "claim_payment__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "claim_payment__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "claim_payment__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "claim_payment__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "claim_payment__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "date_added__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "date_added__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "date_added__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "date_added__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "date_added__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "date_added__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "date_added__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "date_added__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "invoice__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "invoice_payment_extras__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "invoice_payment_extras__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "invoice_payment_extras__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "invoice_payment_extras__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "invoice_payment_extras__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "invoice_payment_extras__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "invoice_payment_extras__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice_payment_extras__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice_payment_extras__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice_payment_extras__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice_payment_extras__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "invoice_payment_extras__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "invoice_payment_extras__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "invoice_payment_extras__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "invoice_payment_extras__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "payment_method__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "payment_method__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "payment_method__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "payment_method__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "payment_method__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Invoice payments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInvoicePaymentDetailList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInvoicePaymentDetailList" } } }, "description": "" } }, "summary": "List Invoicepayment" }, "post": { "operationId": "invoicepayment_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Invoice payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreate" } } }, "description": "" } }, "summary": "Create Invoicepayment" } }, "/invoicepayment/{parent_lookup_invoice_payment}/extras/": { "get": { "operationId": "invoicepayment_extras_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_invoice_payment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoice payments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInvoicePaymentExtrasList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInvoicePaymentExtrasList" } } }, "description": "" } }, "summary": "List Invoicepayment Extras" }, "post": { "operationId": "invoicepayment_extras_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_invoice_payment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoice payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtras" } } }, "description": "" } }, "summary": "Create Invoicepayment Extras" } }, "/invoicepayment/{parent_lookup_invoice_payment}/extras/{id}/": { "get": { "operationId": "invoicepayment_extras_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment extras.", "required": true }, { "in": "path", "name": "parent_lookup_invoice_payment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoice payments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtras" } } }, "description": "" } }, "summary": "Get Invoicepayment Extras" }, "put": { "operationId": "invoicepayment_extras_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment extras.", "required": true }, { "in": "path", "name": "parent_lookup_invoice_payment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoice payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtras" } } }, "description": "" } }, "summary": "Update Invoicepayment Extras" }, "patch": { "operationId": "invoicepayment_extras_partial_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment extras.", "required": true }, { "in": "path", "name": "parent_lookup_invoice_payment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoice payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedInvoicePaymentExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedInvoicePaymentExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedInvoicePaymentExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentExtras" } } }, "description": "" } }, "summary": "Patch Invoicepayment Extras" }, "delete": { "operationId": "invoicepayment_extras_destroy", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment extras.", "required": true }, { "in": "path", "name": "parent_lookup_invoice_payment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoice payments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Invoicepayment Extras" } }, "/invoicepayment/{id}/": { "get": { "operationId": "invoicepayment_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment.", "required": true } ], "tags": [ "Invoice payments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentDetail" } } }, "description": "" } }, "summary": "Get Invoicepayment" }, "put": { "operationId": "invoicepayment_update", "description": "Update Payment\n\nOnly partial updates to invoice payments are allowed for now.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment.", "required": true } ], "tags": [ "Invoice payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreate" } } }, "description": "" } }, "summary": "Update Invoicepayment" }, "patch": { "operationId": "invoicepayment_partial_update", "description": "Partially update Payment\n\nUpdates partial data of an invoice payment.\nCurrently only the `status` and `status_updated` fields are supported.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment.", "required": true } ], "tags": [ "Invoice payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedInvoicePaymentPartialDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedInvoicePaymentPartialDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedInvoicePaymentPartialDetailRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentPartialDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentPartialDetail" } } }, "description": "" } }, "summary": "Patch Invoicepayment" } }, "/invoicepayment/{id}/cancel_payment/": { "post": { "operationId": "invoicepayment_cancel_payment_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment.", "required": true } ], "tags": [ "Invoice payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoicePaymentCreate" } } }, "description": "" } }, "summary": "Create Invoicepayment Cancel Payment" } }, "/invoicepayment/{id}/generate_qr_code/": { "post": { "operationId": "invoicepayment_generate_qr_code_create", "description": "Generate a QR code for the instance.\nIf a QR code already exists for the instance, the new QR code will replace the existing one.\n\nParameters:\n- title (string)\n- subtitle (string)\n- qr_code_data (string) - Data to be stored in the QR code\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice payment.", "required": true } ], "tags": [ "Invoice payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QrCodeCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/QrCodeCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/QrCodeCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QrCodeCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/QrCodeCreate" } } }, "description": "" } }, "summary": "Create Invoicepayment Generate Qr Code" } }, "/invoicerow/": { "get": { "operationId": "invoicerow_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation_item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation_item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "edit_reason__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "edit_reason__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "edit_reason__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "edit_reason__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "edit_reason__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "invoice__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceRowDetailList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceRowDetailList" } } }, "description": "" } }, "summary": "List Invoicerow" } }, "/invoicerow/{parent_lookup_invoicerow}/extras/": { "get": { "operationId": "invoicerow_extras_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_invoicerow", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceRowExtraList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceRowExtraList" } } }, "description": "" } }, "summary": "List Invoicerow Extras" }, "post": { "operationId": "invoicerow_extras_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_invoicerow", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtraRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtraRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtraRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtra" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtra" } } }, "description": "" } }, "summary": "Create Invoicerow Extras" } }, "/invoicerow/{parent_lookup_invoicerow}/extras/{id}/": { "get": { "operationId": "invoicerow_extras_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice row extra.", "required": true }, { "in": "path", "name": "parent_lookup_invoicerow", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtra" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtra" } } }, "description": "" } }, "summary": "Get Invoicerow Extras" }, "put": { "operationId": "invoicerow_extras_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice row extra.", "required": true }, { "in": "path", "name": "parent_lookup_invoicerow", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtraRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtraRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtraRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtra" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtra" } } }, "description": "" } }, "summary": "Update Invoicerow Extras" }, "patch": { "operationId": "invoicerow_extras_partial_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice row extra.", "required": true }, { "in": "path", "name": "parent_lookup_invoicerow", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceRowExtraRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceRowExtraRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedInvoiceRowExtraRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtra" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceRowExtra" } } }, "description": "" } }, "summary": "Patch Invoicerow Extras" }, "delete": { "operationId": "invoicerow_extras_destroy", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice row extra.", "required": true }, { "in": "path", "name": "parent_lookup_invoicerow", "schema": { "type": "string" }, "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Invoicerow Extras" } }, "/invoicerow/{id}/": { "get": { "operationId": "invoicerow_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice row.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceRowDetail" } } }, "description": "" } }, "summary": "Get Invoicerow" } }, "/invoicerow_draft/": { "get": { "operationId": "invoicerow_draft_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation_item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation_item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation_item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation_item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation_item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "invoice__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "invoicerow_draft" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceRowDraftDetailList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceRowDraftDetailList" } } }, "description": "" } }, "summary": "List Invoicerow Draft" } }, "/invoicerow_draft/{id}/": { "get": { "operationId": "invoicerow_draft_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice row draft.", "required": true } ], "tags": [ "invoicerow_draft" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowDraftDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceRowDraftDetail" } } }, "description": "" } }, "summary": "Get Invoicerow Draft" } }, "/invoicerow_draft/{id}/finalize/": { "post": { "operationId": "invoicerow_draft_finalize_create", "description": "Finalize an Invoice row draft\n\nReturns the finalized invoice row id.\n\nRequest parameters:\n- `quantity` (number)\n- `units` (number)\n- `usage_size` (int|choice) - options: 1 (Package), 2 (Units)\n- `stock_location` (int)\n- `batch_number` (str)\n- `tracking_number` (int)\n- `expiry_date` (date)\n\nValidation rules:\n- Either `quantity` (packages) or `units` is required\n- If `usage_size` is not given, the current usage size will be used\n- `tracking_number` is required for controlled medicines\n- `batch_number` is required when the item requires batches\n- `expiry_date` can only be given when `batch_number` is given\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice row draft.", "required": true } ], "tags": [ "invoicerow_draft" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowFinalizeDraftDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InvoiceRowFinalizeDraftDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/InvoiceRowFinalizeDraftDetailRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowFinalizeDraftDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceRowFinalizeDraftDetail" } } }, "description": "" } }, "summary": "Create Invoicerow Draft Finalize" } }, "/invoicerow_vatgroup/": { "get": { "operationId": "invoicerow_vatgroup_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceRowVatGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedInvoiceRowVatGroupList" } } }, "description": "" } }, "summary": "List Invoicerow Vatgroup" } }, "/invoicerow_vatgroup/{id}/": { "get": { "operationId": "invoicerow_vatgroup_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this invoice row vat group.", "required": true } ], "tags": [ "Invoices" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceRowVatGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/InvoiceRowVatGroup" } } }, "description": "" } }, "summary": "Get Invoicerow Vatgroup" } }, "/item/": { "get": { "operationId": "item_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "barcode__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "barcode__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "barcode__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "barcode__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "code", "schema": { "type": "string" } }, { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "created_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "created_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "department", "schema": { "type": "array", "items": { "type": "integer" } }, "explode": true, "style": "form" }, { "in": "query", "name": "external_reporting_code_2__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_2__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_2__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_3__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_3__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "invoice_group__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoice_group__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoice_group__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoice_group__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoice_group__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "main_item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "main_item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "main_item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "main_item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "main_item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modified_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modified_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name", "schema": { "type": "string" } }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "only_cabinet_items", "schema": { "type": "string" }, "description": "Set to 'true' to only include cabinet items in results" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "type_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemListList" } } }, "description": "" } }, "summary": "List Item" } }, "/item/{id}/": { "get": { "operationId": "item_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "only_cabinet_items", "schema": { "type": "string" }, "description": "Set to 'true' to only include cabinet items in results" } ], "tags": [ "Items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Item" } } }, "description": "" } }, "summary": "Get Item" }, "put": { "operationId": "item_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "only_cabinet_items", "schema": { "type": "string" }, "description": "Set to 'true' to only include cabinet items in results" } ], "tags": [ "Items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Item" } } }, "description": "" } }, "summary": "Update Item" }, "patch": { "operationId": "item_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "only_cabinet_items", "schema": { "type": "string" }, "description": "Set to 'true' to only include cabinet items in results" } ], "tags": [ "Items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedItemRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Item" } } }, "description": "" } }, "summary": "Patch Item" } }, "/item/{id}/add_batch_to_stock/": { "post": { "operationId": "item_add_batch_to_stock_create", "description": "Add batch to stock\n\nAdds a batch to stock for selected department to default location.\n\nParameters:\n- department_id (integer)\n- packages (decimal): Packages available in the batch.\n- units (decimal): Units available in the batch.\n- batch_number (string)\n- expiry_date (date)\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "only_cabinet_items", "schema": { "type": "string" }, "description": "Set to 'true' to only include cabinet items in results" } ], "tags": [ "Items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Item" } } }, "description": "" } }, "summary": "Create Item Add Batch To Stock" } }, "/item/{id}/create_new_finalized_invoice_and_prepayments/": { "post": { "operationId": "item_create_new_finalized_invoice_and_prepayments_create", "description": "Create Invoice or Prepayment\n\nUsed for importing old Invoices from an old system.\n\nIf total > 0, an invoice is created.\nIf total < 0, a prepayment is created.\n\nParameters:\n- total (decimal): Amount of debt/credit\n- old_client_id (string)\n- lastname (string)\n- address (string)\n- department_id (integer)\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "only_cabinet_items", "schema": { "type": "string" }, "description": "Set to 'true' to only include cabinet items in results" } ], "tags": [ "Items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Item" } } }, "description": "" } }, "summary": "Create Item Create New Finalized Invoice And Prepayments" } }, "/item/{id}/update_stock_level/": { "post": { "operationId": "item_update_stock_level_create", "description": "Set item's stock level at default location\n\nSet item's stock level to a certain amount on a specific department.\nFor other locations and batches/tracking numbers, use inventory endpoint.\n\nParameters:\n- department_id (integer)\n- stock_level (decimal)\n- timestamp (datetime)\n- event_type (integer); default: 1 (TYPE_ADD)\n- description (string); default: \"Update from REST API\".\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "only_cabinet_items", "schema": { "type": "string" }, "description": "Set to 'true' to only include cabinet items in results" } ], "tags": [ "Items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Item" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Item" } } }, "description": "" } }, "summary": "Create Item Update Stock Level" } }, "/item/bulk/upsert/": { "post": { "operationId": "item_bulk_upsert_create", "description": "Insert or update Items.\n\nIf callback (url) is provided, the processing is done in a task and processing\nresult will be sent to the url.\n\nRow ordering: when the organization has ``enforce_unique_item_codes``\nenabled, rows carrying ``archived: true`` are processed before creates\nand updates, so an archive-and-recreate payload frees the code before\nthe new row's uniqueness check runs.\n\nParameters in JSON:\n- {\n \"callback\": \"http://pricing.tool/ABC\",\n \"data\": {\n \"ext_id_1\": {\"id\": 12, ...},\n \"ext_id_2\": {...}\n }\n }\nReturns:\n- HTTP 200 - Success without errors - no callback provided\n-- {\"ext_id_1\": {\"status\": \"success\", \"id\": 12, \"url\": ...},\n \"ext_id_2\": {\"status\": \"success\", \"id\": 13, \"url\": ...}}\n- HTTP 206 - Items processed with errors - no callback provided\n-- {\"ext_id_1\": {\"status\": \"success\", \"id\": 12, \"url\": ...},\n \"ext_id_2\": {\"status\": \"error\", \"error\": {...}}\n- HTTP 202 - Request received, will start processing results\n-- After processing done in celery task, HTTP POST request will be sent to the\n callback url with status of each item:\n--- {\n \"ext_id_1\": {\"status\": \"success\", \"id\": 12, \"url\": ...},\n \"ext_id_2\": {\"status\": \"error\", \"error\": {...}\n }\n- HTTP 400 - Nothing processed, incorrect JSON\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Items" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Item Bulk Upsert" } }, "/item/export/start/": { "post": { "operationId": "item_export_start_create", "description": "Start an async items export. Returns a task_id to poll with.\n\nPOST body: department_id (required) + any filter fields.\nPoll GET /item/export/status/?task_id= until status is \"completed\",\nthen fetch the file from GET /item/export/download/?task_id=.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Catalog Items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItemExportStartRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CatalogItemExportStartRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CatalogItemExportStartRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItemExportStartResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CatalogItemExportStartResponse" } } }, "description": "" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItemExportThrottledResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CatalogItemExportThrottledResponse" } } }, "description": "" } }, "summary": "Create Item Export Start" } }, "/item/export/status/": { "get": { "operationId": "item_export_status_retrieve", "description": "Poll the status of an async catalog items export by ``task_id``.\n\nReturns one of:\n\n- ``processing`` — the export is still being generated.\n- ``completed`` — the export is ready; the response includes\n ``completed_at`` and a ``download_url`` that can be fetched\n directly to retrieve the XLSX file.\n- ``failed`` — the export could not be produced; ``reason`` carries\n a human-readable explanation (for example, a row count exceeding\n the per-export limit).\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Catalog Items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogItemExportStatusResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CatalogItemExportStatusResponse" } } }, "description": "" } }, "summary": "Get Item Export Status" } }, "/item_diagnosis_group/": { "get": { "operationId": "item_diagnosis_group_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "item_diagnosis_group" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemDiagnosisGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemDiagnosisGroupList" } } }, "description": "" } }, "summary": "List Item Diagnosis Group" } }, "/item_diagnosis_group/{id}/": { "get": { "operationId": "item_diagnosis_group_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item diagnosis group.", "required": true } ], "tags": [ "item_diagnosis_group" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDiagnosisGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemDiagnosisGroup" } } }, "description": "" } }, "summary": "Get Item Diagnosis Group" } }, "/item_size_descriptions/": { "get": { "operationId": "item_size_descriptions_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department_id", "schema": { "type": "string" }, "description": "Only include items from a specific department's item list" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items" }, { "in": "query", "name": "only_cabinet_items", "schema": { "type": "string" }, "description": "Set to 'true' to include only cabinet items" } ], "tags": [ "Item size descriptions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Item Size Descriptions" } }, "/itemlist/": { "get": { "operationId": "itemlist_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Item lists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemListDetailList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemListDetailList" } } }, "description": "" } }, "summary": "List Itemlist" }, "post": { "operationId": "itemlist_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Item lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemListDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemListDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemListDetailRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemListDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemListDetail" } } }, "description": "" } }, "summary": "Create Itemlist" } }, "/itemlist/{id}/": { "get": { "operationId": "itemlist_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item list.", "required": true } ], "tags": [ "Item lists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemListDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemListDetail" } } }, "description": "" } }, "summary": "Get Itemlist" }, "put": { "operationId": "itemlist_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item list.", "required": true } ], "tags": [ "Item lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemListDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemListDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemListDetailRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemListDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemListDetail" } } }, "description": "" } }, "summary": "Update Itemlist" }, "patch": { "operationId": "itemlist_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item list.", "required": true } ], "tags": [ "Item lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedItemListDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedItemListDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedItemListDetailRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemListDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemListDetail" } } }, "description": "" } }, "summary": "Patch Itemlist" } }, "/itemsubgroup/": { "get": { "operationId": "itemsubgroup_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Item subgroups" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemSubgroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemSubgroupList" } } }, "description": "" } }, "summary": "List Itemsubgroup" }, "post": { "operationId": "itemsubgroup_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Item subgroups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } } }, "description": "" } }, "summary": "Create Itemsubgroup" } }, "/itemsubgroup/{id}/": { "get": { "operationId": "itemsubgroup_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Item subgroup.", "required": true } ], "tags": [ "Item subgroups" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } } }, "description": "" } }, "summary": "Get Itemsubgroup" }, "put": { "operationId": "itemsubgroup_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Item subgroup.", "required": true } ], "tags": [ "Item subgroups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemSubgroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } } }, "description": "" } }, "summary": "Update Itemsubgroup" }, "patch": { "operationId": "itemsubgroup_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Item subgroup.", "required": true } ], "tags": [ "Item subgroups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedItemSubgroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedItemSubgroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedItemSubgroupRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemSubgroup" } } }, "description": "" } }, "summary": "Patch Itemsubgroup" }, "delete": { "operationId": "itemsubgroup_destroy", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Item subgroup.", "required": true } ], "tags": [ "Item subgroups" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Itemsubgroup" } }, "/itemtemplate/": { "get": { "operationId": "itemtemplate_list", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Bundles (Item templates)" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemTemplateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemTemplateList" } } }, "description": "" } }, "summary": "List Itemtemplate" }, "post": { "operationId": "itemtemplate_create", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Bundles (Item templates)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemTemplateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemTemplate" } } }, "description": "" } }, "summary": "Create Itemtemplate" } }, "/itemtemplate/{id}/": { "get": { "operationId": "itemtemplate_retrieve", "description": "Get Bundle by ID\n\nPrefetches template_items and template_templates (child templates)\nwith correct ordering and minimal fields for optimal performance.\n\nRequired permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template.", "required": true } ], "tags": [ "Bundles (Item templates)" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemTemplateDetail" } } }, "description": "" } }, "summary": "Get Itemtemplate" }, "put": { "operationId": "itemtemplate_update", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template.", "required": true } ], "tags": [ "Bundles (Item templates)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemTemplateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemTemplate" } } }, "description": "" } }, "summary": "Update Itemtemplate" }, "patch": { "operationId": "itemtemplate_partial_update", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template.", "required": true } ], "tags": [ "Bundles (Item templates)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedItemTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedItemTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedItemTemplateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemTemplate" } } }, "description": "" } }, "summary": "Patch Itemtemplate" }, "delete": { "operationId": "itemtemplate_destroy", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template.", "required": true } ], "tags": [ "Bundles (Item templates)" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Itemtemplate" } }, "/itemtemplate_in_template/": { "get": { "operationId": "itemtemplate_in_template_list", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "source_template__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "source_template__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "source_template__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "source_template__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "source_template__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "template__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "template__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "template__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "template__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "template__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Bundle in bundle" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTemplateInTemplateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTemplateInTemplateList" } } }, "description": "" } }, "summary": "List Itemtemplate In Template" }, "post": { "operationId": "itemtemplate_in_template_create", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Bundle in bundle" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateInTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TemplateInTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TemplateInTemplateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateInTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TemplateInTemplate" } } }, "description": "" } }, "summary": "Create Itemtemplate In Template" } }, "/itemtemplate_in_template/{id}/": { "get": { "operationId": "itemtemplate_in_template_retrieve", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template in template.", "required": true } ], "tags": [ "Bundle in bundle" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateInTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TemplateInTemplate" } } }, "description": "" } }, "summary": "Get Itemtemplate In Template" }, "delete": { "operationId": "itemtemplate_in_template_destroy", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template in template.", "required": true } ], "tags": [ "Bundle in bundle" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Itemtemplate In Template" } }, "/itemtemplateitem/": { "get": { "operationId": "itemtemplateitem_list", "description": "List Items\n\nDefault selected:\n- SELECTION_UNTICKED = 0\n- SELECTION_PRETICKED = 1\n- SELECTION_MANDATORY = 2\n\nRequired permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "template__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "template__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "template__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "template__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "template__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Bundles (Item templates)" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemTemplateItemListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemTemplateItemListList" } } }, "description": "" } }, "summary": "List Itemtemplateitem" }, "post": { "operationId": "itemtemplateitem_create", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Bundles (Item templates)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemTemplateItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemTemplateItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemTemplateItem" } } }, "description": "" } }, "summary": "Create Itemtemplateitem" } }, "/itemtemplateitem/{id}/": { "get": { "operationId": "itemtemplateitem_retrieve", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template item.", "required": true } ], "tags": [ "Bundles (Item templates)" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemTemplateItem" } } }, "description": "" } }, "summary": "Get Itemtemplateitem" }, "put": { "operationId": "itemtemplateitem_update", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template item.", "required": true } ], "tags": [ "Bundles (Item templates)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemTemplateItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemTemplateItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemTemplateItem" } } }, "description": "" } }, "summary": "Update Itemtemplateitem" }, "patch": { "operationId": "itemtemplateitem_partial_update", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template item.", "required": true } ], "tags": [ "Bundles (Item templates)" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedItemTemplateItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedItemTemplateItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedItemTemplateItemRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemTemplateItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemTemplateItem" } } }, "description": "" } }, "summary": "Patch Itemtemplateitem" }, "delete": { "operationId": "itemtemplateitem_destroy", "description": "Required permissions:\n- Settings: Templates\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this estimate template item.", "required": true } ], "tags": [ "Bundles (Item templates)" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Itemtemplateitem" } }, "/journal_entry/": { "get": { "operationId": "journal_entry_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "entry_number__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "entry_number__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "entry_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "entry_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "entry_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "entry_number__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "entry_number__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "entry_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "entry_number__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "entry_number__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "journal_transactions__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "journal_transactions__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "journal_transactions__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "journal_transactions__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "journal_transactions__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "journal_transactions__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "journal_transactions__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "journal_transactions__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "journal_transactions__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "journal_transactions__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "journal_transactions__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "journal_transactions__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "journal_transactions__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "journal_transactions__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "journal_transactions__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "report_logs__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "report_logs__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "report_logs__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "report_logs__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "report_logs__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "report_logs__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "report_logs__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "report_logs__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "report_logs__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "report_logs__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "report_logs__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "report_logs__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "report_logs__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "report_logs__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "report_logs__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Journal entries" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJournalEntryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedJournalEntryList" } } }, "description": "" } }, "summary": "List Journal Entry" } }, "/journal_entry/{id}/": { "get": { "operationId": "journal_entry_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal entry.", "required": true } ], "tags": [ "Journal entries" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalEntry" } } }, "description": "" } }, "summary": "Get Journal Entry" } }, "/journal_entry/{id}/tag_entry/": { "post": { "operationId": "journal_entry_tag_entry_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal entry.", "required": true } ], "tags": [ "Journal entries" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JournalEntryRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JournalEntryRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalEntry" } } }, "description": "" } }, "summary": "Create Journal Entry Tag Entry" } }, "/journal_entry_problem/": { "get": { "operationId": "journal_entry_problem_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "entry_number__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "entry_number__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "entry_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "entry_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "entry_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "entry_number__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "entry_number__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "entry_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "entry_number__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "entry_number__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "journal_transaction_problems__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "journal_transaction_problems__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "journal_transaction_problems__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "journal_transaction_problems__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "journal_transaction_problems__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "journal_transaction_problems__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "journal_transaction_problems__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "journal_transaction_problems__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "journal_transaction_problems__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "journal_transaction_problems__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "journal_transaction_problems__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "journal_transaction_problems__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "journal_transaction_problems__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "journal_transaction_problems__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "journal_transaction_problems__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Journal entry problems" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJournalEntryProblemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedJournalEntryProblemList" } } }, "description": "" } }, "summary": "List Journal Entry Problem" } }, "/journal_entry_problem/{id}/": { "get": { "operationId": "journal_entry_problem_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal entry problem.", "required": true } ], "tags": [ "Journal entry problems" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryProblem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalEntryProblem" } } }, "description": "" } }, "summary": "Get Journal Entry Problem" } }, "/journal_entry_problem/{id}/tag_entry/": { "post": { "operationId": "journal_entry_problem_tag_entry_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal entry problem.", "required": true } ], "tags": [ "Journal entry problems" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryProblemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JournalEntryProblemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JournalEntryProblemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalEntryProblem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalEntryProblem" } } }, "description": "" } }, "summary": "Create Journal Entry Problem Tag Entry" } }, "/journal_report_log/": { "get": { "operationId": "journal_report_log_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created_timestamp__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created_timestamp__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created_timestamp__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_timestamp__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_timestamp__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created_timestamp__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created_timestamp__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created_timestamp__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "report_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "report_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "report_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "report_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "report_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "report_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "report_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "report_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Journal entry report logs" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJournalReportLogList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedJournalReportLogList" } } }, "description": "" } }, "summary": "List Journal Report Log" } }, "/journal_report_log/{id}/": { "get": { "operationId": "journal_report_log_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal report log.", "required": true } ], "tags": [ "Journal entry report logs" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalReportLog" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalReportLog" } } }, "description": "" } }, "summary": "Get Journal Report Log" }, "delete": { "operationId": "journal_report_log_destroy", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal report log.", "required": true } ], "tags": [ "Journal entry report logs" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Journal Report Log" } }, "/journal_transaction/": { "get": { "operationId": "journal_transaction_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created_timestamp__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created_timestamp__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created_timestamp__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_timestamp__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_timestamp__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created_timestamp__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created_timestamp__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created_timestamp__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "journal_entry__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "journal_entry__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "journal_entry__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "journal_entry__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "journal_entry__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "journal_entry__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "journal_entry__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "journal_entry__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "journal_entry__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "journal_entry__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "journal_entry__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "journal_entry__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "journal_entry__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "journal_entry__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "journal_entry__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Journal transactions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJournalTransactionList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedJournalTransactionList" } } }, "description": "" } }, "summary": "List Journal Transaction" } }, "/journal_transaction/{id}/": { "get": { "operationId": "journal_transaction_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal transaction.", "required": true } ], "tags": [ "Journal transactions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransaction" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalTransaction" } } }, "description": "" } }, "summary": "Get Journal Transaction" } }, "/journal_transaction/{id}/tag_transaction/": { "post": { "operationId": "journal_transaction_tag_transaction_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal transaction.", "required": true } ], "tags": [ "Journal transactions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JournalTransactionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JournalTransactionRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransaction" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalTransaction" } } }, "description": "" } }, "summary": "Create Journal Transaction Tag Transaction" } }, "/journal_transaction_problem/": { "get": { "operationId": "journal_transaction_problem_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created_timestamp__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created_timestamp__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created_timestamp__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_timestamp__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_timestamp__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created_timestamp__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created_timestamp__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created_timestamp__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "journal_entry_problem__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "journal_entry_problem__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "journal_entry_problem__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "journal_entry_problem__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "journal_entry_problem__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "journal_entry_problem__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "journal_entry_problem__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "journal_entry_problem__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "journal_entry_problem__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "journal_entry_problem__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "journal_entry_problem__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "journal_entry_problem__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "journal_entry_problem__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "journal_entry_problem__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "journal_entry_problem__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Journal transaction problems" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedJournalTransactionProblemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedJournalTransactionProblemList" } } }, "description": "" } }, "summary": "List Journal Transaction Problem" } }, "/journal_transaction_problem/{id}/": { "get": { "operationId": "journal_transaction_problem_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal transaction problem.", "required": true } ], "tags": [ "Journal transaction problems" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionProblem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalTransactionProblem" } } }, "description": "" } }, "summary": "Get Journal Transaction Problem" } }, "/journal_transaction_problem/{id}/tag_transaction/": { "post": { "operationId": "journal_transaction_problem_tag_transaction_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this journal transaction problem.", "required": true } ], "tags": [ "Journal transaction problems" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionProblemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JournalTransactionProblemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JournalTransactionProblemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionProblem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalTransactionProblem" } } }, "description": "" } }, "summary": "Create Journal Transaction Problem Tag Transaction" } }, "/knowledgebasefile/": { "get": { "operationId": "knowledgebasefile_list", "description": "Knowledge Base Files\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Knowledge base" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedKnowledgeBaseFileList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedKnowledgeBaseFileList" } } }, "description": "" } }, "summary": "List Knowledgebasefile" }, "post": { "operationId": "knowledgebasefile_create", "description": "Knowledge Base Files\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Knowledge base" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFileRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFile" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFile" } } }, "description": "" } }, "summary": "Create Knowledgebasefile" } }, "/knowledgebasefile/{id}/": { "get": { "operationId": "knowledgebasefile_retrieve", "description": "Knowledge Base Files\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base file.", "required": true } ], "tags": [ "Knowledge base" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFile" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFile" } } }, "description": "" } }, "summary": "Get Knowledgebasefile" }, "put": { "operationId": "knowledgebasefile_update", "description": "Knowledge Base Files\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base file.", "required": true } ], "tags": [ "Knowledge base" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFileRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFile" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFile" } } }, "description": "" } }, "summary": "Update Knowledgebasefile" }, "patch": { "operationId": "knowledgebasefile_partial_update", "description": "Knowledge Base Files\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base file.", "required": true } ], "tags": [ "Knowledge base" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseFileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseFileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseFileRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFile" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFile" } } }, "description": "" } }, "summary": "Patch Knowledgebasefile" }, "delete": { "operationId": "knowledgebasefile_destroy", "description": "Knowledge Base Files\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base file.", "required": true } ], "tags": [ "Knowledge base" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Knowledgebasefile" } }, "/knowledgebasefolder/": { "get": { "operationId": "knowledgebasefolder_list", "description": "Knowledge Base Folders\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Knowledge base" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedKnowledgeBaseFolderList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedKnowledgeBaseFolderList" } } }, "description": "" } }, "summary": "List Knowledgebasefolder" }, "post": { "operationId": "knowledgebasefolder_create", "description": "Knowledge Base Folders\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Knowledge base" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolderRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } } }, "description": "" } }, "summary": "Create Knowledgebasefolder" } }, "/knowledgebasefolder/{id}/": { "get": { "operationId": "knowledgebasefolder_retrieve", "description": "Knowledge Base Folders\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base folder.", "required": true } ], "tags": [ "Knowledge base" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } } }, "description": "" } }, "summary": "Get Knowledgebasefolder" }, "put": { "operationId": "knowledgebasefolder_update", "description": "Knowledge Base Folders\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base folder.", "required": true } ], "tags": [ "Knowledge base" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolderRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } } }, "description": "" } }, "summary": "Update Knowledgebasefolder" }, "patch": { "operationId": "knowledgebasefolder_partial_update", "description": "Knowledge Base Folders\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base folder.", "required": true } ], "tags": [ "Knowledge base" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseFolderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseFolderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedKnowledgeBaseFolderRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } } }, "description": "" } }, "summary": "Patch Knowledgebasefolder" }, "delete": { "operationId": "knowledgebasefolder_destroy", "description": "Knowledge Base Folders\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base folder.", "required": true } ], "tags": [ "Knowledge base" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Knowledgebasefolder" } }, "/knowledgebaseobject/": { "get": { "operationId": "knowledgebaseobject_list", "description": "Knowledge Base Objects\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Knowledge base" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedKnowledgeBaseObjectList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedKnowledgeBaseObjectList" } } }, "description": "" } }, "summary": "List Knowledgebaseobject" } }, "/knowledgebaseobject/{id}/": { "get": { "operationId": "knowledgebaseobject_retrieve", "description": "Knowledge Base Objects\n\nThis view does not require permissions because there's no permission class for using\nthe knowledge base.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this knowledge base object.", "required": true } ], "tags": [ "Knowledge base" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseObject" } }, "text/html": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseObject" } } }, "description": "" } }, "summary": "Get Knowledgebaseobject" } }, "/laboratoryanalysis/": { "get": { "operationId": "laboratoryanalysis_list", "description": "List Analyses\n\nSample types are defined in Lists & Templates > Lists. sample_type field is\ndeprecated, use coded_sample_type instead.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 150 requests per minute.", "parameters": [ { "in": "query", "name": "code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "created_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "created_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_2__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_2__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_3__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_3__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "group__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "group__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "group__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "group__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "group__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modified_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modified_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLaboratoryAnalysisListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedLaboratoryAnalysisListList" } } }, "description": "" } }, "summary": "List Laboratoryanalysis" }, "post": { "operationId": "laboratoryanalysis_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysis" } } }, "description": "" } }, "summary": "Create Laboratoryanalysis" } }, "/laboratoryanalysis/{id}/": { "get": { "operationId": "laboratoryanalysis_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 600 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysis" } } }, "description": "" } }, "summary": "Get Laboratoryanalysis" }, "put": { "operationId": "laboratoryanalysis_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysis" } } }, "description": "" } }, "summary": "Update Laboratoryanalysis" }, "patch": { "operationId": "laboratoryanalysis_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysis" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysis" } } }, "description": "" } }, "summary": "Patch Laboratoryanalysis" }, "delete": { "operationId": "laboratoryanalysis_destroy", "description": "Archives an item.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Laboratoryanalysis" } }, "/laboratoryanalysisgroup/": { "get": { "operationId": "laboratoryanalysisgroup_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLaboratoryAnalysisGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedLaboratoryAnalysisGroupList" } } }, "description": "" } }, "summary": "List Laboratoryanalysisgroup" }, "post": { "operationId": "laboratoryanalysisgroup_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroup" } } }, "description": "" } }, "summary": "Create Laboratoryanalysisgroup" } }, "/laboratoryanalysisgroup/{id}/": { "get": { "operationId": "laboratoryanalysisgroup_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis group.", "required": true } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroupDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroupDetail" } } }, "description": "" } }, "summary": "Get Laboratoryanalysisgroup" }, "put": { "operationId": "laboratoryanalysisgroup_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis group.", "required": true } ], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroup" } } }, "description": "" } }, "summary": "Update Laboratoryanalysisgroup" }, "patch": { "operationId": "laboratoryanalysisgroup_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis group.", "required": true } ], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisGroupRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisGroup" } } }, "description": "" } }, "summary": "Patch Laboratoryanalysisgroup" }, "delete": { "operationId": "laboratoryanalysisgroup_destroy", "description": "Archives an item.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis group.", "required": true } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Laboratoryanalysisgroup" } }, "/laboratoryanalysispanel/": { "get": { "operationId": "laboratoryanalysispanel_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "created_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "created_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_2__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_2__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_3__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_3__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modified_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modified_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLaboratoryAnalysisPanelListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedLaboratoryAnalysisPanelListList" } } }, "description": "" } }, "summary": "List Laboratoryanalysispanel" }, "post": { "operationId": "laboratoryanalysispanel_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanelRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanel" } } }, "description": "" } }, "summary": "Create Laboratoryanalysispanel" } }, "/laboratoryanalysispanel/{id}/": { "get": { "operationId": "laboratoryanalysispanel_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis panel.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanel" } } }, "description": "" } }, "summary": "Get Laboratoryanalysispanel" }, "put": { "operationId": "laboratoryanalysispanel_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis panel.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanelRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanel" } } }, "description": "" } }, "summary": "Update Laboratoryanalysispanel" }, "patch": { "operationId": "laboratoryanalysispanel_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis panel.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisPanelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisPanelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLaboratoryAnalysisPanelRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LaboratoryAnalysisPanel" } } }, "description": "" } }, "summary": "Patch Laboratoryanalysispanel" }, "delete": { "operationId": "laboratoryanalysispanel_destroy", "description": "Archives an item.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this laboratory analysis panel.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Laboratory analyses" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Laboratoryanalysispanel" } }, "/list/": { "get": { "operationId": "list_list", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Lists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedListList" } } }, "description": "" } }, "summary": "List List" }, "post": { "operationId": "list_create", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ListRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ListRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } }, "text/html": { "schema": { "$ref": "#/components/schemas/List" } } }, "description": "" } }, "summary": "Create List" } }, "/list/{id}/": { "get": { "operationId": "list_retrieve", "description": "Get List by ID\n\nCode_system values:\n- Items in this List are editable and viewable in REST API = 1\n- Items in this List are from VeNom codes. Not viewable or\n editable in REST API = 2\n\nRequired permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list.", "required": true } ], "tags": [ "Lists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ListDetail" } } }, "description": "" } }, "summary": "Get List" }, "put": { "operationId": "list_update", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list.", "required": true } ], "tags": [ "Lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ListRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ListRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } }, "text/html": { "schema": { "$ref": "#/components/schemas/List" } } }, "description": "" } }, "summary": "Update List" }, "patch": { "operationId": "list_partial_update", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list.", "required": true } ], "tags": [ "Lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedListRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedListRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedListRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/List" } }, "text/html": { "schema": { "$ref": "#/components/schemas/List" } } }, "description": "" } }, "summary": "Patch List" }, "delete": { "operationId": "list_destroy", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list.", "required": true } ], "tags": [ "Lists" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete List" } }, "/listitem/": { "get": { "operationId": "listitem_list", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "code__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "external_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Lists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListItemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedListItemList" } } }, "description": "" } }, "summary": "List Listitem" }, "post": { "operationId": "listitem_create", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ListItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ListItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ListItem" } } }, "description": "" } }, "summary": "Create Listitem" } }, "/listitem/{id}/": { "get": { "operationId": "listitem_retrieve", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Lists" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ListItem" } } }, "description": "" } }, "summary": "Get Listitem" }, "put": { "operationId": "listitem_update", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ListItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ListItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ListItem" } } }, "description": "" } }, "summary": "Update Listitem" }, "patch": { "operationId": "listitem_partial_update", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this list item.", "required": true } ], "tags": [ "Lists" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedListItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedListItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedListItemRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ListItem" } } }, "description": "" } }, "summary": "Patch Listitem" } }, "/logs/email/": { "get": { "operationId": "logs_email_list", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Logs" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedEmailLogList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedEmailLogList" } } }, "description": "" } }, "summary": "List Logs Email" } }, "/logs/email/{id}/": { "get": { "operationId": "logs_email_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this email log.", "required": true } ], "tags": [ "Logs" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailLogDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/EmailLogDetail" } } }, "description": "" } }, "summary": "Get Logs Email" } }, "/logs/integration_events/": { "get": { "operationId": "logs_integration_events_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Logs" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Logs Integration Events" }, "post": { "operationId": "logs_integration_events_create", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Logs" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Logs Integration Events" } }, "/logs/integration_events/{id}/": { "get": { "operationId": "logs_integration_events_retrieve_2", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "tags": [ "Logs" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Logs Integration Events" } }, "/logs/sms/": { "get": { "operationId": "logs_sms_list", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "success__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "success__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "webhook__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "webhook__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "webhook__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "webhook__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "webhook__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Logs" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSmsLogList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedSmsLogList" } } }, "description": "" } }, "summary": "List Logs Sms" } }, "/logs/sms/{id}/": { "get": { "operationId": "logs_sms_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this sms log.", "required": true } ], "tags": [ "Logs" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsLogDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/SmsLogDetail" } } }, "description": "" } }, "summary": "Get Logs Sms" } }, "/masterdataentry/": { "get": { "operationId": "masterdataentry_list", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "masterdataentry" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMasterDataEntryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedMasterDataEntryList" } } }, "description": "" } }, "summary": "List Masterdataentry" } }, "/masterdataentry/{id}/": { "get": { "operationId": "masterdataentry_retrieve", "description": "Required permissions:\n- Settings: List and list items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this master data entry.", "required": true } ], "tags": [ "masterdataentry" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterDataEntry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/MasterDataEntry" } } }, "description": "" } }, "summary": "Get Masterdataentry" } }, "/medicine/": { "get": { "operationId": "medicine_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "created_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "created_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_2__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_2__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_3__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_3__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modified_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modified_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Medicine" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMedicineListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedMedicineListList" } } }, "description": "" } }, "summary": "List Medicine" }, "post": { "operationId": "medicine_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Medicine" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Medicine" } }, "/medicine/{id}/": { "get": { "operationId": "medicine_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this medicine.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Medicine" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Medicine" }, "put": { "operationId": "medicine_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this medicine.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Medicine" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update Medicine" }, "patch": { "operationId": "medicine_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this medicine.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Medicine" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch Medicine" }, "delete": { "operationId": "medicine_destroy", "description": "Archives an item.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this medicine.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Medicine" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Medicine" } }, "/medicinetemplate/": { "get": { "operationId": "medicinetemplate_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "species__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "species__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "species__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "species__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "species__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "medicinetemplate" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedMedicineTemplateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedMedicineTemplateList" } } }, "description": "" } }, "summary": "List Medicinetemplate" } }, "/medicinetemplate/{id}/": { "get": { "operationId": "medicinetemplate_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this medicine template.", "required": true } ], "tags": [ "medicinetemplate" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MedicineTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/MedicineTemplate" } } }, "description": "" } }, "summary": "Get Medicinetemplate" } }, "/modality/": { "get": { "operationId": "modality_list", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "common_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "common_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "common_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "common_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "common_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "common_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "common_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "common_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "is_active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modality_type__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modality_type__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modality_type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modality_type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modality_type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modality_type__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modality_type__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modality_type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modality_type__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modality_type__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Modality" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedModalityList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedModalityList" } } }, "description": "" } }, "summary": "List Modality" } }, "/modality/{id}/": { "get": { "operationId": "modality_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this modality.", "required": true } ], "tags": [ "Modality" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Modality" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Modality" } } }, "description": "" } }, "summary": "Get Modality" } }, "/note/": { "get": { "operationId": "note_list", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 50 requests per minute.", "parameters": [ { "in": "query", "name": "archived__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "archived__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "archived__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "archived__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "archived__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "archived__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patients__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patients__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patients__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patients__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patients__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Notes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNoteList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedNoteList" } } }, "description": "" } }, "summary": "List Note" }, "post": { "operationId": "note_create", "description": "Create a new Note.\n\nIf 'attachments' is provided in the request (list of filenames),\ngenerates S3 pre-signed URLs for uploading those attachments.\n\nNote: Attachment pre-signed URLs are only supported for single note\ncreation, not bulk creates.\n\nRequired permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Notes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NoteRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NoteRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "" } }, "summary": "Create Note" } }, "/note/{parent_lookup_note}/upload/": { "get": { "operationId": "note_upload_list", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_note", "schema": { "type": "string" }, "required": true } ], "tags": [ "Notes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNoteUploadList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedNoteUploadList" } } }, "description": "" } }, "summary": "List Note Upload" }, "post": { "operationId": "note_upload_create", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 200 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_note", "schema": { "type": "string" }, "required": true } ], "tags": [ "Notes" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NoteUploadRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/NoteUpload" } } }, "description": "" } }, "summary": "Create Note Upload" } }, "/note/{parent_lookup_note}/upload/{id}/": { "get": { "operationId": "note_upload_retrieve", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this upload.", "required": true }, { "in": "path", "name": "parent_lookup_note", "schema": { "type": "string" }, "required": true } ], "tags": [ "Notes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/NoteUpload" } } }, "description": "" } }, "summary": "Get Note Upload" } }, "/note/{id}/": { "get": { "operationId": "note_retrieve", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 200 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this note.", "required": true } ], "tags": [ "Notes" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "" } }, "summary": "Get Note" }, "put": { "operationId": "note_update", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 600 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this note.", "required": true } ], "tags": [ "Notes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NoteRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NoteRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "" } }, "summary": "Update Note" }, "patch": { "operationId": "note_partial_update", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 600 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this note.", "required": true } ], "tags": [ "Notes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedNoteRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedNoteRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedNoteRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "" } }, "summary": "Patch Note" }, "delete": { "operationId": "note_destroy", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this note.", "required": true } ], "tags": [ "Notes" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Note" } }, "/noteadmin/": { "get": { "operationId": "noteadmin_list", "description": "Note Admin\n\nFor updating old consultations notes\n\nRequired permissions:\n- General: Add notes and communication\n- General: Edit locked notes through API\n\n\nThis endpoint is rate-limited to 50 requests per minute.", "parameters": [ { "in": "query", "name": "archived__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "archived__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "archived__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "archived__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "archived__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "archived__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patients__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patients__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patients__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patients__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patients__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Note admin" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNoteList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedNoteList" } } }, "description": "" } }, "summary": "List Noteadmin" }, "post": { "operationId": "noteadmin_create", "description": "Create a new Note.\n\nIf 'attachments' is provided in the request (list of filenames),\ngenerates S3 pre-signed URLs for uploading those attachments.\n\nNote: Attachment pre-signed URLs are only supported for single note\ncreation, not bulk creates.\n\nRequired permissions:\n- General: Add notes and communication\n- General: Edit locked notes through API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Note admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NoteRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NoteRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "" } }, "summary": "Create Noteadmin" } }, "/noteadmin/{parent_lookup_note}/upload/": { "get": { "operationId": "noteadmin_upload_list", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_note", "schema": { "type": "string" }, "required": true } ], "tags": [ "Note admin" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNoteUploadList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedNoteUploadList" } } }, "description": "" } }, "summary": "List Noteadmin Upload" }, "post": { "operationId": "noteadmin_upload_create", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 200 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_note", "schema": { "type": "string" }, "required": true } ], "tags": [ "Note admin" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NoteUploadRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/NoteUpload" } } }, "description": "" } }, "summary": "Create Noteadmin Upload" } }, "/noteadmin/{parent_lookup_note}/upload/{id}/": { "get": { "operationId": "noteadmin_upload_retrieve", "description": "Required permissions:\n- General: Add notes and communication\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this upload.", "required": true }, { "in": "path", "name": "parent_lookup_note", "schema": { "type": "string" }, "required": true } ], "tags": [ "Note admin" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteUpload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/NoteUpload" } } }, "description": "" } }, "summary": "Get Noteadmin Upload" } }, "/noteadmin/{id}/": { "get": { "operationId": "noteadmin_retrieve", "description": "Note Admin\n\nFor updating old consultations notes\n\nRequired permissions:\n- General: Add notes and communication\n- General: Edit locked notes through API\n\n\nThis endpoint is rate-limited to 200 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this note.", "required": true } ], "tags": [ "Note admin" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "" } }, "summary": "Get Noteadmin" }, "put": { "operationId": "noteadmin_update", "description": "Note Admin\n\nFor updating old consultations notes\n\nRequired permissions:\n- General: Add notes and communication\n- General: Edit locked notes through API\n\n\nThis endpoint is rate-limited to 600 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this note.", "required": true } ], "tags": [ "Note admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NoteRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NoteRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "" } }, "summary": "Update Noteadmin" }, "patch": { "operationId": "noteadmin_partial_update", "description": "Note Admin\n\nFor updating old consultations notes\n\nRequired permissions:\n- General: Add notes and communication\n- General: Edit locked notes through API\n\n\nThis endpoint is rate-limited to 600 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this note.", "required": true } ], "tags": [ "Note admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedNoteRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedNoteRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedNoteRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Note" } } }, "description": "" } }, "summary": "Patch Noteadmin" }, "delete": { "operationId": "noteadmin_destroy", "description": "Note Admin\n\nFor updating old consultations notes\n\nRequired permissions:\n- General: Add notes and communication\n- General: Edit locked notes through API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this note.", "required": true } ], "tags": [ "Note admin" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Noteadmin" } }, "/nps/": { "get": { "operationId": "nps_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultation__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultation__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultation__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultation__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultation__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "rating__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "rating__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "rating__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "rating__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "rating__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "rating__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "rating__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "rating__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "rating__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "rating__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Net promoter scores" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedNetPromoterScoreList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedNetPromoterScoreList" } } }, "description": "" } }, "summary": "List Nps" }, "post": { "operationId": "nps_create", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Net promoter scores" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetPromoterScoreRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/NetPromoterScoreRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NetPromoterScoreRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetPromoterScore" } }, "text/html": { "schema": { "$ref": "#/components/schemas/NetPromoterScore" } } }, "description": "" } }, "summary": "Create Nps" } }, "/nps/{id}/": { "get": { "operationId": "nps_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this net promoter score.", "required": true } ], "tags": [ "Net promoter scores" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetPromoterScore" } }, "text/html": { "schema": { "$ref": "#/components/schemas/NetPromoterScore" } } }, "description": "" } }, "summary": "Get Nps" } }, "/onlinebooking_trigger_topic/": { "get": { "operationId": "onlinebooking_trigger_topic_list", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "trigger_type__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "trigger_type__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "trigger_type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "trigger_type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "trigger_type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "trigger_type__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "trigger_type__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "trigger_type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "trigger_type__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "trigger_type__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "onlinebooking_trigger_topic" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedOnlineBookingTriggerTopicList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedOnlineBookingTriggerTopicList" } } }, "description": "" } }, "summary": "List Onlinebooking Trigger Topic" }, "post": { "operationId": "onlinebooking_trigger_topic_create", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "onlinebooking_trigger_topic" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopicRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopicRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopicRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } } }, "description": "" } }, "summary": "Create Onlinebooking Trigger Topic" } }, "/onlinebooking_trigger_topic/{id}/": { "get": { "operationId": "onlinebooking_trigger_topic_retrieve", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this online booking trigger topic.", "required": true } ], "tags": [ "onlinebooking_trigger_topic" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } } }, "description": "" } }, "summary": "Get Onlinebooking Trigger Topic" }, "put": { "operationId": "onlinebooking_trigger_topic_update", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this online booking trigger topic.", "required": true } ], "tags": [ "onlinebooking_trigger_topic" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopicRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopicRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopicRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } } }, "description": "" } }, "summary": "Update Onlinebooking Trigger Topic" }, "patch": { "operationId": "onlinebooking_trigger_topic_partial_update", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this online booking trigger topic.", "required": true } ], "tags": [ "onlinebooking_trigger_topic" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedOnlineBookingTriggerTopicRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedOnlineBookingTriggerTopicRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedOnlineBookingTriggerTopicRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } } }, "description": "" } }, "summary": "Patch Onlinebooking Trigger Topic" }, "delete": { "operationId": "onlinebooking_trigger_topic_destroy", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this online booking trigger topic.", "required": true } ], "tags": [ "onlinebooking_trigger_topic" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Onlinebooking Trigger Topic" } }, "/onlinebookingclient/": { "get": { "operationId": "onlinebookingclient_list", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "email__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "email__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "email__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "email__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "email__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "email__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "email__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "email__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "scheduling_event__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "scheduling_event__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" } ], "tags": [ "Online booking" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedOnlineBookingClientList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedOnlineBookingClientList" } } }, "description": "" } }, "summary": "List Onlinebookingclient" }, "post": { "operationId": "onlinebookingclient_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Online booking" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingClientRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OnlineBookingClientRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OnlineBookingClientRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingClient" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OnlineBookingClient" } } }, "description": "" } }, "summary": "Create Onlinebookingclient" } }, "/onlinebookingclient/{id}/": { "get": { "operationId": "onlinebookingclient_retrieve", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this online booking client.", "required": true } ], "tags": [ "Online booking" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingClient" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OnlineBookingClient" } } }, "description": "" } }, "summary": "Get Onlinebookingclient" } }, "/onlinebookingdaysavailable": { "get": { "operationId": "onlinebookingdaysavailable_retrieve", "description": "Online Booking Days Available\n\nCheck available days for online booking based on department, duration, and employee availability.\n\nRequired permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department_id", "schema": { "type": "integer" }, "required": true }, { "in": "query", "name": "duration", "schema": { "type": "integer" }, "required": true }, { "in": "query", "name": "end", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "reason", "schema": { "type": "integer" } }, { "in": "query", "name": "start", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "treating_employees", "schema": { "type": "string" }, "description": "Integer or list of integers" }, { "in": "query", "name": "user_types", "schema": { "type": "string" }, "description": "Integer or list of integers" } ], "tags": [ "onlinebookingdaysavailable" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Onlinebookingdaysavailable" } }, "/onlinebookingpatient/": { "get": { "operationId": "onlinebookingpatient_list", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Online booking" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedOnlineBookingPatientList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedOnlineBookingPatientList" } } }, "description": "" } }, "summary": "List Onlinebookingpatient" }, "post": { "operationId": "onlinebookingpatient_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Online booking" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingPatientRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OnlineBookingPatientRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OnlineBookingPatientRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingPatient" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OnlineBookingPatient" } } }, "description": "" } }, "summary": "Create Onlinebookingpatient" } }, "/onlinebookingpatient/{id}/": { "get": { "operationId": "onlinebookingpatient_retrieve", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this online booking patient.", "required": true } ], "tags": [ "Online booking" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineBookingPatient" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OnlineBookingPatient" } } }, "description": "" } }, "summary": "Get Onlinebookingpatient" } }, "/order/": { "get": { "operationId": "order_list", "description": "Required permissions:\n- Settings: Stock\n

Or

\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "order_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "order_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "order_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "order_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "order_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "order_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "order_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "order_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "wholesaler__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "wholesaler__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "wholesaler__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "wholesaler__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "wholesaler__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Product orders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProductOrderList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedProductOrderList" } } }, "description": "" } }, "summary": "List Order" }, "post": { "operationId": "order_create", "description": "Required permissions:\n- Settings: Stock\n

Or

\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Product orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOrderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProductOrderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProductOrderRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOrder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProductOrder" } } }, "description": "" } }, "summary": "Create Order" } }, "/order/{id}/": { "get": { "operationId": "order_retrieve", "description": "Required permissions:\n- Settings: Stock\n

Or

\n\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order.", "required": true } ], "tags": [ "Product orders", "Wholesaler API" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOrderDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProductOrderDetail" } } }, "description": "" } }, "summary": "Get Order" }, "put": { "operationId": "order_update", "description": "Required permissions:\n- Settings: Stock\n

Or

\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order.", "required": true } ], "tags": [ "Product orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOrderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProductOrderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProductOrderRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOrder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProductOrder" } } }, "description": "" } }, "summary": "Update Order" }, "patch": { "operationId": "order_partial_update", "description": "Required permissions:\n- Settings: Stock\n

Or

\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order.", "required": true } ], "tags": [ "Product orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedProductOrderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedProductOrderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedProductOrderRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOrder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ProductOrder" } } }, "description": "" } }, "summary": "Patch Order" } }, "/order/{id}/mark_delivered/": { "post": { "operationId": "order_mark_delivered_create", "description": "Transition an order from 'Ordered' to 'Products delivered'.\n\nRuns the same side effects as the web app's \"Mark products delivered\"\naction: stock cleanup, validating non-stock-managed items, stamping the\ndelivery date, and fetching external wholesaler/delivery details.\n\nRequired permissions:\n- Settings: Stock\n

Or

\n- Settings: Product orders / purchase invoices \n

Or

\n\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order.", "required": true } ], "tags": [ "Product orders", "Wholesaler API" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderMarkDeliveredResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrderMarkDeliveredResponse" } } }, "description": "" } }, "summary": "Create Order Mark Delivered" } }, "/order/{id}/set_wholesaler_reference_number/": { "post": { "operationId": "order_set_wholesaler_reference_number_create", "description": "Store the reference number the wholesaler assigned to a placed order.\n\nLast write wins. Only a repeat of the value already stored skips ``save()``,\nso an at-least-once partner redelivery does not re-fire the order webhook.\n\n``wholesaler_confirmation_url`` is optional (ENT-3654): only Provet\nConnect's two-step ordering needs it -- most wholesalers accept an\norder outright and never send it, so a reference-number-only call\n(e.g. Lyppard's) must not clear a URL an earlier Provet Connect call\nstored -- the field is only touched when the request actually\nincludes it.\n\nRequired permissions:\n- Settings: Stock\n

Or

\n- Settings: Product orders / purchase invoices \n

Or

\n\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order.", "required": true } ], "tags": [ "Product orders", "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSetWholesalerReferenceNumberRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderSetWholesalerReferenceNumberRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrderSetWholesalerReferenceNumberRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSetWholesalerReferenceNumberResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrderSetWholesalerReferenceNumberResponse" } } }, "description": "" } }, "summary": "Create Order Set Wholesaler Reference Number" } }, "/orderitem/": { "get": { "operationId": "orderitem_list", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "expose_org_item", "schema": { "type": "string" }, "description": "By default org_item is returned as a hyperlink. Supply any value to return it as a nested object with the item's stockable fields instead." }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "order__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "order__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "order__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "order__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "order__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "in": "query", "name": "org_item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "org_item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "org_item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "org_item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "org_item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Product orders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedOrderItemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedOrderItemList" } } }, "description": "" } }, "summary": "List Orderitem" }, "post": { "operationId": "orderitem_create", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "expose_org_item", "schema": { "type": "string" }, "description": "By default org_item is returned as a hyperlink. Supply any value to return it as a nested object with the item's stockable fields instead." } ], "tags": [ "Product orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrderItem" } } }, "description": "" } }, "summary": "Create Orderitem" } }, "/orderitem/{id}/": { "get": { "operationId": "orderitem_retrieve", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "expose_org_item", "schema": { "type": "string" }, "description": "By default org_item is returned as a hyperlink. Supply any value to return it as a nested object with the item's stockable fields instead." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order item.", "required": true } ], "tags": [ "Product orders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrderItem" } } }, "description": "" } }, "summary": "Get Orderitem" }, "put": { "operationId": "orderitem_update", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "expose_org_item", "schema": { "type": "string" }, "description": "By default org_item is returned as a hyperlink. Supply any value to return it as a nested object with the item's stockable fields instead." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order item.", "required": true } ], "tags": [ "Product orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrderItem" } } }, "description": "" } }, "summary": "Update Orderitem" }, "patch": { "operationId": "orderitem_partial_update", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "expose_org_item", "schema": { "type": "string" }, "description": "By default org_item is returned as a hyperlink. Supply any value to return it as a nested object with the item's stockable fields instead." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order item.", "required": true } ], "tags": [ "Product orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedOrderItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedOrderItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedOrderItemRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrderItem" } } }, "description": "" } }, "summary": "Patch Orderitem" }, "delete": { "operationId": "orderitem_destroy", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "expose_org_item", "schema": { "type": "string" }, "description": "By default org_item is returned as a hyperlink. Supply any value to return it as a nested object with the item's stockable fields instead." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order item.", "required": true } ], "tags": [ "Product orders" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Orderitem" } }, "/orderitem/{id}/add_to_stock/": { "post": { "operationId": "orderitem_add_to_stock_create", "description": "Add an order item to stock.\n\nCreates a stock entry, marks the item as validated, and\nauto-progresses the parent order status.\n\nRequired permissions:\n- Settings: Stock\n- Settings: Product orders / purchase invoices \n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "expose_org_item", "schema": { "type": "string" }, "description": "By default org_item is returned as a hyperlink. Supply any value to return it as a nested object with the item's stockable fields instead." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this order item.", "required": true } ], "tags": [ "Product orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrderItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrderItem" } } }, "description": "" } }, "summary": "Create Orderitem Add To Stock" } }, "/organism/": { "get": { "operationId": "organism_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Organisms" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedOrganismList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedOrganismList" } } }, "description": "" } }, "summary": "List Organism" } }, "/organism/{id}/": { "get": { "operationId": "organism_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this organism.", "required": true } ], "tags": [ "Organisms" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organism" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Organism" } } }, "description": "" } }, "summary": "Get Organism" } }, "/orphan_item/": { "get": { "operationId": "orphan_item_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Orphan items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedOrphanItemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedOrphanItemList" } } }, "description": "" } }, "summary": "List Orphan Item" }, "post": { "operationId": "orphan_item_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Orphan items" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrphanItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrphanItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrphanItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrphanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrphanItem" } } }, "description": "" } }, "summary": "Create Orphan Item" } }, "/orphan_item/{id}/": { "get": { "operationId": "orphan_item_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this orphan item.", "required": true } ], "tags": [ "Orphan items" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrphanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrphanItem" } } }, "description": "" } }, "summary": "Get Orphan Item" } }, "/patient/": { "get": { "operationId": "patient_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "animal_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "animal_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "animal_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "animal_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "animal_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "animal_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "animal_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "animal_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "breed__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "breed__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "breed__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "breed__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "breed__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "breed__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "breed__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "breed__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "consultations__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultations__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultations__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultations__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultations__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "date_of_birth__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "date_of_birth__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "date_of_birth__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "date_of_birth__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "date_of_birth__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "date_of_birth__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "deceased__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "deceased__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "deceased__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "deceased__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "deceased__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "deceased__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "deceased__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "deceased__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "deceased__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "holding_place_number__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "holding_place_number__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "holding_place_number__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "holding_place_number__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "holding_place_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "holding_place_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "holding_place_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "holding_place_number__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "holding_place_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "home_department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "home_department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "home_department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "microchip__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "microchip__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "microchip__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "microchip__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "microchip__is_not_null", "schema": { "type": "string" }, "description": "is_not_null filter on microchip" }, { "in": "query", "name": "microchip__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "old_patient_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "old_patient_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "old_patient_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "old_patient_id__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "old_patient_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "passport_number__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "passport_number__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "passport_number__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "passport_number__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "passport_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "passport_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "passport_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "passport_number__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "passport_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "species__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "species__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "species__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "species__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "species__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "species__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "species__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "species__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "visible_department_groups__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "visible_department_groups__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "visible_department_groups__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "visible_department_groups__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "visible_department_groups__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientList" } } }, "description": "" } }, "summary": "List Patient" }, "post": { "operationId": "patient_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 250 requests per minute.", "parameters": [], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Patient" } } }, "description": "" } }, "summary": "Create Patient" } }, "/patient/{parent_lookup_patient}/blood_pressure/": { "get": { "operationId": "patient_blood_pressure_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedBloodPressureList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedBloodPressureList" } } }, "description": "" } }, "summary": "List Patient Blood Pressure" }, "post": { "operationId": "patient_blood_pressure_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BloodPressureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BloodPressureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BloodPressureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BloodPressure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BloodPressure" } } }, "description": "" } }, "summary": "Create Patient Blood Pressure" } }, "/patient/{parent_lookup_patient}/blood_pressure/{id}/": { "get": { "operationId": "patient_blood_pressure_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this blood pressure.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BloodPressure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BloodPressure" } } }, "description": "" } }, "summary": "Get Patient Blood Pressure" }, "put": { "operationId": "patient_blood_pressure_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this blood pressure.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BloodPressureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BloodPressureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BloodPressureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BloodPressure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BloodPressure" } } }, "description": "" } }, "summary": "Update Patient Blood Pressure" }, "patch": { "operationId": "patient_blood_pressure_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this blood pressure.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedBloodPressureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedBloodPressureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedBloodPressureRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BloodPressure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BloodPressure" } } }, "description": "" } }, "summary": "Patch Patient Blood Pressure" }, "delete": { "operationId": "patient_blood_pressure_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this blood pressure.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Blood Pressure" } }, "/patient/{parent_lookup_patient}/body_condition_score/": { "get": { "operationId": "patient_body_condition_score_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedBodyConditionScoreList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedBodyConditionScoreList" } } }, "description": "" } }, "summary": "List Patient Body Condition Score" }, "post": { "operationId": "patient_body_condition_score_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BodyConditionScoreRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BodyConditionScoreRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BodyConditionScoreRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BodyConditionScore" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BodyConditionScore" } } }, "description": "" } }, "summary": "Create Patient Body Condition Score" } }, "/patient/{parent_lookup_patient}/body_condition_score/{id}/": { "get": { "operationId": "patient_body_condition_score_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this body condition score.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BodyConditionScore" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BodyConditionScore" } } }, "description": "" } }, "summary": "Get Patient Body Condition Score" }, "put": { "operationId": "patient_body_condition_score_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this body condition score.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BodyConditionScoreRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BodyConditionScoreRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BodyConditionScoreRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BodyConditionScore" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BodyConditionScore" } } }, "description": "" } }, "summary": "Update Patient Body Condition Score" }, "patch": { "operationId": "patient_body_condition_score_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this body condition score.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedBodyConditionScoreRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedBodyConditionScoreRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedBodyConditionScoreRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BodyConditionScore" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BodyConditionScore" } } }, "description": "" } }, "summary": "Patch Patient Body Condition Score" }, "delete": { "operationId": "patient_body_condition_score_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this body condition score.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Body Condition Score" } }, "/patient/{parent_lookup_patient}/consultations/": { "get": { "operationId": "patient_consultations_list", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientConsultationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientConsultationList" } } }, "description": "" } }, "summary": "List Patient Consultations" }, "post": { "operationId": "patient_consultations_create", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientConsultationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientConsultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientConsultation" } } }, "description": "" } }, "summary": "Create Patient Consultations" } }, "/patient/{parent_lookup_patient}/consultations/{id}/": { "get": { "operationId": "patient_consultations_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientConsultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientConsultation" } } }, "description": "" } }, "summary": "Get Patient Consultations" }, "put": { "operationId": "patient_consultations_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientConsultationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientConsultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientConsultation" } } }, "description": "" } }, "summary": "Update Patient Consultations" }, "patch": { "operationId": "patient_consultations_partial_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientConsultationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientConsultationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientConsultationRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientConsultation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientConsultation" } } }, "description": "" } }, "summary": "Patch Patient Consultations" }, "delete": { "operationId": "patient_consultations_destroy", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Consultations" } }, "/patient/{parent_lookup_patient}/custom_field_values/": { "get": { "operationId": "patient_custom_field_values_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldValueList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedCustomFieldValueList" } } }, "description": "" } }, "summary": "List Patient Custom Field Values" }, "post": { "operationId": "patient_custom_field_values_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomFieldValueRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValue" } } }, "description": "" } }, "summary": "Create Patient Custom Field Values" } }, "/patient/{parent_lookup_patient}/custom_field_values/{id}/": { "get": { "operationId": "patient_custom_field_values_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } } }, "description": "" } }, "summary": "Get Patient Custom Field Values" }, "put": { "operationId": "patient_custom_field_values_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } } }, "description": "" } }, "summary": "Update Patient Custom Field Values" }, "patch": { "operationId": "patient_custom_field_values_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedCustomFieldValueUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdate" } } }, "description": "" } }, "summary": "Patch Patient Custom Field Values" }, "delete": { "operationId": "patient_custom_field_values_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this custom field value.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Custom Field Values" } }, "/patient/{parent_lookup_patient}/external_vaccination/": { "get": { "operationId": "patient_external_vaccination_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedExternalVaccinationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedExternalVaccinationList" } } }, "description": "" } }, "summary": "List Patient External Vaccination" }, "post": { "operationId": "patient_external_vaccination_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVaccinationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ExternalVaccinationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ExternalVaccinationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVaccination" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ExternalVaccination" } } }, "description": "" } }, "summary": "Create Patient External Vaccination" } }, "/patient/{parent_lookup_patient}/external_vaccination/{id}/": { "get": { "operationId": "patient_external_vaccination_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this external vaccination.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVaccination" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ExternalVaccination" } } }, "description": "" } }, "summary": "Get Patient External Vaccination" }, "put": { "operationId": "patient_external_vaccination_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this external vaccination.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVaccinationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ExternalVaccinationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ExternalVaccinationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVaccination" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ExternalVaccination" } } }, "description": "" } }, "summary": "Update Patient External Vaccination" }, "patch": { "operationId": "patient_external_vaccination_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this external vaccination.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedExternalVaccinationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedExternalVaccinationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedExternalVaccinationRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVaccination" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ExternalVaccination" } } }, "description": "" } }, "summary": "Patch Patient External Vaccination" } }, "/patient/{parent_lookup_patient}/extras/": { "get": { "operationId": "patient_extras_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientExtrasList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientExtrasList" } } }, "description": "" } }, "summary": "List Patient Extras" }, "post": { "operationId": "patient_extras_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientExtras" } } }, "description": "" } }, "summary": "Create Patient Extras" } }, "/patient/{parent_lookup_patient}/extras/{id}/": { "get": { "operationId": "patient_extras_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient extras.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientExtras" } } }, "description": "" } }, "summary": "Get Patient Extras" }, "put": { "operationId": "patient_extras_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient extras.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientExtras" } } }, "description": "" } }, "summary": "Update Patient Extras" }, "patch": { "operationId": "patient_extras_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient extras.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientExtrasRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientExtrasRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientExtrasRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientExtras" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientExtras" } } }, "description": "" } }, "summary": "Patch Patient Extras" }, "delete": { "operationId": "patient_extras_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient extras.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Extras" } }, "/patient/{parent_lookup_patient}/heart_rate/": { "get": { "operationId": "patient_heart_rate_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedHeartRateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedHeartRateList" } } }, "description": "" } }, "summary": "List Patient Heart Rate" }, "post": { "operationId": "patient_heart_rate_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeartRateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HeartRateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HeartRateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeartRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HeartRate" } } }, "description": "" } }, "summary": "Create Patient Heart Rate" } }, "/patient/{parent_lookup_patient}/heart_rate/{id}/": { "get": { "operationId": "patient_heart_rate_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this heart rate.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeartRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HeartRate" } } }, "description": "" } }, "summary": "Get Patient Heart Rate" }, "put": { "operationId": "patient_heart_rate_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this heart rate.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeartRateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HeartRateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/HeartRateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeartRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HeartRate" } } }, "description": "" } }, "summary": "Update Patient Heart Rate" }, "patch": { "operationId": "patient_heart_rate_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this heart rate.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedHeartRateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedHeartRateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedHeartRateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeartRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HeartRate" } } }, "description": "" } }, "summary": "Patch Patient Heart Rate" }, "delete": { "operationId": "patient_heart_rate_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this heart rate.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Heart Rate" } }, "/patient/{parent_lookup_patient}/history/": { "get": { "operationId": "patient_history_retrieve", "description": "A mixin that forces slave connection to be used for an API view.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Patient History" } }, "/patient/{parent_lookup_patient}/json_history/": { "get": { "operationId": "patient_json_history_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "keep_html_markup", "schema": { "type": "boolean" }, "description": "Set to 'true' to keep HTML markup in clinical notes and discharge instructions." }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Patient Json History" } }, "/patient/{parent_lookup_patient}/peripheral_oxygen_saturation/": { "get": { "operationId": "patient_peripheral_oxygen_saturation_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPeripheralOxygenSaturationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPeripheralOxygenSaturationList" } } }, "description": "" } }, "summary": "List Patient Peripheral Oxygen Saturation" }, "post": { "operationId": "patient_peripheral_oxygen_saturation_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } } }, "description": "" } }, "summary": "Create Patient Peripheral Oxygen Saturation" } }, "/patient/{parent_lookup_patient}/peripheral_oxygen_saturation/{id}/": { "get": { "operationId": "patient_peripheral_oxygen_saturation_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this peripheral oxygen saturation.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } } }, "description": "" } }, "summary": "Get Patient Peripheral Oxygen Saturation" }, "put": { "operationId": "patient_peripheral_oxygen_saturation_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this peripheral oxygen saturation.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturationRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } } }, "description": "" } }, "summary": "Update Patient Peripheral Oxygen Saturation" }, "patch": { "operationId": "patient_peripheral_oxygen_saturation_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this peripheral oxygen saturation.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPeripheralOxygenSaturationRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPeripheralOxygenSaturationRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPeripheralOxygenSaturationRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } } }, "description": "" } }, "summary": "Patch Patient Peripheral Oxygen Saturation" }, "delete": { "operationId": "patient_peripheral_oxygen_saturation_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this peripheral oxygen saturation.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Peripheral Oxygen Saturation" } }, "/patient/{parent_lookup_patient}/respiratory_rate/": { "get": { "operationId": "patient_respiratory_rate_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRespiratoryRateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedRespiratoryRateList" } } }, "description": "" } }, "summary": "List Patient Respiratory Rate" }, "post": { "operationId": "patient_respiratory_rate_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespiratoryRateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RespiratoryRateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RespiratoryRateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespiratoryRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RespiratoryRate" } } }, "description": "" } }, "summary": "Create Patient Respiratory Rate" } }, "/patient/{parent_lookup_patient}/respiratory_rate/{id}/": { "get": { "operationId": "patient_respiratory_rate_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this respiratory rate.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespiratoryRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RespiratoryRate" } } }, "description": "" } }, "summary": "Get Patient Respiratory Rate" }, "put": { "operationId": "patient_respiratory_rate_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this respiratory rate.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespiratoryRateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RespiratoryRateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RespiratoryRateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespiratoryRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RespiratoryRate" } } }, "description": "" } }, "summary": "Update Patient Respiratory Rate" }, "patch": { "operationId": "patient_respiratory_rate_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this respiratory rate.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedRespiratoryRateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedRespiratoryRateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedRespiratoryRateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespiratoryRate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RespiratoryRate" } } }, "description": "" } }, "summary": "Patch Patient Respiratory Rate" }, "delete": { "operationId": "patient_respiratory_rate_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this respiratory rate.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Respiratory Rate" } }, "/patient/{parent_lookup_patient}/temperature/": { "get": { "operationId": "patient_temperature_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTemperatureList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTemperatureList" } } }, "description": "" } }, "summary": "List Patient Temperature" }, "post": { "operationId": "patient_temperature_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemperatureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TemperatureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TemperatureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Temperature" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Temperature" } } }, "description": "" } }, "summary": "Create Patient Temperature" } }, "/patient/{parent_lookup_patient}/temperature/{id}/": { "get": { "operationId": "patient_temperature_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this temperature.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Temperature" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Temperature" } } }, "description": "" } }, "summary": "Get Patient Temperature" }, "put": { "operationId": "patient_temperature_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this temperature.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemperatureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TemperatureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TemperatureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Temperature" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Temperature" } } }, "description": "" } }, "summary": "Update Patient Temperature" }, "patch": { "operationId": "patient_temperature_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this temperature.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTemperatureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTemperatureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTemperatureRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Temperature" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Temperature" } } }, "description": "" } }, "summary": "Patch Patient Temperature" }, "delete": { "operationId": "patient_temperature_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this temperature.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Temperature" } }, "/patient/{parent_lookup_patient}/weight/": { "get": { "operationId": "patient_weight_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWeightList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedWeightList" } } }, "description": "" } }, "summary": "List Patient Weight" }, "post": { "operationId": "patient_weight_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeightRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WeightRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WeightRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Weight" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Weight" } } }, "description": "" } }, "summary": "Create Patient Weight" } }, "/patient/{parent_lookup_patient}/weight/{id}/": { "get": { "operationId": "patient_weight_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this weight.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Weight" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Weight" } } }, "description": "" } }, "summary": "Get Patient Weight" }, "put": { "operationId": "patient_weight_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this weight.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WeightRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WeightRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WeightRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Weight" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Weight" } } }, "description": "" } }, "summary": "Update Patient Weight" }, "patch": { "operationId": "patient_weight_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this weight.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWeightRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedWeightRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedWeightRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Weight" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Weight" } } }, "description": "" } }, "summary": "Patch Patient Weight" }, "delete": { "operationId": "patient_weight_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this weight.", "required": true }, { "in": "path", "name": "parent_lookup_patient", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Weight" } }, "/patient/{id}/": { "get": { "operationId": "patient_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 1200 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient.", "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientDetail" } } }, "description": "" } }, "summary": "Get Patient" }, "put": { "operationId": "patient_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 250 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient.", "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Patient" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Patient" } } }, "description": "" } }, "summary": "Update Patient" }, "patch": { "operationId": "patient_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 250 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient.", "required": true } ], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientPartialDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientPartialDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientPartialDetailRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientPartialDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientPartialDetail" } } }, "description": "" } }, "summary": "Patch Patient" }, "delete": { "operationId": "patient_destroy", "description": "Archives an item.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient.", "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient" } }, "/patient/{id}/merge/": { "post": { "operationId": "patient_merge_create", "description": "Merge Patient to another\n\nParameters:\n- target_patient (int) - ID for other Patient\n- data_to_keep (list|string) - Data to keep from this patient, given as a list of\n field names in JSON format\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient.", "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Patient Merge" } }, "/patient/{id}/unmerge/": { "post": { "operationId": "patient_unmerge_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient.", "required": true } ], "tags": [ "Patients" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Patient Unmerge" } }, "/patient/bulk/": { "post": { "operationId": "patient_bulk_create", "description": "Create multiple patients in bulk.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Patients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientBulkRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientBulkRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientBulkRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientBulk" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientBulk" } } }, "description": "" } }, "summary": "Create Patient Bulk" } }, "/patient_health_plan_payment/": { "get": { "operationId": "patient_health_plan_payment_list", "description": "Required permissions:\n- Health plan: Add health plan subscriptions to patients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "cancellation_invoice__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "cancellation_invoice__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "create_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "create_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "create_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "create_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "create_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "create_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "create_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "create_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "initial_payment__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "initial_payment__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "payment_status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "payment_status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "payment_status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "payment_status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "payment_status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "payment_status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "payment_status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "payment_status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "payment_status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "payment_status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "prepayment__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "prepayment__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "subscription__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "subscription__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "subscription__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "subscription__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "subscription__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "patient_health_plan_payment" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientHealthPlanPaymentList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientHealthPlanPaymentList" } } }, "description": "" } }, "summary": "List Patient Health Plan Payment" }, "post": { "operationId": "patient_health_plan_payment_create", "description": "Payments can only be created for subscriptions billed outside the system, i.e. with payment method Not specified (0) or External payment (5). Subscriptions on Monthly billing (1), advance payment (2), recurring card payments (3), Gravity (4) or Direct Debit (6) have their payment rows written by the system and reject the request with HTTP 400.", "parameters": [], "tags": [ "patient_health_plan_payment" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentCreate" } } }, "description": "" } }, "summary": "Create Patient Health Plan Payment" } }, "/patient_health_plan_payment/{id}/": { "get": { "operationId": "patient_health_plan_payment_retrieve", "description": "Required permissions:\n- Health plan: Add health plan subscriptions to patients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan payment.", "required": true } ], "tags": [ "patient_health_plan_payment" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentDetail" } } }, "description": "" } }, "summary": "Get Patient Health Plan Payment" }, "put": { "operationId": "patient_health_plan_payment_update", "description": "Moving a payment onto another subscription follows the same rule as creating one: the target subscription must be billed outside the system.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan payment.", "required": true } ], "tags": [ "patient_health_plan_payment" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentUpdate" } } }, "description": "" } }, "summary": "Update Patient Health Plan Payment" }, "patch": { "operationId": "patient_health_plan_payment_partial_update", "description": "Moving a payment onto another subscription follows the same rule as creating one: the target subscription must be billed outside the system.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan payment.", "required": true } ], "tags": [ "patient_health_plan_payment" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientHealthPlanPaymentUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientHealthPlanPaymentUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientHealthPlanPaymentUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanPaymentUpdate" } } }, "description": "" } }, "summary": "Patch Patient Health Plan Payment" } }, "/patient_location_attribute/": { "get": { "operationId": "patient_location_attribute_list", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "patient_location_attribute" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientLocationAttributeList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientLocationAttributeList" } } }, "description": "" } }, "summary": "List Patient Location Attribute" }, "post": { "operationId": "patient_location_attribute_create", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "patient_location_attribute" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocationAttributeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientLocationAttributeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientLocationAttributeRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocationAttribute" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientLocationAttribute" } } }, "description": "" } }, "summary": "Create Patient Location Attribute" } }, "/patient_location_attribute/{id}/": { "get": { "operationId": "patient_location_attribute_retrieve", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient location attribute.", "required": true } ], "tags": [ "patient_location_attribute" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocationAttribute" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientLocationAttribute" } } }, "description": "" } }, "summary": "Get Patient Location Attribute" }, "put": { "operationId": "patient_location_attribute_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient location attribute.", "required": true } ], "tags": [ "patient_location_attribute" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocationAttributeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientLocationAttributeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientLocationAttributeRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocationAttribute" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientLocationAttribute" } } }, "description": "" } }, "summary": "Update Patient Location Attribute" }, "patch": { "operationId": "patient_location_attribute_partial_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient location attribute.", "required": true } ], "tags": [ "patient_location_attribute" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientLocationAttributeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientLocationAttributeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientLocationAttributeRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientLocationAttribute" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientLocationAttribute" } } }, "description": "" } }, "summary": "Patch Patient Location Attribute" }, "delete": { "operationId": "patient_location_attribute_destroy", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient location attribute.", "required": true } ], "tags": [ "patient_location_attribute" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Location Attribute" } }, "/patient_referral/": { "get": { "operationId": "patient_referral_list", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "consultations__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "consultations__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "consultations__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "consultations__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "consultations__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "referral_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "referral_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "referral_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "referral_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "referral_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "referral_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "referral_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "referral_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Patient referrals" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientReferralList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientReferralList" } } }, "description": "" } }, "summary": "List Patient Referral" }, "post": { "operationId": "patient_referral_create", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Patient referrals" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientReferralCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientReferralCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientReferralCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientReferralCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientReferralCreate" } } }, "description": "" } }, "summary": "Create Patient Referral" } }, "/patient_referral/{id}/": { "get": { "operationId": "patient_referral_retrieve", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient referral.", "required": true } ], "tags": [ "Patient referrals" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientReferral" } } }, "description": "" } }, "summary": "Get Patient Referral" }, "put": { "operationId": "patient_referral_update", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient referral.", "required": true } ], "tags": [ "Patient referrals" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientReferralRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientReferralRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientReferralRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientReferral" } } }, "description": "" } }, "summary": "Update Patient Referral" }, "patch": { "operationId": "patient_referral_partial_update", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient referral.", "required": true } ], "tags": [ "Patient referrals" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientReferralRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientReferralRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientReferralRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientReferral" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientReferral" } } }, "description": "" } }, "summary": "Patch Patient Referral" }, "delete": { "operationId": "patient_referral_destroy", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient referral.", "required": true } ], "tags": [ "Patient referrals" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Patient Referral" } }, "/patient_referral_feedback/": { "get": { "operationId": "patient_referral_feedback_list", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Patient referrals" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReferralFeedbackList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReferralFeedbackList" } } }, "description": "" } }, "summary": "List Patient Referral Feedback" } }, "/patient_referral_feedback/{parent_lookup_referral_feedback}/attachment/": { "get": { "operationId": "patient_referral_feedback_attachment_list", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_referral_feedback", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patient referrals" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReferralFeedbackAttachmentList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReferralFeedbackAttachmentList" } } }, "description": "" } }, "summary": "List Patient Referral Feedback Attachment" } }, "/patient_referral_feedback/{parent_lookup_referral_feedback}/attachment/{id}/": { "get": { "operationId": "patient_referral_feedback_attachment_retrieve", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient referral feedback attachment.", "required": true }, { "in": "path", "name": "parent_lookup_referral_feedback", "schema": { "type": "string" }, "required": true } ], "tags": [ "Patient referrals" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralFeedbackAttachment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReferralFeedbackAttachment" } } }, "description": "" } }, "summary": "Get Patient Referral Feedback Attachment" } }, "/patient_referral_feedback/{id}/": { "get": { "operationId": "patient_referral_feedback_retrieve", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient referral feedback.", "required": true } ], "tags": [ "Patient referrals" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralFeedback" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReferralFeedback" } } }, "description": "" } }, "summary": "Get Patient Referral Feedback" } }, "/patienthealthplan/": { "get": { "operationId": "patienthealthplan_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "channel", "schema": { "type": "integer", "enum": [ 1, 2 ] }, "description": "Where the plan was sold: 1 clinic, 2 online." }, { "in": "query", "name": "channel__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "channel__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "channel__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "channel__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "channel__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "channel__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "channel__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "channel__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "channel__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "channel__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "client", "schema": { "type": "integer" }, "description": "Client id. Required for self-service integration callers: the list is always scoped to one client, and omitting the filter returns a 400. Staff callers may omit it." }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "display_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "display_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "display_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "display_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "display_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "display_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "display_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "display_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "end_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "end_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "end_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "end_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "end_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "end_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "end_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "end_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "external_subscription_id__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_subscription_id__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_subscription_id__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_subscription_id__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_subscription_id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_subscription_id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_subscription_id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_subscription_id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "payment_method__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "payment_method__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "payment_method__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "payment_method__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "payment_method__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "payment_method__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "payment_method__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "payment_method__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "payment_method__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "payment_method__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "start_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "start_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "start_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "start_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "start_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "start_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "start_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "start_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Patient health plans", "Health plan self-service" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientHealthPlanListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientHealthPlanListList" } } }, "description": "" } }, "summary": "List Patienthealthplan" }, "post": { "operationId": "patienthealthplan_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Patient health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCreate" } } }, "description": "" } }, "summary": "Create Patienthealthplan" } }, "/patienthealthplan/{id}/": { "get": { "operationId": "patienthealthplan_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan.", "required": true } ], "tags": [ "Patient health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlan" } } }, "description": "" } }, "summary": "Get Patienthealthplan" }, "put": { "operationId": "patienthealthplan_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan.", "required": true } ], "tags": [ "Patient health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlan" } } }, "description": "" } }, "summary": "Update Patienthealthplan" }, "patch": { "operationId": "patienthealthplan_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan.", "required": true } ], "tags": [ "Patient health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPatientHealthPlanRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPatientHealthPlanRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPatientHealthPlanRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlan" } } }, "description": "" } }, "summary": "Patch Patienthealthplan" } }, "/patienthealthplan/{id}/cancel/": { "post": { "operationId": "patienthealthplan_cancel_create", "description": "Cancel the plan exactly as the accepted quote priced it.\n\nThe quote id is the idempotency key: sending an accepted quote again\nreturns the stored result and changes nothing. If the numbers differ\nfrom the quote by now, nothing is cancelled and the caller must ask\nfor a new quote.\n\nRequired permissions:\n- Health plan: Health plan self service\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan.", "required": true } ], "tags": [ "Health plan self-service" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancelRequestRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancelRequestRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancelRequestRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancelResult" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancelResult" } } }, "description": "" } }, "summary": "Create Patienthealthplan Cancel" } }, "/patienthealthplan/{id}/cancellation_quote/": { "post": { "operationId": "patienthealthplan_cancellation_quote_create", "description": "Price a cancellation before the shopper confirms it.\n\nEvery call stores a new quote: the cancel call recomputes against it,\nand it is the record of what the shopper was shown. An unexpired\nquote is never reused.\n\nRequired permissions:\n- Health plan: Health plan self service\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan.", "required": true } ], "tags": [ "Health plan self-service" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancellationQuoteRequestRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancellationQuoteRequestRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancellationQuoteRequestRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancellationQuote" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanCancellationQuote" } } }, "description": "" } }, "summary": "Create Patienthealthplan Cancellation Quote" } }, "/patienthealthplan/{id}/create_upcoming/": { "post": { "operationId": "patienthealthplan_create_upcoming_create", "description": "Create upcoming plan for a provided one.\n\nThere are several checks for original plan:\n- status should be ACTIVE (1) or SUSPENDED (4)\n- renew option shouldn't be NO_RENEWAL (0)\n- original plan should have end_date\n- there shouldn't be upcoming plan already created\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan.", "required": true } ], "tags": [ "Patient health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Patienthealthplan Create Upcoming" } }, "/patienthealthplan/{id}/process_payment/": { "post": { "operationId": "patienthealthplan_process_payment_create", "description": "Process payment for patient health plan asynchronously.\n\nThis endpoint queues a task to perform the following steps:\n- Change patient health plan status to active (if it was suspended)\n- Create countersale\n- Add invoicerow to countersale\n- Finalize countersale\n- Add payment to countersale\n- Create PatientHealthPlanPayment in status \"Paid\"\n\nReturns HTTP 202 Accepted.\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 400 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan.", "required": true } ], "tags": [ "Patient health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Patienthealthplan Process Payment" } }, "/patienthealthplan/{id}/update_status/": { "post": { "operationId": "patienthealthplan_update_status_create", "description": "Update status of a plan\n\nParameters:\n- status (int): Status can be updated to value from listed below, but not to the current status value:\n ACTIVE: 1\n LAPSED: 3\n SUSPENDED: 4\n APPLIED_FOR: 5\n SIGNED: 6\n- status_note (str): Optional text will be added to log\n- cancel_reason (int): This will be required, if status is set to LAPSED. Possible values are:\n DEATH: 1\n MISSING_PAYMENTS: 2\n OTHER: 3\n- create_cancellation_invoice (bool): It is false by default. Will be ignored if plan uses external payment\n or if invoice creation for plan cancellation is disabled in organization settings\n- cancellation_fee (float): Penalty fee for quitting subscription prematurely. Including VAT. It will use\n value from organization settings, if not provided.\n- fulfilled_payments (float): Fulfilled subscription payments made by the customer. Including VAT\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan.", "required": true } ], "tags": [ "Patient health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Patienthealthplan Update Status" } }, "/patienthealthplan/cancellation_policy/": { "get": { "operationId": "patienthealthplan_cancellation_policy_retrieve", "description": "The organization's current cancellation policy.\n\nPlatforms display it before signup (pre-contract disclosure). The\npolicy is organization-wide, so this is a single object, not a list.\n\nRequired permissions:\n- Health plan: Health plan self service\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Health plan self-service" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthPlanCancellationPolicy" } }, "text/html": { "schema": { "$ref": "#/components/schemas/HealthPlanCancellationPolicy" } } }, "description": "" } }, "summary": "Get Patienthealthplan Cancellation Policy" } }, "/patienthealthplan/signup/": { "post": { "operationId": "patienthealthplan_signup_create", "description": "Join a health plan.\n\nThe platform sends template, client, patient, card, payment frequency\nand optionally its own reference; everything else is server-set from\nthe template and the card's state.\n\nRequired permissions:\n- Health plan: Health plan self service\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Health plan self-service" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanSignupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanSignupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanSignupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanSignupResult" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanSignupResult" } } }, "description": "" } }, "summary": "Create Patienthealthplan Signup" } }, "/patienthealthplanitem/": { "get": { "operationId": "patienthealthplanitem_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "health_plan__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "health_plan__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "health_plan__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "health_plan__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "health_plan__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "health_plan_item_group__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "health_plan_item_group__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "health_plan_item_group__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "health_plan_item_group__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "health_plan_item_group__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "type_code__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "type_code__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "type_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type_code__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "type_code__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "type_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type_code__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "type_code__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "used__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "used__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "used_time__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "used_time__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "used_time__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "used_time__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "used_time__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "used_time__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "used_time__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "used_time__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Patient health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientHealthPlanItemListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientHealthPlanItemListList" } } }, "description": "" } }, "summary": "List Patienthealthplanitem" } }, "/patienthealthplanitem/{id}/": { "get": { "operationId": "patienthealthplanitem_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan item.", "required": true } ], "tags": [ "Patient health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItem" } } }, "description": "" } }, "summary": "Get Patienthealthplanitem" } }, "/patienthealthplanitem/{id}/mark_used/": { "post": { "operationId": "patienthealthplanitem_mark_used_create", "description": "Set Item used quantity\n\nMark this Item used.\nParameters:\n- quantity (float): How much of the Item has been used\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan item.", "required": true } ], "tags": [ "Patient health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItem" } } }, "description": "" } }, "summary": "Create Patienthealthplanitem Mark Used" }, "put": { "operationId": "patienthealthplanitem_mark_used_update", "description": "Set Item used quantity\n\nMark this Item used.\nParameters:\n- quantity (float): How much of the Item has been used\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan item.", "required": true } ], "tags": [ "Patient health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItem" } } }, "description": "" } }, "summary": "Update Patienthealthplanitem Mark Used" } }, "/patienthealthplanitemgroup/": { "get": { "operationId": "patienthealthplanitemgroup_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "health_plan__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "health_plan__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "health_plan__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "health_plan__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "health_plan__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "health_plan_item_group__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "health_plan_item_group__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "health_plan_item_group__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "health_plan_item_group__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "health_plan_item_group__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Patient health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPatientHealthPlanItemGroupListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPatientHealthPlanItemGroupListList" } } }, "description": "" } }, "summary": "List Patienthealthplanitemgroup" } }, "/patienthealthplanitemgroup/{id}/": { "get": { "operationId": "patienthealthplanitemgroup_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan item group.", "required": true } ], "tags": [ "Patient health plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroup" } } }, "description": "" } }, "summary": "Get Patienthealthplanitemgroup" } }, "/patienthealthplanitemgroup/{id}/set_used_item_quantity/": { "post": { "operationId": "patienthealthplanitemgroup_set_used_item_quantity_create", "description": "Set Item group used items quantity\n\nParameters:\n- used_items_quantity (float): How many times has the item group been used\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan item group.", "required": true } ], "tags": [ "Patient health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroup" } } }, "description": "" } }, "summary": "Create Patienthealthplanitemgroup Set Used Item Quantity" }, "put": { "operationId": "patienthealthplanitemgroup_set_used_item_quantity_update", "description": "Set Item group used items quantity\n\nParameters:\n- used_items_quantity (float): How many times has the item group been used\n\nRequired permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this patient health plan item group.", "required": true } ], "tags": [ "Patient health plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PatientHealthPlanItemGroup" } } }, "description": "" } }, "summary": "Update Patienthealthplanitemgroup Set Used Item Quantity" } }, "/paymentcard/": { "post": { "operationId": "paymentcard_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Payment cards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentCardRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PaymentCardRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PaymentCardRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentCard" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentCard" } } }, "description": "" } }, "summary": "Create Paymentcard" } }, "/paymentmethod/": { "get": { "operationId": "paymentmethod_list", "description": "Required permissions:\n- Settings: Settings page\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "code__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "code__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "code__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "code__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "code__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "code__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "is_active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Payment methods" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPaymentMethodList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPaymentMethodList" } } }, "description": "" } }, "summary": "List Paymentmethod" } }, "/paymentmethod/{id}/": { "get": { "operationId": "paymentmethod_retrieve", "description": "Required permissions:\n- Settings: Settings page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this payment method.", "required": true } ], "tags": [ "Payment methods" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaymentMethod" } } }, "description": "" } }, "summary": "Get Paymentmethod" } }, "/paymenttypeaccountingnumbers/": { "get": { "operationId": "paymenttypeaccountingnumbers_retrieve", "description": "Required permissions:\n- Financial: End of day and accounting reports\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department_id", "schema": { "type": "string" }, "description": "If not provided, get the first department" } ], "tags": [ "Payment type accounting numbers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Paymenttypeaccountingnumbers" } }, "/personnel_group/": { "get": { "operationId": "personnel_group_list", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Personnel groups" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPersonnelGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPersonnelGroupList" } } }, "description": "" } }, "summary": "List Personnel Group" }, "post": { "operationId": "personnel_group_create", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Personnel groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonnelGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PersonnelGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PersonnelGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonnelGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PersonnelGroup" } } }, "description": "" } }, "summary": "Create Personnel Group" } }, "/personnel_group/{id}/": { "get": { "operationId": "personnel_group_retrieve", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personnel group.", "required": true } ], "tags": [ "Personnel groups" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonnelGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PersonnelGroup" } } }, "description": "" } }, "summary": "Get Personnel Group" }, "put": { "operationId": "personnel_group_update", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personnel group.", "required": true } ], "tags": [ "Personnel groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonnelGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PersonnelGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PersonnelGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonnelGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PersonnelGroup" } } }, "description": "" } }, "summary": "Update Personnel Group" }, "patch": { "operationId": "personnel_group_partial_update", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this personnel group.", "required": true } ], "tags": [ "Personnel groups" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPersonnelGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPersonnelGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPersonnelGroupRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonnelGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PersonnelGroup" } } }, "description": "" } }, "summary": "Patch Personnel Group" } }, "/petmedchain/document/": { "get": { "operationId": "petmedchain_document_list", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Petmedchain" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPetmedchainDocumentList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPetmedchainDocumentList" } } }, "description": "" } }, "summary": "List Petmedchain Document" }, "post": { "operationId": "petmedchain_document_create", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Petmedchain" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainDocumentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PetmedchainDocumentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PetmedchainDocumentRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainDocument" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PetmedchainDocument" } } }, "description": "" } }, "summary": "Create Petmedchain Document" } }, "/petmedchain/document/{id}/": { "get": { "operationId": "petmedchain_document_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this document.", "required": true } ], "tags": [ "Petmedchain" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainDocument" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PetmedchainDocument" } } }, "description": "" } }, "summary": "Get Petmedchain Document" }, "put": { "operationId": "petmedchain_document_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this document.", "required": true } ], "tags": [ "Petmedchain" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainDocumentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PetmedchainDocumentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PetmedchainDocumentRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainDocument" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PetmedchainDocument" } } }, "description": "" } }, "summary": "Update Petmedchain Document" }, "patch": { "operationId": "petmedchain_document_partial_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this document.", "required": true } ], "tags": [ "Petmedchain" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPetmedchainDocumentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPetmedchainDocumentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPetmedchainDocumentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainDocument" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PetmedchainDocument" } } }, "description": "" } }, "summary": "Patch Petmedchain Document" }, "delete": { "operationId": "petmedchain_document_destroy", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this document.", "required": true } ], "tags": [ "Petmedchain" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Petmedchain Document" } }, "/petmedchain/pet/": { "get": { "operationId": "petmedchain_pet_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Petmedchain" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPetmedchainPetList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPetmedchainPetList" } } }, "description": "" } }, "summary": "List Petmedchain Pet" }, "post": { "operationId": "petmedchain_pet_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Petmedchain" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainPetRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PetmedchainPetRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PetmedchainPetRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainPet" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PetmedchainPet" } } }, "description": "" } }, "summary": "Create Petmedchain Pet" } }, "/petmedchain/pet-shared/": { "post": { "operationId": "petmedchain_pet_shared_create", "description": "This endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Petmedchain" ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Petmedchain Pet Shared" } }, "/petmedchain/pet/{id}/": { "get": { "operationId": "petmedchain_pet_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pet.", "required": true } ], "tags": [ "Petmedchain" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainPet" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PetmedchainPet" } } }, "description": "" } }, "summary": "Get Petmedchain Pet" }, "put": { "operationId": "petmedchain_pet_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pet.", "required": true } ], "tags": [ "Petmedchain" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainPetRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PetmedchainPetRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PetmedchainPetRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainPet" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PetmedchainPet" } } }, "description": "" } }, "summary": "Update Petmedchain Pet" }, "patch": { "operationId": "petmedchain_pet_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pet.", "required": true } ], "tags": [ "Petmedchain" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPetmedchainPetRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPetmedchainPetRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPetmedchainPetRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PetmedchainPet" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PetmedchainPet" } } }, "description": "" } }, "summary": "Patch Petmedchain Pet" }, "delete": { "operationId": "petmedchain_pet_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pet.", "required": true } ], "tags": [ "Petmedchain" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Petmedchain Pet" } }, "/petmedchain/settings/": { "get": { "operationId": "petmedchain_settings_retrieve", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Petmedchain" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Petmedchain Settings" }, "post": { "operationId": "petmedchain_settings_create", "description": "Required permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Petmedchain" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Petmedchain Settings" } }, "/phonenumber/": { "get": { "operationId": "phonenumber_list", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 900 requests per minute.", "parameters": [ { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "phone_number__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "phone_number__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "phone_number__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "phone_number__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "phone_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "phone_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "phone_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "phone_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type_code__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "type_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Phone numbers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPhoneList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPhoneList" } } }, "description": "" } }, "summary": "List Phonenumber" }, "post": { "operationId": "phonenumber_create", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 900 requests per minute.", "parameters": [], "tags": [ "Phone numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PhoneRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PhoneRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Phone" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Phone" } } }, "description": "" } }, "summary": "Create Phonenumber" } }, "/phonenumber/{id}/": { "get": { "operationId": "phonenumber_retrieve", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 3600 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this phone.", "required": true } ], "tags": [ "Phone numbers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Phone" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Phone" } } }, "description": "" } }, "summary": "Get Phonenumber" }, "put": { "operationId": "phonenumber_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 900 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this phone.", "required": true } ], "tags": [ "Phone numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PhoneRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PhoneRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Phone" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Phone" } } }, "description": "" } }, "summary": "Update Phonenumber" }, "patch": { "operationId": "phonenumber_partial_update", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 900 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this phone.", "required": true } ], "tags": [ "Phone numbers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedPhoneRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedPhoneRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedPhoneRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Phone" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Phone" } } }, "description": "" } }, "summary": "Patch Phonenumber" }, "delete": { "operationId": "phonenumber_destroy", "description": "Required permissions:\n- General: Patients and clients\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this phone.", "required": true } ], "tags": [ "Phone numbers" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Phonenumber" } }, "/portalclientlink/": { "get": { "operationId": "portalclientlink_list", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "portalclientlink" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPortalClientLinkList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPortalClientLinkList" } } }, "description": "" } }, "summary": "List Portalclientlink" }, "post": { "operationId": "portalclientlink_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "portalclientlink" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalClientLink" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PortalClientLink" } } }, "description": "" } }, "summary": "Create Portalclientlink" } }, "/portalclientlink/{id}/": { "get": { "operationId": "portalclientlink_retrieve", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this portal client link.", "required": true } ], "tags": [ "portalclientlink" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalClientLink" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PortalClientLink" } } }, "description": "" } }, "summary": "Get Portalclientlink" } }, "/portalclientlink/{id}/block/": { "post": { "operationId": "portalclientlink_block_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this portal client link.", "required": true } ], "tags": [ "portalclientlink" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalClientLink" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PortalClientLink" } } }, "description": "" } }, "summary": "Create Portalclientlink Block" } }, "/portalclientlink/{id}/unlink/": { "post": { "operationId": "portalclientlink_unlink_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this portal client link.", "required": true } ], "tags": [ "portalclientlink" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PortalClientLinkRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalClientLink" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PortalClientLink" } } }, "description": "" } }, "summary": "Create Portalclientlink Unlink" } }, "/postransaction/": { "get": { "operationId": "postransaction_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Pos transactions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Postransaction" }, "post": { "operationId": "postransaction_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Pos transactions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosTransactionCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PosTransactionCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PosTransactionCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosTransaction" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PosTransaction" } } }, "description": "" } }, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "request body was already required at runtime; it was only undocumented because create() swaps in PosTransactionCreateSerializer at runtime via with_serializer, which the static schema generator couldn't see", "summary": "Create Postransaction" } }, "/postransaction/{id}/": { "get": { "operationId": "postransaction_retrieve_2", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pos transaction.", "required": true } ], "tags": [ "Pos transactions" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Postransaction" }, "delete": { "operationId": "postransaction_destroy", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pos transaction.", "required": true } ], "tags": [ "Pos transactions" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Postransaction" } }, "/postransactionresult/": { "get": { "operationId": "postransactionresult_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "transaction__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "transaction__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "transaction__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "transaction__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "transaction__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "POS transaction results" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPosTransactionResultList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPosTransactionResultList" } } }, "description": "" } }, "summary": "List Postransactionresult" }, "post": { "operationId": "postransactionresult_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "POS transaction results" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosTransactionResultRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PosTransactionResultRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PosTransactionResultRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosTransactionResult" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PosTransactionResult" } } }, "description": "" } }, "summary": "Create Postransactionresult" } }, "/postransactionresult/{id}/": { "get": { "operationId": "postransactionresult_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this pos transaction result.", "required": true } ], "tags": [ "POS transaction results" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PosTransactionResult" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PosTransactionResult" } } }, "description": "" } }, "summary": "Get Postransactionresult" } }, "/preliminary_booking/": { "get": { "operationId": "preliminary_booking_list", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Preliminary bookings" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPreliminaryBookingList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPreliminaryBookingList" } } }, "description": "" } }, "summary": "List Preliminary Booking" }, "post": { "operationId": "preliminary_booking_create", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Preliminary bookings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreliminaryBookingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PreliminaryBookingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PreliminaryBookingRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreliminaryBooking" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PreliminaryBooking" } } }, "description": "" } }, "summary": "Create Preliminary Booking" } }, "/preliminary_booking/{id}/": { "get": { "operationId": "preliminary_booking_retrieve", "description": "Required permissions:\n- Calendar: Appointments\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this appointment.", "required": true } ], "tags": [ "Preliminary bookings" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreliminaryBooking" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PreliminaryBooking" } } }, "description": "" } }, "summary": "Get Preliminary Booking" } }, "/prescription_repeat/": { "get": { "operationId": "prescription_repeat_list", "description": "Required permissions:\n- General: Patients and clients\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "prescription_repeat" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPrescriptionRepeatList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPrescriptionRepeatList" } } }, "description": "" } }, "summary": "List Prescription Repeat" } }, "/prescription_repeat/{id}/": { "get": { "operationId": "prescription_repeat_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this prescription repeat.", "required": true } ], "tags": [ "prescription_repeat" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrescriptionRepeat" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PrescriptionRepeat" } } }, "description": "" } }, "summary": "Get Prescription Repeat" } }, "/prescription_repeat/{id}/cancel/": { "post": { "operationId": "prescription_repeat_cancel_create", "description": "Cancel refills.\n\nRequired permissions:\n- General: Patients and clients\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this prescription repeat.", "required": true } ], "tags": [ "prescription_repeat" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrescriptionRepeatRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PrescriptionRepeatRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PrescriptionRepeatRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrescriptionRepeat" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PrescriptionRepeat" } } }, "description": "" } }, "summary": "Create Prescription Repeat Cancel" } }, "/prescriptioninvoicerow/billing/": { "get": { "operationId": "prescriptioninvoicerow_billing_list", "description": "List Prescription Billings that do not have any error.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "max", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } } ], "tags": [ "Prescription invoice rows" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPrescriptionBillingList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPrescriptionBillingList" } } }, "description": "" } }, "summary": "List Prescriptioninvoicerow Billing" }, "post": { "operationId": "prescriptioninvoicerow_billing_create", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Prescription invoice rows" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrescriptionBilling" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PrescriptionBilling" } } }, "description": "" } }, "summary": "Create Prescriptioninvoicerow Billing" } }, "/prescriptioninvoicerow/billing/errors/": { "get": { "operationId": "prescriptioninvoicerow_billing_errors_list", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "max", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } } ], "tags": [ "Prescription invoice rows" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedPrescriptionBillingErrorList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedPrescriptionBillingErrorList" } } }, "description": "" } }, "summary": "List Prescriptioninvoicerow Billing Errors" }, "post": { "operationId": "prescriptioninvoicerow_billing_errors_create", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Prescription invoice rows" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrescriptionBillingError" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PrescriptionBillingError" } } }, "description": "" } }, "summary": "Create Prescriptioninvoicerow Billing Errors" } }, "/procedure/": { "get": { "operationId": "procedure_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "created_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "created_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_2__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_2__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_3__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_3__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modified_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modified_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Procedures" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedProcedureListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedProcedureListList" } } }, "description": "" } }, "summary": "List Procedure" }, "post": { "operationId": "procedure_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Procedures" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProcedureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Procedure" } } }, "description": "" } }, "summary": "Create Procedure" } }, "/procedure/{id}/": { "get": { "operationId": "procedure_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this procedure.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Procedures" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Procedure" } } }, "description": "" } }, "summary": "Get Procedure" }, "put": { "operationId": "procedure_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this procedure.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Procedures" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ProcedureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Procedure" } } }, "description": "" } }, "summary": "Update Procedure" }, "patch": { "operationId": "procedure_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this procedure.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Procedures" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedProcedureRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Procedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Procedure" } } }, "description": "" } }, "summary": "Patch Procedure" }, "delete": { "operationId": "procedure_destroy", "description": "Archives an item.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this procedure.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Procedures" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Procedure" } }, "/reason/": { "get": { "operationId": "reason_list", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "available_for_department", "schema": { "type": "integer" }, "description": "Return reasons usable in this department: reasons whose group belongs to the department plus department-null common reasons. Equivalent to exhausting both ?group.department={id} and ?group.department__is_null in a single call." }, { "in": "query", "name": "available_online__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "available_online__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "group__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "group__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "group__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "group__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "group__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "telemedicine__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "telemedicine__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" } ], "tags": [ "Reasons" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReasonList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReasonList" } } }, "description": "" } }, "summary": "List Reason" }, "post": { "operationId": "reason_create", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "available_for_department", "schema": { "type": "integer" }, "description": "Return reasons usable in this department: reasons whose group belongs to the department plus department-null common reasons. Equivalent to exhausting both ?group.department={id} and ?group.department__is_null in a single call." } ], "tags": [ "Reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReasonRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReasonRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reason" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "" } }, "summary": "Create Reason" } }, "/reason/{id}/": { "get": { "operationId": "reason_retrieve", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "available_for_department", "schema": { "type": "integer" }, "description": "Return reasons usable in this department: reasons whose group belongs to the department plus department-null common reasons. Equivalent to exhausting both ?group.department={id} and ?group.department__is_null in a single call." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this complaint type.", "required": true } ], "tags": [ "Reasons" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reason" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "" } }, "summary": "Get Reason" }, "put": { "operationId": "reason_update", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "available_for_department", "schema": { "type": "integer" }, "description": "Return reasons usable in this department: reasons whose group belongs to the department plus department-null common reasons. Equivalent to exhausting both ?group.department={id} and ?group.department__is_null in a single call." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this complaint type.", "required": true } ], "tags": [ "Reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReasonRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReasonRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reason" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "" } }, "summary": "Update Reason" }, "patch": { "operationId": "reason_partial_update", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "available_for_department", "schema": { "type": "integer" }, "description": "Return reasons usable in this department: reasons whose group belongs to the department plus department-null common reasons. Equivalent to exhausting both ?group.department={id} and ?group.department__is_null in a single call." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this complaint type.", "required": true } ], "tags": [ "Reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedReasonRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedReasonRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedReasonRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reason" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reason" } } }, "description": "" } }, "summary": "Patch Reason" }, "delete": { "operationId": "reason_destroy", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "available_for_department", "schema": { "type": "integer" }, "description": "Return reasons usable in this department: reasons whose group belongs to the department plus department-null common reasons. Equivalent to exhausting both ?group.department={id} and ?group.department__is_null in a single call." }, { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this complaint type.", "required": true } ], "tags": [ "Reasons" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Reason" } }, "/reason_group/": { "get": { "operationId": "reason_group_list", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Reasons" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReasonGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReasonGroupList" } } }, "description": "" } }, "summary": "List Reason Group" }, "post": { "operationId": "reason_group_create", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReasonGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReasonGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReasonGroup" } } }, "description": "" } }, "summary": "Create Reason Group" } }, "/reason_group/{id}/": { "get": { "operationId": "reason_group_retrieve", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this complaint type group.", "required": true } ], "tags": [ "Reasons" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReasonGroup" } } }, "description": "" } }, "summary": "Get Reason Group" }, "put": { "operationId": "reason_group_update", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this complaint type group.", "required": true } ], "tags": [ "Reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReasonGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReasonGroupRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReasonGroup" } } }, "description": "" } }, "summary": "Update Reason Group" }, "patch": { "operationId": "reason_group_partial_update", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this complaint type group.", "required": true } ], "tags": [ "Reasons" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedReasonGroupRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedReasonGroupRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedReasonGroupRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReasonGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReasonGroup" } } }, "description": "" } }, "summary": "Patch Reason Group" }, "delete": { "operationId": "reason_group_destroy", "description": "Required permissions:\n- Settings: Reasons\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this complaint type group.", "required": true } ], "tags": [ "Reasons" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Reason Group" } }, "/receivablesfiles/": { "get": { "operationId": "receivablesfiles_list", "description": "Required permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "receivablesfiles" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReceivablesFileList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReceivablesFileList" } } }, "description": "" } }, "summary": "List Receivablesfiles" }, "post": { "operationId": "receivablesfiles_create", "description": "Required permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "receivablesfiles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesFileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReceivablesFileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReceivablesFileRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesFile" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReceivablesFile" } } }, "description": "" } }, "summary": "Create Receivablesfiles" } }, "/receivablesfiles/{id}/": { "get": { "operationId": "receivablesfiles_retrieve", "description": "Required permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this bank payment file.", "required": true } ], "tags": [ "receivablesfiles" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesFile" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReceivablesFile" } } }, "description": "" } }, "summary": "Get Receivablesfiles" }, "put": { "operationId": "receivablesfiles_update", "description": "Required permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this bank payment file.", "required": true } ], "tags": [ "receivablesfiles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesFileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReceivablesFileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReceivablesFileRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesFile" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReceivablesFile" } } }, "description": "" } }, "summary": "Update Receivablesfiles" }, "patch": { "operationId": "receivablesfiles_partial_update", "description": "Required permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this bank payment file.", "required": true } ], "tags": [ "receivablesfiles" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedReceivablesFileRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedReceivablesFileRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedReceivablesFileRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesFile" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReceivablesFile" } } }, "description": "" } }, "summary": "Patch Receivablesfiles" }, "delete": { "operationId": "receivablesfiles_destroy", "description": "Required permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this bank payment file.", "required": true } ], "tags": [ "receivablesfiles" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Receivablesfiles" } }, "/receivablespayments/": { "get": { "operationId": "receivablespayments_list", "description": "Receivables Payments (also called bankpayment rows/payments)\n\nRequired permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "receivablespayments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReceivablesPaymentList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReceivablesPaymentList" } } }, "description": "" } }, "summary": "List Receivablespayments" }, "post": { "operationId": "receivablespayments_create", "description": "Required permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "receivablespayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesPaymentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReceivablesPaymentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReceivablesPaymentRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReceivablesPayment" } } }, "description": "" } }, "summary": "Create Receivablespayments" } }, "/receivablespayments/{id}/": { "get": { "operationId": "receivablespayments_retrieve", "description": "Receivables Payments (also called bankpayment rows/payments)\n\nRequired permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this bank payment row.", "required": true } ], "tags": [ "receivablespayments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReceivablesPayment" } } }, "description": "" } }, "summary": "Get Receivablespayments" }, "put": { "operationId": "receivablespayments_update", "description": "Receivables Payments (also called bankpayment rows/payments)\n\nRequired permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this bank payment row.", "required": true } ], "tags": [ "receivablespayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesPaymentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReceivablesPaymentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReceivablesPaymentRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReceivablesPayment" } } }, "description": "" } }, "summary": "Update Receivablespayments" }, "patch": { "operationId": "receivablespayments_partial_update", "description": "Receivables Payments (also called bankpayment rows/payments)\n\nRequired permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this bank payment row.", "required": true } ], "tags": [ "receivablespayments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedReceivablesPaymentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedReceivablesPaymentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedReceivablesPaymentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivablesPayment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReceivablesPayment" } } }, "description": "" } }, "summary": "Patch Receivablespayments" }, "delete": { "operationId": "receivablespayments_destroy", "description": "Receivables Payments (also called bankpayment rows/payments)\n\nRequired permissions:\n- Reporting: Reports page\n- Reporting: Financial Bank payment processing reports\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this bank payment row.", "required": true } ], "tags": [ "receivablespayments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Receivablespayments" } }, "/recently_viewed/": { "get": { "operationId": "recently_viewed_list", "description": "Read only API\nReturn current user recently viewed records in current active department\nDepends on the content type, the structure of the history item data will be different\nCurrently the following view history data is recorded:\n- Consultation details\n- Client details\n- Patient details\n- Invoice details\n- Estimate\n- Laboratory Referral\n- Imaging Referral\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "recently_viewed" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserViewHistoryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedUserViewHistoryList" } } }, "description": "" } }, "summary": "List Recently Viewed" } }, "/recently_viewed/{id}/": { "get": { "operationId": "recently_viewed_retrieve", "description": "Read only API\nReturn current user recently viewed records in current active department\nDepends on the content type, the structure of the history item data will be different\nCurrently the following view history data is recorded:\n- Consultation details\n- Client details\n- Patient details\n- Invoice details\n- Estimate\n- Laboratory Referral\n- Imaging Referral\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user view history.", "required": true } ], "tags": [ "recently_viewed" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserViewHistory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserViewHistory" } } }, "description": "" } }, "summary": "Get Recently Viewed" } }, "/referralinternalstatus/": { "get": { "operationId": "referralinternalstatus_list", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Referral internal status" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReferralInternalStatusList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReferralInternalStatusList" } } }, "description": "" } }, "summary": "List Referralinternalstatus" } }, "/referralinternalstatus/{id}/": { "get": { "operationId": "referralinternalstatus_retrieve", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this referral internal status.", "required": true } ], "tags": [ "Referral internal status" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferralInternalStatus" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReferralInternalStatus" } } }, "description": "" } }, "summary": "Get Referralinternalstatus" } }, "/referrer/": { "get": { "operationId": "referrer_list", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Referrers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReferrerList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReferrerList" } } }, "description": "" } }, "summary": "List Referrer" }, "post": { "operationId": "referrer_create", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Referrers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferrerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReferrerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReferrerRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Referrer" } } }, "description": "" } }, "summary": "Create Referrer" } }, "/referrer/{id}/": { "get": { "operationId": "referrer_retrieve", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this referrer.", "required": true } ], "tags": [ "Referrers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Referrer" } } }, "description": "" } }, "summary": "Get Referrer" }, "put": { "operationId": "referrer_update", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this referrer.", "required": true } ], "tags": [ "Referrers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferrerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReferrerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReferrerRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Referrer" } } }, "description": "" } }, "summary": "Update Referrer" }, "patch": { "operationId": "referrer_partial_update", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this referrer.", "required": true } ], "tags": [ "Referrers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedReferrerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedReferrerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedReferrerRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Referrer" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Referrer" } } }, "description": "" } }, "summary": "Patch Referrer" }, "delete": { "operationId": "referrer_destroy", "description": "Required permissions:\n- Patient referrals: Patient referrals\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this referrer.", "required": true } ], "tags": [ "Referrers" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Referrer" } }, "/refill_item/": { "get": { "operationId": "refill_item_list", "description": "Required permissions:\n- General: Patients and clients\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "refill_item" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedRefillItemList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedRefillItemList" } } }, "description": "" } }, "summary": "List Refill Item" }, "post": { "operationId": "refill_item_create", "description": "Required permissions:\n- General: Patients and clients\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "refill_item" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/RefillItemCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RefillItemCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItemCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RefillItemCreate" } } }, "description": "" } }, "summary": "Create Refill Item" } }, "/refill_item/{id}/": { "get": { "operationId": "refill_item_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this refill item.", "required": true } ], "tags": [ "refill_item" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefillItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/RefillItem" } } }, "description": "" } }, "summary": "Get Refill Item" } }, "/reminder/": { "get": { "operationId": "reminder_list", "description": "Required permissions:\n- General: Reminders\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "patient__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "patient__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "patient__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "patient__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "patient__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "planned_sending_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "planned_sending_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "planned_sending_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "planned_sending_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "planned_sending_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "planned_sending_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "planned_sending_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "planned_sending_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Reminders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReminderList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReminderList" } } }, "description": "" } }, "summary": "List Reminder" }, "post": { "operationId": "reminder_create", "description": "Required permissions:\n- General: Reminders\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reminder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reminder" } } }, "description": "" } }, "summary": "Create Reminder" } }, "/reminder/{id}/": { "get": { "operationId": "reminder_retrieve", "description": "Required permissions:\n- General: Reminders\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this reminder.", "required": true } ], "tags": [ "Reminders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reminder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reminder" } } }, "description": "" } }, "summary": "Get Reminder" }, "put": { "operationId": "reminder_update", "description": "Required permissions:\n- General: Reminders\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this reminder.", "required": true } ], "tags": [ "Reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reminder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reminder" } } }, "description": "" } }, "summary": "Update Reminder" }, "patch": { "operationId": "reminder_partial_update", "description": "Required permissions:\n- General: Reminders\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this reminder.", "required": true } ], "tags": [ "Reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedReminderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedReminderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedReminderRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reminder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reminder" } } }, "description": "" } }, "summary": "Patch Reminder" }, "delete": { "operationId": "reminder_destroy", "description": "Required permissions:\n- General: Reminders\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this reminder.", "required": true } ], "tags": [ "Reminders" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Reminder" } }, "/reminder/{id}/mark_sent/": { "put": { "operationId": "reminder_mark_sent_update", "description": "Mark a Reminder sent\n\nThe Reminder must not have been marked as sent before and it must have an\nexternal sending method for this to work.\n\nRequired permissions:\n- General: Reminders\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this reminder.", "required": true } ], "tags": [ "Reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReminderRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reminder" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Reminder" } } }, "description": "" } }, "summary": "Update Reminder Mark Sent" } }, "/remindertemplate/": { "get": { "operationId": "remindertemplate_list", "description": "Required permissions:\n- Settings: Reminder settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "title__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "title__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "title__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "title__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "title__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "title__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "title__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "title__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Reminders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedReminderTemplateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedReminderTemplateList" } } }, "description": "" } }, "summary": "List Remindertemplate" }, "post": { "operationId": "remindertemplate_create", "description": "Required permissions:\n- Settings: Reminder settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReminderTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReminderTemplateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReminderTemplate" } } }, "description": "" } }, "summary": "Create Remindertemplate" } }, "/remindertemplate/{id}/": { "get": { "operationId": "remindertemplate_retrieve", "description": "Required permissions:\n- Settings: Reminder settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Reminder template.", "required": true } ], "tags": [ "Reminders" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReminderTemplate" } } }, "description": "" } }, "summary": "Get Remindertemplate" }, "put": { "operationId": "remindertemplate_update", "description": "Required permissions:\n- Settings: Reminder settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Reminder template.", "required": true } ], "tags": [ "Reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReminderTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ReminderTemplateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReminderTemplate" } } }, "description": "" } }, "summary": "Update Remindertemplate" }, "patch": { "operationId": "remindertemplate_partial_update", "description": "Required permissions:\n- Settings: Reminder settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Reminder template.", "required": true } ], "tags": [ "Reminders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedReminderTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedReminderTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedReminderTemplateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReminderTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ReminderTemplate" } } }, "description": "" } }, "summary": "Patch Remindertemplate" }, "delete": { "operationId": "remindertemplate_destroy", "description": "Required permissions:\n- Settings: Reminder settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this Reminder template.", "required": true } ], "tags": [ "Reminders" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Remindertemplate" } }, "/resource/": { "get": { "operationId": "resource_list", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "initials__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "initials__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "initials__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "initials__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "initials__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "initials__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "initials__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "initials__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "is_active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "sharing_department_groups__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "sharing_department_groups__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "sharing_department_groups__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "sharing_department_groups__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "sharing_department_groups__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "sharing_departments__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "sharing_departments__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "sharing_departments__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "sharing_departments__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "sharing_departments__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Resources" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourceDetailList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedResourceDetailList" } } }, "description": "" } }, "summary": "List Resource" }, "post": { "operationId": "resource_create", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Resources" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ResourceDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ResourceDetailRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ResourceDetail" } } }, "description": "" } }, "summary": "Create Resource" } }, "/resource/{id}/": { "get": { "operationId": "resource_retrieve", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this resource.", "required": true } ], "tags": [ "Resources" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ResourceDetail" } } }, "description": "" } }, "summary": "Get Resource" }, "put": { "operationId": "resource_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this resource.", "required": true } ], "tags": [ "Resources" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ResourceDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ResourceDetailRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ResourceDetail" } } }, "description": "" } }, "summary": "Update Resource" }, "patch": { "operationId": "resource_partial_update", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this resource.", "required": true } ], "tags": [ "Resources" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedResourceDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedResourceDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedResourceDetailRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ResourceDetail" } } }, "description": "" } }, "summary": "Patch Resource" } }, "/resources_availability/": { "get": { "operationId": "resources_availability_list", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "available_to", "schema": { "type": "string" } }, { "in": "query", "name": "department_id", "schema": { "type": "integer" }, "required": true }, { "in": "query", "name": "duration", "schema": { "type": "integer" }, "required": true }, { "in": "query", "name": "end", "schema": { "type": "string" }, "required": true }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "reason", "schema": { "type": "boolean" } }, { "in": "query", "name": "show_extra", "schema": { "type": "boolean" } }, { "in": "query", "name": "start", "schema": { "type": "string" }, "required": true } ], "tags": [ "resources_availability" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResourcesAvailabilityList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedResourcesAvailabilityList" } } }, "description": "" } }, "summary": "List Resources Availability" } }, "/search/": { "get": { "operationId": "search_retrieve", "description": "Search across clients, patients, items, and bundles.\n\nQuery parameters:\n\n- ``search`` (required): The search string.\n- ``result_type``: Data type to filter by (e.g. client_patient, item, bundle).\n- ``department_id``: Department ID to scope the search to. Falls back to the user's active department if not provided.\n- ``department_group_id``: Only search for resources at a specific department group.\n\nThis view does not require permissions because search results are\nscoped to the authenticated organization via provet_id.", "parameters": [ { "in": "header", "name": "Enable-Supersearch-Profiling", "schema": { "type": "string" }, "description": "Requests OpenSearch profiling info in the response (executed query, shard-level profile tree, took timings). Presence of this header enables profiling regardless of its value - e.g. 'false' or '0' also enable it, matching the existing Enable-Pyinstrument-Profiling / Enable-Silk-Profiling debug headers. Only honored in non-production environments (DEBUG, TESTING_MODE, or reviewapp) — ignored elsewhere." }, { "in": "query", "name": "department_group_id", "schema": { "type": "string" }, "description": "Only search for resources at a specific department group." }, { "in": "query", "name": "department_id", "schema": { "type": "string" }, "description": "Department ID to scope the search to. Falls back to the user's active department if not provided." }, { "in": "query", "name": "fields", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "description": "endpoint return only specific fields in the response on a per-type basis by including a fields[TYPE] query parameter.", "explode": true, "style": "deepObject" }, { "in": "path", "name": "provet_id", "schema": { "type": "string" }, "description": "Provet instance ID.", "required": true }, { "in": "query", "name": "result_type", "schema": { "type": "string" }, "description": "Data type to filter by (e.g. client_patient, item, bundle)." }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "The search string.", "required": true } ], "tags": [ "Search" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NavigationSearchResult" } } }, "description": "" }, "400": { "description": "bad request", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" } } } }, "401": { "description": "not authorized", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" } } } }, "406": { "description": "not acceptable", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" } } } }, "429": { "description": "too many requests", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" } } } }, "404": { "description": "not found", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" } } } }, "403": { "description": "[Forbidden](https://jsonapi.org/format/#crud-creating-responses-403)", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/failure" } } } } }, "summary": "Get Search" } }, "/settings/department/": { "get": { "operationId": "settings_department_list", "description": "Department Settings API\n\nThis module provides ability to update limited set of department settings.\n\nOperations:\n\nRequired permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "settings" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDepartmentSettingsApiList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDepartmentSettingsApiList" } } }, "description": "" } }, "summary": "List Settings Department" } }, "/settings/department/{id}/": { "get": { "operationId": "settings_department_retrieve", "description": "Department Settings API\n\nThis module provides ability to update limited set of department settings.\n\nOperations:\n\nRequired permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this department settings.", "required": true } ], "tags": [ "settings" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApi" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApi" } } }, "description": "" } }, "summary": "Get Settings Department" }, "put": { "operationId": "settings_department_update", "description": "Department Settings API\n\nThis module provides ability to update limited set of department settings.\n\nOperations:\n\nRequired permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this department settings.", "required": true } ], "tags": [ "settings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApiRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApiRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApiRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApi" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApi" } } }, "description": "" } }, "summary": "Update Settings Department" }, "patch": { "operationId": "settings_department_partial_update", "description": "Department Settings API\n\nThis module provides ability to update limited set of department settings.\n\nOperations:\n\nRequired permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this department settings.", "required": true } ], "tags": [ "settings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedDepartmentSettingsApiRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedDepartmentSettingsApiRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedDepartmentSettingsApiRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApi" } }, "text/html": { "schema": { "$ref": "#/components/schemas/DepartmentSettingsApi" } } }, "description": "" } }, "summary": "Patch Settings Department" } }, "/settings/organization/": { "get": { "operationId": "settings_organization_list", "description": "Organization Settings API\n\nThis module provides ability to update limited set of organization settings.\n\nOperations:\n\nRequired permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "settings" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedOrganizationSettingsList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedOrganizationSettingsList" } } }, "description": "" } }, "summary": "List Settings Organization" } }, "/settings/organization/{id}/": { "get": { "operationId": "settings_organization_retrieve", "description": "Organization Settings API\n\nThis module provides ability to update limited set of organization settings.\n\nOperations:\n\nRequired permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this organization settings.", "required": true } ], "tags": [ "settings" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationSettings" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrganizationSettings" } } }, "description": "" } }, "summary": "Get Settings Organization" }, "put": { "operationId": "settings_organization_update", "description": "Organization Settings API\n\nThis module provides ability to update limited set of organization settings.\n\nOperations:\n\nRequired permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this organization settings.", "required": true } ], "tags": [ "settings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationSettingsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrganizationSettingsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/OrganizationSettingsRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationSettings" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrganizationSettings" } } }, "description": "" } }, "summary": "Update Settings Organization" }, "patch": { "operationId": "settings_organization_partial_update", "description": "Organization Settings API\n\nThis module provides ability to update limited set of organization settings.\n\nOperations:\n\nRequired permissions:\n- Settings: Organization settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this organization settings.", "required": true } ], "tags": [ "settings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationSettingsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationSettingsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedOrganizationSettingsRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationSettings" } }, "text/html": { "schema": { "$ref": "#/components/schemas/OrganizationSettings" } } }, "description": "" } }, "summary": "Patch Settings Organization" } }, "/shift/": { "get": { "operationId": "shift_list", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "end__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "end__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "end__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "end__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "end__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "end__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "end__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "end__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "shift_type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "shift_type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "shift_type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "shift_type__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "shift_type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "start__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "start__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "start__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "start__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "start__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "start__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "start__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "start__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "web__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "web__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" } ], "tags": [ "Shifts" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserSchedulingList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedUserSchedulingList" } } }, "description": "" } }, "summary": "List Shift" }, "post": { "operationId": "shift_create", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Shifts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSchedulingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserSchedulingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserSchedulingRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserScheduling" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserScheduling" } } }, "description": "" } }, "summary": "Create Shift" } }, "/shift/{id}/": { "get": { "operationId": "shift_retrieve", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user scheduling.", "required": true } ], "tags": [ "Shifts" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserScheduling" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserScheduling" } } }, "description": "" } }, "summary": "Get Shift" }, "put": { "operationId": "shift_update", "description": "Update Shift\n\nEither user or employee_number is required.\n\nRequired permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user scheduling.", "required": true } ], "tags": [ "Shifts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSchedulingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserSchedulingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserSchedulingRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserScheduling" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserScheduling" } } }, "description": "" } }, "summary": "Update Shift" }, "patch": { "operationId": "shift_partial_update", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user scheduling.", "required": true } ], "tags": [ "Shifts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUserSchedulingRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUserSchedulingRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUserSchedulingRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserScheduling" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserScheduling" } } }, "description": "" } }, "summary": "Patch Shift" }, "delete": { "operationId": "shift_destroy", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user scheduling.", "required": true } ], "tags": [ "Shifts" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Shift" } }, "/shifttemplate/": { "get": { "operationId": "shifttemplate_list", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedShiftTemplateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedShiftTemplateList" } } }, "description": "" } }, "summary": "List Shifttemplate" }, "post": { "operationId": "shifttemplate_create", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShiftTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ShiftTemplateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplate" } } }, "description": "" } }, "summary": "Create Shifttemplate" } }, "/shifttemplate/{parent_lookup_shifts_template_block__shifts_template}/block/{parent_lookup_shifts_template_block}/fragment/": { "get": { "operationId": "shifttemplate_block_fragment_list", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_shifts_template_block", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block__shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedShiftTemplateBlockFragmentList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedShiftTemplateBlockFragmentList" } } }, "description": "" } }, "summary": "List Shifttemplate Block Fragment" }, "post": { "operationId": "shifttemplate_block_fragment_create", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_shifts_template_block", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block__shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragmentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragmentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragmentRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } } }, "description": "" } }, "summary": "Create Shifttemplate Block Fragment" } }, "/shifttemplate/{parent_lookup_shifts_template_block__shifts_template}/block/{parent_lookup_shifts_template_block}/fragment/{id}/": { "get": { "operationId": "shifttemplate_block_fragment_retrieve", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template block fragment.", "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block__shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } } }, "description": "" } }, "summary": "Get Shifttemplate Block Fragment" }, "put": { "operationId": "shifttemplate_block_fragment_update", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template block fragment.", "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block__shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragmentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragmentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragmentRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } } }, "description": "" } }, "summary": "Update Shifttemplate Block Fragment" }, "patch": { "operationId": "shifttemplate_block_fragment_partial_update", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template block fragment.", "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block__shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateBlockFragmentRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateBlockFragmentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateBlockFragmentRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } } }, "description": "" } }, "summary": "Patch Shifttemplate Block Fragment" }, "delete": { "operationId": "shifttemplate_block_fragment_destroy", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template block fragment.", "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block", "schema": { "type": "string" }, "required": true }, { "in": "path", "name": "parent_lookup_shifts_template_block__shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Shifttemplate Block Fragment" } }, "/shifttemplate/{parent_lookup_shifts_template}/block/": { "get": { "operationId": "shifttemplate_block_list", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedShiftTemplateBlockList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedShiftTemplateBlockList" } } }, "description": "" } }, "summary": "List Shifttemplate Block" }, "post": { "operationId": "shifttemplate_block_create", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlock" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlock" } } }, "description": "" } }, "summary": "Create Shifttemplate Block" } }, "/shifttemplate/{parent_lookup_shifts_template}/block/{id}/": { "get": { "operationId": "shifttemplate_block_retrieve", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template block.", "required": true }, { "in": "path", "name": "parent_lookup_shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlock" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlock" } } }, "description": "" } }, "summary": "Get Shifttemplate Block" }, "put": { "operationId": "shifttemplate_block_update", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template block.", "required": true }, { "in": "path", "name": "parent_lookup_shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlockRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlock" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlock" } } }, "description": "" } }, "summary": "Update Shifttemplate Block" }, "patch": { "operationId": "shifttemplate_block_partial_update", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template block.", "required": true }, { "in": "path", "name": "parent_lookup_shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateBlockRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateBlockRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateBlockRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlock" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplateBlock" } } }, "description": "" } }, "summary": "Patch Shifttemplate Block" }, "delete": { "operationId": "shifttemplate_block_destroy", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template block.", "required": true }, { "in": "path", "name": "parent_lookup_shifts_template", "schema": { "type": "string" }, "required": true } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Shifttemplate Block" } }, "/shifttemplate/{id}/": { "get": { "operationId": "shifttemplate_retrieve", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template.", "required": true } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplate" } } }, "description": "" } }, "summary": "Get Shifttemplate" }, "put": { "operationId": "shifttemplate_update", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template.", "required": true } ], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShiftTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ShiftTemplateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplate" } } }, "description": "" } }, "summary": "Update Shifttemplate" }, "patch": { "operationId": "shifttemplate_partial_update", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template.", "required": true } ], "tags": [ "shifttemplate" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedShiftTemplateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTemplate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTemplate" } } }, "description": "" } }, "summary": "Patch Shifttemplate" }, "delete": { "operationId": "shifttemplate_destroy", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shifts template.", "required": true } ], "tags": [ "shifttemplate" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Shifttemplate" } }, "/shifttype/": { "get": { "operationId": "shifttype_list", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "in_all_day__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "in_all_day__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "in_online_booking__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "in_online_booking__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "is_active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "is_custom__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_custom__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Shifts" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedShiftTypeList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedShiftTypeList" } } }, "description": "" } }, "summary": "List Shifttype" }, "post": { "operationId": "shifttype_create", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Shifts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdate" } } }, "description": "" } }, "summary": "Create Shifttype" } }, "/shifttype/{id}/": { "get": { "operationId": "shifttype_retrieve", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shift type.", "required": true } ], "tags": [ "Shifts" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftType" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftType" } } }, "description": "" } }, "summary": "Get Shifttype" }, "put": { "operationId": "shifttype_update", "description": "Update Shift Type\n\nThis will also update existing shifts. Parameter `update_existing_shifts` can be\nset to `false` to disable it.\n\nRequired permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shift type.", "required": true } ], "tags": [ "Shifts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftTypeCreateUpdate" } } }, "description": "" } }, "summary": "Update Shifttype" }, "patch": { "operationId": "shifttype_partial_update", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this shift type.", "required": true } ], "tags": [ "Shifts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedShiftTypeRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedShiftTypeRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedShiftTypeRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftType" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ShiftType" } } }, "description": "" } }, "summary": "Patch Shifttype" } }, "/sms/send/": { "post": { "operationId": "sms_send_create", "description": "Send SMS message\n\nRequired parameters (JSON object):\n- message (string)\n- department_id (int)\n- phone_number_id (int) OR phone_number (string)\n\nReturns 'sms_task_id' (in a JSON object), which can be used to\ncheck the status of the SMS sending task.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "SMS messages" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Sms Send" } }, "/sms/task_status/": { "get": { "operationId": "sms_task_status_retrieve", "description": "Check the status of an SMS sending task\n\nNote that once a task has finished, its status can only be\nchecked once after which the result of the task is forgotten.\n\nRequired parameter (query string):\n- sms_task_id (string)\n\nReturns a JSON object with 3 possible keys:\n- finished (boolean)\n- successful (boolean) (only if finished)\n- message (string) (only if finished and not successful)\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "SMS messages" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Sms Task Status" } }, "/stock/batch/": { "get": { "operationId": "stock_batch_list", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "batch_number__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "batch_number__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "batch_number__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "batch_number__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "batch_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "batch_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "batch_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "batch_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "expiry_date__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "expiry_date__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "expiry_date__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "expiry_date__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "expiry_date__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "expiry_date__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "expiry_date__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "expiry_date__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "item_entry__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_entry__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_entry__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_entry__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_entry__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "item_entry_batch__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "item_entry_batch__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "item_entry_batch__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_entry_batch__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_entry_batch__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "item_entry_batch__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "item_entry_batch__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "item_entry_batch__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "quantity__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "quantity__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "quantity__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "quantity__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "quantity__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "quantity__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "quantity__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "quantity__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "quantity__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "quantity__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "stock_item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "stock_item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "stock_item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "stock_item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "stock_item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedBatchList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedBatchList" } } }, "description": "" } }, "summary": "List Stock Batch" }, "post": { "operationId": "stock_batch_create", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BatchRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BatchRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "description": "" } }, "summary": "Create Stock Batch" } }, "/stock/batch/{id}/": { "get": { "operationId": "stock_batch_retrieve", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this batch.", "required": true } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/BatchDetail" } } }, "description": "" } }, "summary": "Get Stock Batch" }, "put": { "operationId": "stock_batch_update", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this batch.", "required": true } ], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BatchRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/BatchRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "description": "" } }, "summary": "Update Stock Batch" }, "patch": { "operationId": "stock_batch_partial_update", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this batch.", "required": true } ], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedBatchRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedBatchRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedBatchRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Batch" } } }, "description": "" } }, "summary": "Patch Stock Batch" }, "delete": { "operationId": "stock_batch_destroy", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this batch.", "required": true } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Stock Batch" } }, "/stock/entry/": { "get": { "operationId": "stock_entry_list", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "date_of_entry__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "date_of_entry__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "date_of_entry__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "date_of_entry__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "date_of_entry__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "date_of_entry__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "date_of_entry__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "date_of_entry__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "invoicerow__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "invoicerow__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "invoicerow__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "invoicerow__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "invoicerow__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "order_item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "order_item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "order_item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "order_item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "order_item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "stock_item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "stock_item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "stock_item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "stock_item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "stock_item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "stock_locations__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "stock_locations__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "stock_locations__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "stock_locations__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "stock_locations__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemEntryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedItemEntryList" } } }, "description": "" } }, "summary": "List Stock Entry" }, "post": { "operationId": "stock_entry_create", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemEntryRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ItemEntryRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/ItemEntryRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemEntry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemEntry" } } }, "description": "" } }, "summary": "Create Stock Entry" } }, "/stock/entry/{id}/": { "get": { "operationId": "stock_entry_retrieve", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this item entry.", "required": true } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemEntry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/ItemEntry" } } }, "description": "" } }, "summary": "Get Stock Entry" } }, "/stock/item/": { "get": { "operationId": "stock_item_list", "description": "Stock Item\n\nwholesale_price_unit and stock_value are calculated values, rounded to two decimals.\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedStockItemListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedStockItemListList" } } }, "description": "" } }, "summary": "List Stock Item" }, "post": { "operationId": "stock_item_create", "description": "Stock Item\n\nwholesale_price_unit and stock_value are calculated values, rounded to two decimals.\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItemCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StockItemCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/StockItemCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItemCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockItemCreate" } } }, "description": "" } }, "summary": "Create Stock Item" } }, "/stock/item/{id}/": { "get": { "operationId": "stock_item_retrieve", "description": "Stock Item\n\nwholesale_price_unit and stock_value are calculated values, rounded to two decimals.\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this stock item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockLevelDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockLevelDetail" } } }, "description": "" } }, "summary": "Get Stock Item" } }, "/stock/item/{id}/inventory/": { "get": { "operationId": "stock_item_inventory_retrieve", "description": "Stock inventory\n\nHTTP GET: Show current levels. If posting the response to POST endpoint,\nlevels are confirmed and no changes to levels are done.\n\nHTTP POST: Set new levels for inventory\n\nParameters:\n - location_id (integer)\n - date_of_entry (datetime) - can be empty\n - rows (array) - array of objects with keys:\n - batch_id (integer) - Required if item has batches in use\n - tracking_id (integer) - Required if item has tracking numbers in use\n - packages (float) - Amount of packages. Not used when tracking_id given.\n - units (float) - Amount of units\n - description (string)\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this stock item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockItem" } } }, "description": "" } }, "summary": "Get Stock Item Inventory" }, "post": { "operationId": "stock_item_inventory_create", "description": "Stock inventory\n\nHTTP GET: Show current levels. If posting the response to POST endpoint,\nlevels are confirmed and no changes to levels are done.\n\nHTTP POST: Set new levels for inventory\n\nParameters:\n - location_id (integer)\n - date_of_entry (datetime) - can be empty\n - rows (array) - array of objects with keys:\n - batch_id (integer) - Required if item has batches in use\n - tracking_id (integer) - Required if item has tracking numbers in use\n - packages (float) - Amount of packages. Not used when tracking_id given.\n - units (float) - Amount of units\n - description (string)\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this stock item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StockItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/StockItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockItem" } } }, "description": "" } }, "summary": "Create Stock Item Inventory" } }, "/stock/location/": { "get": { "operationId": "stock_location_list", "description": "Required permissions:\n- Settings: Stock\n

Or

\n- Profile: Login credentials to Provet mobile app\n- General: Treatment plans\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "is_default__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_default__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedStockLocationList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedStockLocationList" } } }, "description": "" } }, "summary": "List Stock Location" } }, "/stock/location/{id}/": { "get": { "operationId": "stock_location_retrieve", "description": "Required permissions:\n- Settings: Stock\n

Or

\n- Profile: Login credentials to Provet mobile app\n- General: Treatment plans\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this stock location.", "required": true } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockLocation" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockLocation" } } }, "description": "" } }, "summary": "Get Stock Location" } }, "/stock/locationalertlevel/": { "get": { "operationId": "stock_locationalertlevel_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedLocationAlertLevelList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedLocationAlertLevelList" } } }, "description": "" } }, "summary": "List Stock Locationalertlevel" }, "post": { "operationId": "stock_locationalertlevel_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAlertLevelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LocationAlertLevelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LocationAlertLevelRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAlertLevel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LocationAlertLevel" } } }, "description": "" } }, "summary": "Create Stock Locationalertlevel" } }, "/stock/locationalertlevel/{id}/": { "get": { "operationId": "stock_locationalertlevel_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this location alert level.", "required": true } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAlertLevel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LocationAlertLevel" } } }, "description": "" } }, "summary": "Get Stock Locationalertlevel" }, "put": { "operationId": "stock_locationalertlevel_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this location alert level.", "required": true } ], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAlertLevelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LocationAlertLevelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/LocationAlertLevelRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAlertLevel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LocationAlertLevel" } } }, "description": "" } }, "summary": "Update Stock Locationalertlevel" }, "patch": { "operationId": "stock_locationalertlevel_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this location alert level.", "required": true } ], "tags": [ "Stock" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedLocationAlertLevelRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedLocationAlertLevelRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedLocationAlertLevelRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAlertLevel" } }, "text/html": { "schema": { "$ref": "#/components/schemas/LocationAlertLevel" } } }, "description": "" } }, "summary": "Patch Stock Locationalertlevel" }, "delete": { "operationId": "stock_locationalertlevel_destroy", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this location alert level.", "required": true } ], "tags": [ "Stock" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Stock Locationalertlevel" } }, "/stocklevel/": { "get": { "operationId": "stocklevel_list", "description": "Stock Item\n\nwholesale_price_unit and stock_value are calculated values, rounded to two decimals.\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "item__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock levels" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedStockItemListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedStockItemListList" } } }, "description": "" } }, "summary": "List Stocklevel" }, "post": { "operationId": "stocklevel_create", "description": "Stock Item\n\nwholesale_price_unit and stock_value are calculated values, rounded to two decimals.\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock levels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItemCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StockItemCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/StockItemCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItemCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockItemCreate" } } }, "description": "" } }, "summary": "Create Stocklevel" } }, "/stocklevel/{id}/": { "get": { "operationId": "stocklevel_retrieve", "description": "Stock Item\n\nwholesale_price_unit and stock_value are calculated values, rounded to two decimals.\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this stock item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock levels" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockLevelDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockLevelDetail" } } }, "description": "" } }, "summary": "Get Stocklevel" } }, "/stocklevel/{id}/inventory/": { "get": { "operationId": "stocklevel_inventory_retrieve", "description": "Stock inventory\n\nHTTP GET: Show current levels. If posting the response to POST endpoint,\nlevels are confirmed and no changes to levels are done.\n\nHTTP POST: Set new levels for inventory\n\nParameters:\n - location_id (integer)\n - date_of_entry (datetime) - can be empty\n - rows (array) - array of objects with keys:\n - batch_id (integer) - Required if item has batches in use\n - tracking_id (integer) - Required if item has tracking numbers in use\n - packages (float) - Amount of packages. Not used when tracking_id given.\n - units (float) - Amount of units\n - description (string)\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this stock item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock levels" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockItem" } } }, "description": "" } }, "summary": "Get Stocklevel Inventory" }, "post": { "operationId": "stocklevel_inventory_create", "description": "Stock inventory\n\nHTTP GET: Show current levels. If posting the response to POST endpoint,\nlevels are confirmed and no changes to levels are done.\n\nHTTP POST: Set new levels for inventory\n\nParameters:\n - location_id (integer)\n - date_of_entry (datetime) - can be empty\n - rows (array) - array of objects with keys:\n - batch_id (integer) - Required if item has batches in use\n - tracking_id (integer) - Required if item has tracking numbers in use\n - packages (float) - Amount of packages. Not used when tracking_id given.\n - units (float) - Amount of units\n - description (string)\n\nRequired permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this stock item.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "target_location", "schema": { "type": "string" }, "description": "Get location specific stock levels" } ], "tags": [ "Stock levels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItemRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StockItemRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/StockItemRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StockItem" } }, "text/html": { "schema": { "$ref": "#/components/schemas/StockItem" } } }, "description": "" } }, "summary": "Create Stocklevel Inventory" } }, "/supply/": { "get": { "operationId": "supply_list", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "created_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "created_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "created_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_2__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_2__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_2__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_2__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code_3__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code_3__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code_3__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code_3__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_reporting_code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_reporting_code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_reporting_code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_reporting_code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_reporting_code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" }, { "in": "query", "name": "item_list__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "item_list__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "item_list__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "item_list__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "item_list__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified_user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "modified_user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified_user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified_user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "modified_user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Supplies" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedSupplyListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedSupplyListList" } } }, "description": "" } }, "summary": "List Supply" }, "post": { "operationId": "supply_create", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Supplies" ], "security": [ { "oauth2": [] } ], "responses": { "201": { "description": "No response body" } }, "summary": "Create Supply" } }, "/supply/{id}/": { "get": { "operationId": "supply_retrieve", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this supply.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Supplies" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Supply" }, "put": { "operationId": "supply_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this supply.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Supplies" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Update Supply" }, "patch": { "operationId": "supply_partial_update", "description": "Required permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this supply.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Supplies" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Patch Supply" }, "delete": { "operationId": "supply_destroy", "description": "Archives an item.\n\nRequired permissions:\n- Settings: Items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this supply.", "required": true }, { "in": "query", "name": "include_archived", "schema": { "type": "string" }, "description": "Set to 'true' to include archived items in results" } ], "tags": [ "Supplies" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Supply" } }, "/tag/": { "get": { "operationId": "tag_retrieve", "description": "Available to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Tags" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Tag" } }, "/tag/tagtext/": { "get": { "operationId": "tag_tagtext_list", "description": "Required permissions:\n- Settings: Tags\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department_id", "schema": { "type": "integer" } }, { "in": "query", "name": "department_id__in", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "in_client", "schema": { "type": "boolean" } }, { "in": "query", "name": "in_custom_field", "schema": { "type": "boolean" } }, { "in": "query", "name": "in_health_plan", "schema": { "type": "boolean" } }, { "in": "query", "name": "in_invoice", "schema": { "type": "boolean" } }, { "in": "query", "name": "in_item", "schema": { "type": "boolean" } }, { "in": "query", "name": "in_patient", "schema": { "type": "boolean" } }, { "in": "query", "name": "in_permission_group", "schema": { "type": "boolean" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "readonly", "schema": { "type": "boolean" } }, { "in": "query", "name": "text", "schema": { "type": "string" } }, { "in": "query", "name": "text__icontains", "schema": { "type": "string" } }, { "in": "query", "name": "text__in", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Multiple values may be separated by commas.", "explode": false, "style": "form" }, { "in": "query", "name": "text__istartswith", "schema": { "type": "string" } } ], "tags": [ "Tags" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTagTextList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTagTextList" } } }, "description": "" } }, "summary": "List Tag Tagtext" }, "post": { "operationId": "tag_tagtext_create", "description": "Required permissions:\n- Settings: Tags\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Tags" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagTextRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TagTextRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TagTextRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagText" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TagText" } } }, "description": "" } }, "summary": "Create Tag Tagtext" } }, "/tag/tagtext/{id}/": { "get": { "operationId": "tag_tagtext_retrieve", "description": "Required permissions:\n- Settings: Tags\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this tag text.", "required": true } ], "tags": [ "Tags" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagText" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TagText" } } }, "description": "" } }, "summary": "Get Tag Tagtext" }, "put": { "operationId": "tag_tagtext_update", "description": "Required permissions:\n- Settings: Tags\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this tag text.", "required": true } ], "tags": [ "Tags" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagTextRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TagTextRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TagTextRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagText" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TagText" } } }, "description": "" } }, "summary": "Update Tag Tagtext" }, "patch": { "operationId": "tag_tagtext_partial_update", "description": "Required permissions:\n- Settings: Tags\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this tag text.", "required": true } ], "tags": [ "Tags" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTagTextRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTagTextRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTagTextRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagText" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TagText" } } }, "description": "" } }, "summary": "Patch Tag Tagtext" }, "delete": { "operationId": "tag_tagtext_destroy", "description": "Required permissions:\n- Settings: Tags\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this tag text.", "required": true } ], "tags": [ "Tags" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Tag Tagtext" } }, "/tag_journal_entries/": { "post": { "operationId": "tag_journal_entries_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Tag journal entries" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalReportLogRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JournalReportLogRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JournalReportLogRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalReportLog" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalReportLog" } } }, "description": "" } }, "summary": "Create Tag Journal Entries" } }, "/tag_journal_entry_problems/": { "post": { "operationId": "tag_journal_entry_problems_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Tag journal entry problems" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalReportLogRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JournalReportLogRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/JournalReportLogRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalReportLog" } }, "text/html": { "schema": { "$ref": "#/components/schemas/JournalReportLog" } } }, "description": "" } }, "summary": "Create Tag Journal Entry Problems" } }, "/targetarea/": { "get": { "operationId": "targetarea_list", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "code__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "code__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "code__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "code__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "code__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "code__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "code__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "code__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "target_area__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "target_area__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "target_area__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "target_area__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "target_area__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "target_area__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "target_area__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "target_area__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Target areas" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTargetAreaList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTargetAreaList" } } }, "description": "" } }, "summary": "List Targetarea" } }, "/targetarea/{id}/": { "get": { "operationId": "targetarea_retrieve", "description": "Required permissions:\n- Settings: Integration settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this target area.", "required": true } ], "tags": [ "Target areas" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TargetArea" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TargetArea" } } }, "description": "" } }, "summary": "Get Targetarea" } }, "/task/": { "get": { "operationId": "task_list", "description": "Required permissions:\n- General: Tasks\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department_id", "schema": { "type": "integer" }, "description": "Optional. Narrow tasks to those assigned to users active in this department (all_departments_active OR assigned active_departments OR department-group member). Requesters restricted to specific departments are always scoped to their own departments; this param narrows within that set. Legacy alias: department." }, { "in": "query", "name": "due__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "due__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "due__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "due__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "due__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "due__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "due__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "due__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "favourite__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "favourite__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "status__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "status__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "status__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "status__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "status__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "status__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "status__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "status__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "status__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "status__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "task_type__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "task_type__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "task_type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "task_type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "task_type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "task_type__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "task_type__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "task_type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "task_type__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "task_type__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "user__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "user__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "user__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "user__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "user__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Tasks" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTaskList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTaskList" } } }, "description": "" } }, "summary": "List Task" }, "post": { "operationId": "task_create", "description": "Required permissions:\n- General: Tasks\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TaskRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TaskRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Task" } } }, "description": "" } }, "summary": "Create Task" } }, "/task/{id}/": { "get": { "operationId": "task_retrieve", "description": "Required permissions:\n- General: Tasks\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this task.", "required": true } ], "tags": [ "Tasks" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Task" } } }, "description": "" } }, "summary": "Get Task" }, "put": { "operationId": "task_update", "description": "Required permissions:\n- General: Tasks\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this task.", "required": true } ], "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TaskRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TaskRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Task" } } }, "description": "" } }, "summary": "Update Task" }, "patch": { "operationId": "task_partial_update", "description": "Required permissions:\n- General: Tasks\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this task.", "required": true } ], "tags": [ "Tasks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTaskRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTaskRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTaskRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Task" } } }, "description": "" } }, "summary": "Patch Task" }, "delete": { "operationId": "task_destroy", "description": "Required permissions:\n- General: Tasks\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this task.", "required": true } ], "tags": [ "Tasks" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Task" } }, "/text_template/": { "get": { "operationId": "text_template_list", "description": "List Text Templates\n\nTypes are:\n- Clinical note template = 0\n- Discharge note template = 1\n- Medicine instruction template = 2\n- Communications template = 3\n- Preliminary note template = 4\n- Referral remark template = 5\n- Laboratory result report template = 6\n\nRequired permissions:\n- Settings: Settings page\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "title__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "title__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "title__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "title__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "title__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "title__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "title__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "title__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "type__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "type__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Text templates" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTextTemplateList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTextTemplateList" } } }, "description": "" } }, "summary": "List Text Template" }, "post": { "operationId": "text_template_create", "description": "Required permissions:\n- Settings: Settings page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Text templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextTemplateDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TextTemplateDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TextTemplateDetailRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextTemplateDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TextTemplateDetail" } } }, "description": "" } }, "summary": "Create Text Template" } }, "/text_template/{id}/": { "get": { "operationId": "text_template_retrieve", "description": "Required permissions:\n- Settings: Settings page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this template.", "required": true } ], "tags": [ "Text templates" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextTemplateDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TextTemplateDetail" } } }, "description": "" } }, "summary": "Get Text Template" }, "put": { "operationId": "text_template_update", "description": "Required permissions:\n- Settings: Settings page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this template.", "required": true } ], "tags": [ "Text templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextTemplateDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TextTemplateDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TextTemplateDetailRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextTemplateDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TextTemplateDetail" } } }, "description": "" } }, "summary": "Update Text Template" }, "patch": { "operationId": "text_template_partial_update", "description": "Required permissions:\n- Settings: Settings page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this template.", "required": true } ], "tags": [ "Text templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTextTemplateDetailRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTextTemplateDetailRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTextTemplateDetailRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextTemplateDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TextTemplateDetail" } } }, "description": "" } }, "summary": "Patch Text Template" } }, "/transaction_terminal/": { "get": { "operationId": "transaction_terminal_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "transaction_terminal" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTransactionTerminalList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTransactionTerminalList" } } }, "description": "" } }, "summary": "List Transaction Terminal" } }, "/transaction_terminal/{id}/": { "get": { "operationId": "transaction_terminal_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this transaction terminal.", "required": true } ], "tags": [ "transaction_terminal" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionTerminal" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TransactionTerminal" } } }, "description": "" } }, "summary": "Get Transaction Terminal" } }, "/treatment_plan/department/": { "get": { "operationId": "treatment_plan_department_list", "description": "Departments\n\nThis view does not require permissions because we don't generally restrict reading\ndepartment and department group information.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedDepartmentList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedDepartmentList" } } }, "description": "" } }, "summary": "List Treatment Plan Department" } }, "/treatment_plan/department/{id}/": { "get": { "operationId": "treatment_plan_department_retrieve", "description": "Departments\n\nThis view does not require permissions because we don't generally restrict reading\ndepartment and department group information.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 1200 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this department.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Department" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Department" } } }, "description": "" } }, "summary": "Get Treatment Plan Department" } }, "/treatmentplan/": { "get": { "operationId": "treatmentplan_list", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanListList" } } }, "description": "" } }, "summary": "List Treatmentplan" }, "post": { "operationId": "treatmentplan_create", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlan" } } }, "description": "" } }, "summary": "Create Treatmentplan" } }, "/treatmentplan/{id}/": { "get": { "operationId": "treatmentplan_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlan" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlan" } } }, "description": "" } }, "summary": "Get Treatmentplan" } }, "/treatmentplanfood/": { "get": { "operationId": "treatmentplanfood_list", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanFoodList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanFoodList" } } }, "description": "" } }, "summary": "List Treatmentplanfood" } }, "/treatmentplanfood/{id}/": { "get": { "operationId": "treatmentplanfood_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan food.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFood" } } }, "description": "" } }, "summary": "Get Treatmentplanfood" }, "put": { "operationId": "treatmentplanfood_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan food.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFoodRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFoodRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFoodRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFood" } } }, "description": "" } }, "summary": "Update Treatmentplanfood" }, "patch": { "operationId": "treatmentplanfood_partial_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan food.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanFoodUpdatePartialRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanFoodUpdatePartialRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanFoodUpdatePartialRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFoodUpdatePartial" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFoodUpdatePartial" } } }, "description": "" } }, "summary": "Patch Treatmentplanfood" }, "delete": { "operationId": "treatmentplanfood_destroy", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan food.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Treatmentplanfood" } }, "/treatmentplanfood/{id}/mark_done/": { "post": { "operationId": "treatmentplanfood_mark_done_create", "description": "Mark Food as done. Creates ConsultationItem automatically.\n\nRequired permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan food.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFoodRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFoodRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFoodRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFood" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanFood" } } }, "description": "" } }, "summary": "Create Treatmentplanfood Mark Done" } }, "/treatmentplanmedicine/": { "get": { "operationId": "treatmentplanmedicine_list", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanMedicineList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanMedicineList" } } }, "description": "" } }, "summary": "List Treatmentplanmedicine" }, "post": { "operationId": "treatmentplanmedicine_create", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } } }, "description": "" } }, "summary": "Create Treatmentplanmedicine" } }, "/treatmentplanmedicine/{id}/": { "get": { "operationId": "treatmentplanmedicine_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan medicine.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } } }, "description": "" } }, "summary": "Get Treatmentplanmedicine" }, "put": { "operationId": "treatmentplanmedicine_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan medicine.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } } }, "description": "" } }, "summary": "Update Treatmentplanmedicine" }, "patch": { "operationId": "treatmentplanmedicine_partial_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan medicine.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanMedicineUpdatePartialRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanMedicineUpdatePartialRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanMedicineUpdatePartialRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineUpdatePartial" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineUpdatePartial" } } }, "description": "" } }, "summary": "Patch Treatmentplanmedicine" }, "delete": { "operationId": "treatmentplanmedicine_destroy", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan medicine.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Treatmentplanmedicine" } }, "/treatmentplanmedicine/{id}/mark_done/": { "post": { "operationId": "treatmentplanmedicine_mark_done_create", "description": "Mark Medicine as done. Creates ConsultationItem automatically.\n\nRequired permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan medicine.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicineRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } } }, "description": "" } }, "summary": "Create Treatmentplanmedicine Mark Done" } }, "/treatmentplanprocedure/": { "get": { "operationId": "treatmentplanprocedure_list", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanProcedureList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanProcedureList" } } }, "description": "" } }, "summary": "List Treatmentplanprocedure" } }, "/treatmentplanprocedure/{id}/": { "get": { "operationId": "treatmentplanprocedure_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan procedure.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedure" } } }, "description": "" } }, "summary": "Get Treatmentplanprocedure" }, "put": { "operationId": "treatmentplanprocedure_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan procedure.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedure" } } }, "description": "" } }, "summary": "Update Treatmentplanprocedure" }, "patch": { "operationId": "treatmentplanprocedure_partial_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan procedure.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanProcedureUpdatePartialRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanProcedureUpdatePartialRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanProcedureUpdatePartialRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedureUpdatePartial" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedureUpdatePartial" } } }, "description": "" } }, "summary": "Patch Treatmentplanprocedure" }, "delete": { "operationId": "treatmentplanprocedure_destroy", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan procedure.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Treatmentplanprocedure" } }, "/treatmentplanprocedure/{id}/mark_done/": { "post": { "operationId": "treatmentplanprocedure_mark_done_create", "description": "Mark Procedure as done. Creates ConsultationItem automatically.\n\nRequired permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan procedure.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedureRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedureRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedureRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedure" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanProcedure" } } }, "description": "" } }, "summary": "Create Treatmentplanprocedure Mark Done" } }, "/treatmentplansupply/": { "get": { "operationId": "treatmentplansupply_list", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanSupplyList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTreatmentPlanSupplyList" } } }, "description": "" } }, "summary": "List Treatmentplansupply" } }, "/treatmentplansupply/{id}/": { "get": { "operationId": "treatmentplansupply_retrieve", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan supply.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupply" } } }, "description": "" } }, "summary": "Get Treatmentplansupply" }, "put": { "operationId": "treatmentplansupply_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan supply.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupplyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupplyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupplyRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupply" } } }, "description": "" } }, "summary": "Update Treatmentplansupply" }, "patch": { "operationId": "treatmentplansupply_partial_update", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan supply.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanSupplyUpdatePartialRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanSupplyUpdatePartialRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedTreatmentPlanSupplyUpdatePartialRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupplyUpdatePartial" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupplyUpdatePartial" } } }, "description": "" } }, "summary": "Patch Treatmentplansupply" }, "delete": { "operationId": "treatmentplansupply_destroy", "description": "Required permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan supply.", "required": true } ], "tags": [ "Treatment plans" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Treatmentplansupply" } }, "/treatmentplansupply/{id}/mark_done/": { "post": { "operationId": "treatmentplansupply_mark_done_create", "description": "Mark Supply as done. Creates ConsultationItem automatically.\n\nRequired permissions:\n- General: Patients and clients\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this treatment plan supply.", "required": true } ], "tags": [ "Treatment plans" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupplyRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupplyRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupplyRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupply" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TreatmentPlanSupply" } } }, "description": "" } }, "summary": "Create Treatmentplansupply Mark Done" } }, "/triage/": { "get": { "operationId": "triage_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Triages" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTriageList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTriageList" } } }, "description": "" } }, "summary": "List Triage" } }, "/triage/{id}/": { "get": { "operationId": "triage_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this triage.", "required": true } ], "tags": [ "Triages" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Triage" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Triage" } } }, "description": "" } }, "summary": "Get Triage" } }, "/triage_category/": { "get": { "operationId": "triage_category_list", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Triages" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTriageCategoryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTriageCategoryList" } } }, "description": "" } }, "summary": "List Triage Category" } }, "/triage_category/{id}/": { "get": { "operationId": "triage_category_retrieve", "description": "Required permissions:\n- Settings: Department settings\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this triage category.", "required": true } ], "tags": [ "Triages" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriageCategory" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TriageCategory" } } }, "description": "" } }, "summary": "Get Triage Category" } }, "/triage_entry/": { "get": { "operationId": "triage_entry_list", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Triages" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedTriageEntryList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedTriageEntryList" } } }, "description": "" } }, "summary": "List Triage Entry" } }, "/triage_entry/{id}/": { "get": { "operationId": "triage_entry_retrieve", "description": "Required permissions:\n- General: Consultations and its items\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this triage entry.", "required": true } ], "tags": [ "Triages" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriageEntry" } }, "text/html": { "schema": { "$ref": "#/components/schemas/TriageEntry" } } }, "description": "" } }, "summary": "Get Triage Entry" } }, "/unallocatedpayment/": { "get": { "operationId": "unallocatedpayment_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 200 requests per minute.", "parameters": [ { "in": "query", "name": "appointment__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "appointment__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "appointment__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "appointment__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "appointment__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "client__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "client__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "client__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "client__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "client__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "date_added__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "date_added__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "date_added__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "date_added__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "date_added__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "date_added__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "date_added__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "date_added__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "external_info__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "external_info__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "external_info__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "external_info__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "external_info__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "external_info__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "external_info__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "external_info__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "external_info__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "external_info__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "external_info__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "external_info__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "external_info__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "external_info__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "external_info__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Unallocated payments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUnallocatedPaymentListList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedUnallocatedPaymentListList" } } }, "description": "" } }, "summary": "List Unallocatedpayment" }, "post": { "operationId": "unallocatedpayment_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Unallocated payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreate" } } }, "description": "" } }, "summary": "Create Unallocatedpayment" } }, "/unallocatedpayment/{parent_lookup_prepayment}/external_info/": { "get": { "operationId": "unallocatedpayment_external_info_list", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_prepayment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Unallocated payments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUnallocatedPaymentExternalInfoList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedUnallocatedPaymentExternalInfoList" } } }, "description": "" } }, "summary": "List Unallocatedpayment External Info" }, "post": { "operationId": "unallocatedpayment_external_info_create", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_prepayment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Unallocated payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfoRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfoRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfoRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } } }, "description": "" } }, "summary": "Create Unallocatedpayment External Info" } }, "/unallocatedpayment/{parent_lookup_prepayment}/external_info/{id}/": { "get": { "operationId": "unallocatedpayment_external_info_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this unallocated payment external info.", "required": true }, { "in": "path", "name": "parent_lookup_prepayment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Unallocated payments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } } }, "description": "" } }, "summary": "Get Unallocatedpayment External Info" }, "put": { "operationId": "unallocatedpayment_external_info_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this unallocated payment external info.", "required": true }, { "in": "path", "name": "parent_lookup_prepayment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Unallocated payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfoRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfoRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfoRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } } }, "description": "" } }, "summary": "Update Unallocatedpayment External Info" }, "patch": { "operationId": "unallocatedpayment_external_info_partial_update", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this unallocated payment external info.", "required": true }, { "in": "path", "name": "parent_lookup_prepayment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Unallocated payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUnallocatedPaymentExternalInfoRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUnallocatedPaymentExternalInfoRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUnallocatedPaymentExternalInfoRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } } }, "description": "" } }, "summary": "Patch Unallocatedpayment External Info" }, "delete": { "operationId": "unallocatedpayment_external_info_destroy", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this unallocated payment external info.", "required": true }, { "in": "path", "name": "parent_lookup_prepayment", "schema": { "type": "string" }, "required": true } ], "tags": [ "Unallocated payments" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Unallocatedpayment External Info" } }, "/unallocatedpayment/{id}/": { "get": { "operationId": "unallocatedpayment_retrieve", "description": "Required permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 800 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this unallocated payment.", "required": true } ], "tags": [ "Unallocated payments" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentDetail" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentDetail" } } }, "description": "" } }, "summary": "Get Unallocatedpayment" } }, "/unallocatedpayment/{id}/cancel/": { "post": { "operationId": "unallocatedpayment_cancel_create", "description": "Cancel a fully-unused prepayment.\n\nBooks a reversing prepayment (\"Cancelled\") mirroring the original and\nreturns it. Gated behind the CANCEL_PREPAYMENT flag.\n\nRequired permissions:\n- Financial: Invoices\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this unallocated payment.", "required": true } ], "tags": [ "Unallocated payments" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UnallocatedPaymentCreate" } } }, "description": "" } }, "summary": "Create Unallocatedpayment Cancel" } }, "/upload/": { "get": { "operationId": "upload_list", "description": "Uploads\n\nPermissions are handled inside the view.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Uploads" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUploadList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedUploadList" } } }, "description": "" } }, "summary": "List Upload" } }, "/upload/{id}/": { "get": { "operationId": "upload_retrieve", "description": "Uploads\n\nPermissions are handled inside the view.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this upload.", "required": true } ], "tags": [ "Uploads" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Upload" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Upload" } } }, "description": "" } }, "summary": "Get Upload" } }, "/upload_urls/": { "post": { "operationId": "upload_urls_create", "description": "Generate pre-signed S3 upload URLs for document attachments.\n\nPermissions are handled inside the view.\n\ndocument_type is only known after the request body is parsed, so the\nreal per-type permission check happens in post() via PRESIGN_TARGETS,\nnot permission_classes.\n\nClient does (2 steps):\n1. POST {\"document_type\": \"note\", \"object_id\": 123,\n \"filenames\": [\"file1.jpg\", \"file2.pdf\"]} — names only,\n no file bytes. Response: one entry per filename with `url` +\n `fields`.\n2. For each file, POST `fields` + the file as multipart/form-data\n to `url` — straight to S3. `fields` carries the S3 key and a\n signed, time-limited policy, so the client needs no AWS\n credentials.\n\nProvet does (automatic, no client action):\nS3 fires an ObjectCreated event -> SQS -> the type's upload handler\nparses the object key and creates the Upload rows for the document.\nThis is async, typically within seconds — the document has no\nattachment until it runs. Hence 202: nothing is created when this\nendpoint responds, and clients that must know the attachment exists\nshould read it back from the document's API.\n\nLimits:\n- Rate limit: 400 requests/min (up to 5 filenames each, i.e. at most\n 2000 presigned uploads per minute) by default.\n- File size: each document type caps uploads at its own limit in\n attachment/codes.py (notes and health plans: 1 GB) and empty files\n are rejected.\n- Locking: the document's editability (e.g. a note's lock) is\n checked when the URLs are issued, not when files land in S3 —\n an already-issued URL stays usable until it expires.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 400 requests per minute.", "parameters": [], "tags": [ "upload_urls" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadUrlsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UploadUrlsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadUrlsRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "202": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } }, "text/html": { "schema": { "type": "object", "additionalProperties": {} } } }, "description": "" } }, "summary": "Create Upload Urls" } }, "/user/": { "get": { "operationId": "user_list", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "created__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "created__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "created__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "created__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "created__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "created__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "created__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "created__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "in": "query", "name": "department_id", "schema": { "type": "integer" }, "description": "Optional. Narrow results to users active in this department (all_departments_active OR assigned active_departments OR department-group member). Legacy alias: department." }, { "in": "query", "name": "email__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "email__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "email__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "email__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "email__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "email__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "email__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "email__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "first_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "first_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "first_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "first_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "first_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "first_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "first_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "first_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "groups__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "groups__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "groups__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "groups__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "groups__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "is_active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "is_active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "last_name__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "last_name__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "last_name__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "last_name__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "last_name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "last_name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "last_name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "last_name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "modified__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "modified__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "modified__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "modified__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "modified__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "modified__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "modified__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "modified__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "ordering", "required": false, "in": "query", "description": "Which field to use when ordering the results.", "schema": { "type": "string" } }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "search", "schema": { "type": "string" }, "description": "Search users. Contains '@': searches email only. Multiple words: searches first_name and last_name. Single word: searches first_name, last_name, and email." }, { "in": "query", "name": "user_details__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "user_details__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "user_details__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "user_details__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "user_details__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedUserList" } } }, "description": "" } }, "summary": "List User" }, "post": { "operationId": "user_create", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserUpdate" } } }, "description": "" } }, "summary": "Create User" } }, "/user/{parent_lookup_user}/department_permissions/": { "get": { "operationId": "user_department_permissions_list", "description": "Required permissions:\n- Profile: Create / edit users through API\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "path", "name": "parent_lookup_user", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserDepartmentPermissionList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedUserDepartmentPermissionList" } } }, "description": "" } }, "summary": "List User Department Permissions" }, "post": { "operationId": "user_department_permissions_create", "description": "Required permissions:\n- Profile: Create / edit users through API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "parent_lookup_user", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermissionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermissionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermissionRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermission" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermission" } } }, "description": "" } }, "summary": "Create User Department Permissions" } }, "/user/{parent_lookup_user}/department_permissions/{id}/": { "get": { "operationId": "user_department_permissions_retrieve", "description": "Required permissions:\n- Profile: Create / edit users through API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user department permission.", "required": true }, { "in": "path", "name": "parent_lookup_user", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermission" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermission" } } }, "description": "" } }, "summary": "Get User Department Permissions" }, "put": { "operationId": "user_department_permissions_update", "description": "Required permissions:\n- Profile: Create / edit users through API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user department permission.", "required": true }, { "in": "path", "name": "parent_lookup_user", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermissionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermissionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermissionRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermission" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermission" } } }, "description": "" } }, "summary": "Update User Department Permissions" }, "patch": { "operationId": "user_department_permissions_partial_update", "description": "Required permissions:\n- Profile: Create / edit users through API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user department permission.", "required": true }, { "in": "path", "name": "parent_lookup_user", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUserDepartmentPermissionRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUserDepartmentPermissionRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUserDepartmentPermissionRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermission" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserDepartmentPermission" } } }, "description": "" } }, "summary": "Patch User Department Permissions" }, "delete": { "operationId": "user_department_permissions_destroy", "description": "Required permissions:\n- Profile: Create / edit users through API\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user department permission.", "required": true }, { "in": "path", "name": "parent_lookup_user", "schema": { "type": "string" }, "required": true } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete User Department Permissions" } }, "/user/{id}/": { "get": { "operationId": "user_retrieve", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user.", "required": true } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/html": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } }, "summary": "Get User" }, "put": { "operationId": "user_update", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user.", "required": true } ], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserUpdateRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserUpdate" } } }, "description": "" } }, "summary": "Update User" }, "patch": { "operationId": "user_partial_update", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user.", "required": true } ], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUserUpdateRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUserUpdateRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUserUpdateRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserUpdate" } } }, "description": "" } }, "summary": "Patch User" } }, "/user/current/active_permissions/": { "get": { "operationId": "user_current_active_permissions_retrieve", "description": "Retrieve the active permissions for the currently authenticated user or token.\nWhen using a token, the token's permissions are used as the source of truth.\n\nQuery parameters:\n department_id: Department ID for block visibility checks.\n Falls back to the user's active department.\n\nRequired permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "department_id", "schema": { "type": "integer" }, "description": "Department ID for block visibility checks. Falls back to the user's active department." } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/html": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "" } }, "summary": "Get User Current Active Permissions" } }, "/userdetails/": { "get": { "operationId": "userdetails_list", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "active_departments__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "active_departments__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "active_departments__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "active_departments__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "active_departments__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "all_departments_active__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "all_departments_active__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "employee_number__contains", "schema": { "type": "string" }, "description": "Contains (case-sensitive)" }, { "in": "query", "name": "employee_number__contains_not", "schema": { "type": "string" }, "description": "Does not contain (case-sensitive)" }, { "in": "query", "name": "employee_number__icontains", "schema": { "type": "string" }, "description": "Contains (case-insensitive)" }, { "in": "query", "name": "employee_number__icontains_not", "schema": { "type": "string" }, "description": "Does not contain (case-insensitive)" }, { "in": "query", "name": "employee_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "employee_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "employee_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "employee_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "home_department__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "home_department__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "home_department__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "home_department__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "home_department__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "user_type__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "user_type__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedUserDetailsList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedUserDetailsList" } } }, "description": "" } }, "summary": "List Userdetails" }, "post": { "operationId": "userdetails_create", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserDetailsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserDetailsRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserDetails" } } }, "description": "" } }, "summary": "Create Userdetails" } }, "/userdetails/{id}/": { "get": { "operationId": "userdetails_retrieve", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user details.", "required": true } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserDetails" } } }, "description": "" } }, "summary": "Get Userdetails" }, "put": { "operationId": "userdetails_update", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user details.", "required": true } ], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetailsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UserDetailsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UserDetailsRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserDetails" } } }, "description": "" } }, "summary": "Update Userdetails" }, "patch": { "operationId": "userdetails_partial_update", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user details.", "required": true } ], "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedUserDetailsRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedUserDetailsRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedUserDetailsRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDetails" } }, "text/html": { "schema": { "$ref": "#/components/schemas/UserDetails" } } }, "description": "" } }, "summary": "Patch Userdetails" }, "delete": { "operationId": "userdetails_destroy", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this user details.", "required": true } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Userdetails" } }, "/usergroup/": { "get": { "operationId": "usergroup_list", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "name__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "name__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "name__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "name__is_null", "schema": { "type": "boolean" }, "description": "Is null" }, { "in": "query", "name": "name__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedGroupList" } } }, "description": "" } }, "summary": "List Usergroup" } }, "/usergroup/{id}/": { "get": { "operationId": "usergroup_retrieve", "description": "Required permissions:\n- Profile: User profile page\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this group.", "required": true } ], "tags": [ "Users" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Group" } } }, "description": "" } }, "summary": "Get Usergroup" } }, "/vatgroup/": { "get": { "operationId": "vatgroup_list", "description": "VAT Groups\n\nThis view does not require permissions because it only allows read-only access to\ntrivial VAT percentage data.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } } ], "tags": [ "VAT groups" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedVatGroupList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedVatGroupList" } } }, "description": "" } }, "summary": "List Vatgroup" } }, "/vatgroup/{id}/": { "get": { "operationId": "vatgroup_retrieve", "description": "VAT Groups\n\nThis view does not require permissions because it only allows read-only access to\ntrivial VAT percentage data.\n\nAvailable to any client authenticated with the `restapi` OAuth2 scope.\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this vat group.", "required": true } ], "tags": [ "VAT groups" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VatGroup" } }, "text/html": { "schema": { "$ref": "#/components/schemas/VatGroup" } } }, "description": "" } }, "summary": "Get Vatgroup" } }, "/veterinarians_availibility/": { "get": { "operationId": "veterinarians_availibility_list", "description": "Required permissions:\n- Calendar: Shifts\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "available_to", "schema": { "type": "string" } }, { "in": "query", "name": "department_id", "schema": { "type": "integer" }, "required": true }, { "in": "query", "name": "duration", "schema": { "type": "integer" }, "required": true }, { "in": "query", "name": "end", "schema": { "type": "string" }, "required": true }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "reason", "schema": { "type": "boolean" } }, { "in": "query", "name": "show_extra", "schema": { "type": "boolean" } }, { "in": "query", "name": "start", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "treating_employees", "schema": { "type": "string" }, "description": "Integer or list of integers" }, { "in": "query", "name": "user_types", "schema": { "type": "string" }, "description": "Integer or list of integers" } ], "tags": [ "Veterinarians availability" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedVetsAvailabilityList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedVetsAvailabilityList" } } }, "description": "" } }, "summary": "List Veterinarians Availibility" } }, "/weightcheck/": { "get": { "operationId": "weightcheck_retrieve", "description": "This endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Weight check" ], "responses": { "200": { "description": "No response body" } }, "summary": "Get Weightcheck" }, "post": { "operationId": "weightcheck_create", "description": "This endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Weight check" ], "responses": { "200": { "description": "No response body" } }, "summary": "Create Weightcheck" } }, "/wholesaler/": { "get": { "operationId": "wholesaler_list", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "query", "name": "archived__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "archived__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "id__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "id__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "id__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "id__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "id__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "id__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "id__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "id__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "id__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" }, { "name": "page", "required": false, "in": "query", "description": "A page number within the paginated result set.", "schema": { "type": "integer" } }, { "name": "page_size", "required": false, "in": "query", "description": "Number of results to return per page.", "schema": { "type": "integer" } }, { "in": "query", "name": "vat_number__gt", "schema": { "type": "string" }, "description": "Greater than" }, { "in": "query", "name": "vat_number__gte", "schema": { "type": "string" }, "description": "Greater than or equal" }, { "in": "query", "name": "vat_number__in", "schema": { "type": "string" }, "description": "Comma-separated list of values" }, { "in": "query", "name": "vat_number__is", "schema": { "type": "string" }, "description": "Exact match" }, { "in": "query", "name": "vat_number__is_not", "schema": { "type": "string" }, "description": "Exclude exact match" }, { "in": "query", "name": "vat_number__lt", "schema": { "type": "string" }, "description": "Less than" }, { "in": "query", "name": "vat_number__lte", "schema": { "type": "string" }, "description": "Less than or equal" }, { "in": "query", "name": "vat_number__not_in", "schema": { "type": "string" }, "description": "Exclude comma-separated list of values" }, { "in": "query", "name": "vat_number__not_in_range", "schema": { "type": "string" }, "description": "Exclude range (comma-separated min,max)" }, { "in": "query", "name": "vat_number__range", "schema": { "type": "string" }, "description": "Range (comma-separated min,max)" } ], "tags": [ "Wholesalers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedWholesalerResponseList" } }, "text/html": { "schema": { "$ref": "#/components/schemas/PaginatedWholesalerResponseList" } } }, "description": "" } }, "summary": "List Wholesaler" }, "post": { "operationId": "wholesaler_create", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [], "tags": [ "Wholesalers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WholesalerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WholesalerRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WholesalerResponse" } } }, "description": "" } }, "summary": "Create Wholesaler" } }, "/wholesaler/{id}/": { "get": { "operationId": "wholesaler_retrieve", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this wholesaler.", "required": true } ], "tags": [ "Wholesalers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WholesalerResponse" } } }, "description": "" } }, "summary": "Get Wholesaler" }, "put": { "operationId": "wholesaler_update", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this wholesaler.", "required": true } ], "tags": [ "Wholesalers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WholesalerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WholesalerRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WholesalerResponse" } } }, "description": "" } }, "summary": "Update Wholesaler" }, "patch": { "operationId": "wholesaler_partial_update", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this wholesaler.", "required": true } ], "tags": [ "Wholesalers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchedWholesalerRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PatchedWholesalerRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/PatchedWholesalerRequest" } } } }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WholesalerResponse" } } }, "description": "" } }, "summary": "Patch Wholesaler" }, "delete": { "operationId": "wholesaler_destroy", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 300 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "description": "A unique integer value identifying this wholesaler.", "required": true } ], "tags": [ "Wholesalers" ], "security": [ { "oauth2": [] } ], "responses": { "204": { "description": "No response body" } }, "summary": "Delete Wholesaler" } }, "/wholesaler/{id}/catalog_upload_url/": { "post": { "operationId": "wholesaler_catalog_upload_url_create", "description": "Create a presigned upload URL for a wholesaler catalog.\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerCatalogUploadRequestRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WholesalerCatalogUploadRequestRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WholesalerCatalogUploadRequestRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerCatalogUploadResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WholesalerCatalogUploadResponse" } } }, "description": "" } }, "summary": "Create Wholesaler Catalog Upload Url" } }, "/wholesaler/{id}/receipts/": { "post": { "operationId": "wholesaler_receipts_create", "description": "Report what a wholesaler has sent, line by line.\n\nRequired OAuth2 scopes: `wholesaler`\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "integer" }, "required": true } ], "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerReceiptsRequestRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WholesalerReceiptsRequestRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/WholesalerReceiptsRequestRequest" } } }, "required": true }, "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerReceiptsResponse" } }, "text/html": { "schema": { "$ref": "#/components/schemas/WholesalerReceiptsResponse" } } }, "description": "" } }, "summary": "Create Wholesaler Receipts" } }, "/wholesaler/available_for_connect/": { "get": { "operationId": "wholesaler_available_for_connect_retrieve", "description": "Required permissions:\n- Settings: Stock\n\n\nThis endpoint is rate-limited to 100 requests per minute.", "parameters": [], "tags": [ "Wholesalers" ], "security": [ { "oauth2": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Wholesaler" } }, "text/html": { "schema": { "$ref": "#/components/schemas/Wholesaler" } } }, "description": "" } }, "summary": "Get Wholesaler Available For Connect" } } }, "components": { "schemas": { "AccountNumber": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "number": { "type": "string", "maxLength": 30 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "department": { "type": "string", "format": "uri", "nullable": true }, "archived": { "type": "boolean" } }, "required": [ "id", "number", "url" ] }, "AccountNumberRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "number": { "type": "string", "minLength": 1, "maxLength": 30 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "department": { "type": "string", "format": "uri", "nullable": true }, "archived": { "type": "boolean" } }, "required": [ "number" ] }, "AccountTypeEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Result\n* `2` - Balance" }, "AccountingReport": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "note": { "type": "string", "nullable": true, "maxLength": 1000 }, "total_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true } }, "required": [ "department", "id", "total_sum", "url" ] }, "AccountingReportDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "note": { "type": "string", "nullable": true, "maxLength": 1000 }, "accounting_user": { "type": "string", "format": "uri" }, "cash_sum": { "type": "string", "readOnly": true }, "card_sum": { "type": "string", "readOnly": true }, "bank_sum": { "type": "string", "readOnly": true }, "mobile_sum": { "type": "string", "readOnly": true }, "cheque_sum": { "type": "string", "readOnly": true }, "voucher_sum": { "type": "string", "readOnly": true }, "present_card_sum": { "type": "string", "readOnly": true }, "financing_company_sum": { "type": "string", "readOnly": true }, "other_sum": { "type": "string", "readOnly": true }, "total_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "corrections_cash_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "end_of_day_reports": { "type": "array", "items": { "type": "string", "format": "uri" } }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri" }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri" } }, "required": [ "accounting_user", "bank_sum", "card_sum", "cash_sum", "cheque_sum", "corrections_cash_sum", "created", "department", "financing_company_sum", "id", "mobile_sum", "modified", "other_sum", "present_card_sum", "total_sum", "url", "voucher_sum" ] }, "ActionEnum": { "enum": [ 0, 1, 3, 2 ], "type": "integer", "description": "* `0` - Send HTTP request\n* `1` - Open in new tab\n* `3` - Open in popup window\n* `2` - Open in side panel" }, "AdministrationMethodEnum": { "enum": [ 3, 12, 13, 14, 16, 18, 19, 25, 1, 10, 17, 20, 26, 7, 8, 9, 4, 5, 6, 23, 22, 2, 11, 15, 21, 24, 29, 30, 31, 27, 28 ], "type": "integer", "description": "* `3` - Epidural\n* `12` - Intraarticular (IA)\n* `13` - Intracardiac (IC)\n* `14` - Intramuscular (IM)\n* `16` - Intraosseous (IO)\n* `18` - Intraperitoneal (IP)\n* `19` - Intravenous (IV)\n* `25` - Subcutaneous (SC)\n* `1` - Constant rate infusion (CRI)\n* `10` - In drip\n* `17` - Intraosseous drip (IO drip)\n* `20` - Intravenous drip (IV drip)\n* `26` - Subcutaneous drip (SC drip)\n* `7` - In both ears\n* `8` - In right ear\n* `9` - In left ear\n* `4` - In both eyes\n* `5` - In right eye\n* `6` - In left eye\n* `23` - Peroral (PO)\n* `22` - Intranasal\n* `2` - According to instructions on the package\n* `11` - In feeding tube\n* `15` - Inhalation\n* `21` - Local\n* `24` - Intrarectal\n* `29` - Intravaginal\n* `30` - Intrauterine (IU)\n* `31` - Intramammary\n* `27` - Topical\n* `28` - Sublingual" }, "AdmitConsultation": { "type": "object", "description": "Serializer for admitting consultations. This is only used to make sure that the\ninput is valid with accordance to the model. The rest of the checks are handled\nin SaveConsultation as the POST data is passed to the form used in Provet.\nOther errors will be returned from there.", "properties": { "admitted_time": { "type": "string", "format": "date-time" }, "complaint": { "type": "string" }, "custom_fields": {}, "type": { "type": "integer" }, "department": { "type": "string", "format": "uri" }, "complaint_type": { "type": "string", "format": "uri" }, "go_after": { "allOf": [ { "$ref": "#/components/schemas/GoAfterEnum" } ], "default": "dashboard" }, "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "supervising_veterinarian": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri" }, "started": { "type": "string", "format": "date-time" }, "holding_place_number": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } } }, "required": [ "client", "complaint", "department", "supervising_veterinarian", "type" ] }, "AdmitConsultationRequest": { "type": "object", "description": "Serializer for admitting consultations. This is only used to make sure that the\ninput is valid with accordance to the model. The rest of the checks are handled\nin SaveConsultation as the POST data is passed to the form used in Provet.\nOther errors will be returned from there.", "properties": { "admitted_time": { "type": "string", "format": "date-time" }, "complaint": { "type": "string", "minLength": 1 }, "custom_fields": {}, "type": { "type": "integer" }, "department": { "type": "string", "format": "uri" }, "complaint_type": { "type": "string", "format": "uri" }, "go_after": { "allOf": [ { "$ref": "#/components/schemas/GoAfterEnum" } ], "default": "dashboard" }, "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "supervising_veterinarian": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri" }, "started": { "type": "string", "format": "date-time" }, "holding_place_number": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } } }, "required": [ "client", "complaint", "department", "supervising_veterinarian", "type" ] }, "AlternativePayer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "title": "Invoicing name", "maxLength": 127 }, "id_number": { "type": "string", "title": "Invoicing ID number", "maxLength": 63 }, "organization_name": { "type": "string", "nullable": true, "title": "Invoicing organization name", "maxLength": 127 }, "register_number": { "type": "string", "nullable": true, "title": "Invoicing register number", "maxLength": 31 }, "street_address": { "type": "string", "nullable": true, "title": "Invoicing street address", "maxLength": 127 }, "street_address_2": { "type": "string", "nullable": true, "title": "Invoicing street address 2", "maxLength": 127 }, "street_address_3": { "type": "string", "nullable": true, "title": "Invoicing street address 3", "maxLength": 127 }, "zip_code": { "type": "string", "title": "Invoicing zip code", "maxLength": 12 }, "city": { "type": "string", "title": "Invoicing city", "maxLength": 63 }, "state": { "nullable": true, "title": "Invoicing state", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "maxLength": 100 }, "einvoice_address": { "type": "string", "nullable": true, "title": "E-invoice electronic address", "maxLength": 100 }, "einvoice_operator": { "type": "string", "nullable": true, "title": "E-invoice operator identifier", "maxLength": 100 } }, "required": [ "id" ] }, "AlternativePayerRequest": { "type": "object", "properties": { "name": { "type": "string", "title": "Invoicing name", "maxLength": 127 }, "id_number": { "type": "string", "title": "Invoicing ID number", "maxLength": 63 }, "organization_name": { "type": "string", "nullable": true, "title": "Invoicing organization name", "maxLength": 127 }, "register_number": { "type": "string", "nullable": true, "title": "Invoicing register number", "maxLength": 31 }, "street_address": { "type": "string", "nullable": true, "title": "Invoicing street address", "maxLength": 127 }, "street_address_2": { "type": "string", "nullable": true, "title": "Invoicing street address 2", "maxLength": 127 }, "street_address_3": { "type": "string", "nullable": true, "title": "Invoicing street address 3", "maxLength": 127 }, "zip_code": { "type": "string", "title": "Invoicing zip code", "maxLength": 12 }, "city": { "type": "string", "title": "Invoicing city", "maxLength": 63 }, "state": { "nullable": true, "title": "Invoicing state", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "maxLength": 100 }, "einvoice_address": { "type": "string", "nullable": true, "title": "E-invoice electronic address", "maxLength": 100 }, "einvoice_operator": { "type": "string", "nullable": true, "title": "E-invoice operator identifier", "maxLength": 100 } } }, "AlternativePricing": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "item": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "nominator": { "allOf": [ { "$ref": "#/components/schemas/NominatorEnum" } ], "minimum": -32768, "maximum": 32767 }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_extra_fees": { "type": "boolean" }, "alternative_price": { "type": "number", "format": "double", "description": "Alternative pricing without VAT. returned amount is for\n the quantity that is defined for the alternative pricing, not for the single\n unit or package. This also does not include any extra fees that would have\nto be recalculated based on the amount that was applied during the use of the item\n\n Returns: Decimal-number", "readOnly": true }, "alternative_price_with_vat": { "type": "string", "readOnly": true } }, "required": [ "alternative_price", "alternative_price_with_vat", "id", "item", "name", "nominator", "url", "usage_size" ] }, "AlternativePricingRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "item": { "type": "string", "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "nominator": { "allOf": [ { "$ref": "#/components/schemas/NominatorEnum" } ], "minimum": -32768, "maximum": 32767 }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_extra_fees": { "type": "boolean" } }, "required": [ "item", "name", "nominator", "usage_size" ] }, "Antibiotic": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "archived": { "type": "boolean" } }, "required": [ "id", "name", "url" ] }, "AntibioticPanel": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "archived": { "type": "boolean" }, "antibiotics": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "antibiotics", "id", "name", "url" ] }, "ApitypeEnum": { "enum": [ 1 ], "type": "integer", "description": "* `1` - Star CloudPRNT" }, "AppointmentCheckConflictsQuery": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "user_ids": { "type": "string", "default": "" }, "resource_ids": { "type": "string", "default": "" }, "complaint_type": { "type": "integer", "minimum": 1, "nullable": true }, "appointment": { "type": "integer", "minimum": 1, "nullable": true } }, "required": [ "end", "start" ] }, "AppointmentCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "title": { "type": "string", "maxLength": 255 }, "complaint": { "type": "string", "nullable": true, "maxLength": 255 }, "reason": { "type": "string", "format": "uri", "nullable": true }, "price": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "price_starting_from": { "type": "boolean", "readOnly": true, "nullable": true }, "prepayment_amount": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "additional_users": { "type": "array", "items": { "type": "string", "format": "uri" } }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "parent_appointment": { "type": "string", "format": "uri", "nullable": true }, "notes": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "department": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/TypeAe4Enum" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "active": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "telemedicine_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "telemedicine_url_master": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "cancellation_reason_text": { "type": "string", "nullable": true, "maxLength": 255 }, "cancellation_reason": { "type": "string", "format": "uri", "nullable": true }, "no_show": { "type": "boolean" }, "telemedicine_room": { "type": "string", "nullable": true, "maxLength": 60 }, "ward": { "type": "string", "format": "uri", "nullable": true }, "client_notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "request_hash": { "type": "string", "readOnly": true }, "invoice_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "related_shifts": { "type": "array", "items": { "type": "string", "format": "uri" } }, "allow_double_booking": { "type": "boolean", "default": false }, "confirmed": { "type": "boolean" }, "holding_place_numbers": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Holding place number" }, "title": "Holding place number" } }, "required": [ "department", "end", "id", "invoice_extras", "prepayment_amount", "price", "price_starting_from", "request_hash", "start", "title", "type", "url" ] }, "AppointmentCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "complaint": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "reason": { "type": "string", "format": "uri", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "additional_users": { "type": "array", "items": { "type": "string", "format": "uri" } }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "parent_appointment": { "type": "string", "format": "uri", "nullable": true }, "notes": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "department": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/TypeAe4Enum" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "active": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "telemedicine_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "telemedicine_url_master": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "cancellation_reason_text": { "type": "string", "nullable": true, "maxLength": 255 }, "cancellation_reason": { "type": "string", "format": "uri", "nullable": true }, "no_show": { "type": "boolean" }, "telemedicine_room": { "type": "string", "nullable": true, "maxLength": 60 }, "ward": { "type": "string", "format": "uri", "nullable": true }, "client_notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "related_shifts": { "type": "array", "items": { "type": "string", "format": "uri" } }, "allow_double_booking": { "type": "boolean", "default": false }, "confirmed": { "type": "boolean" }, "holding_place_numbers": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Holding place number" }, "title": "Holding place number" } }, "required": [ "department", "end", "start", "title", "type" ] }, "AppointmentCreateUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "title": { "type": "string", "maxLength": 255 }, "complaint": { "type": "string", "nullable": true, "maxLength": 255 }, "reason": { "type": "string", "format": "uri", "nullable": true }, "price": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "price_starting_from": { "type": "boolean", "readOnly": true, "nullable": true }, "prepayment_amount": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "additional_users": { "type": "array", "items": { "type": "string", "format": "uri" } }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "parent_appointment": { "type": "string", "format": "uri", "nullable": true }, "notes": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "department": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/TypeAe4Enum" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "active": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "telemedicine_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "telemedicine_url_master": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "cancellation_reason_text": { "type": "string", "nullable": true, "maxLength": 255 }, "cancellation_reason": { "type": "string", "format": "uri", "nullable": true }, "no_show": { "type": "boolean" }, "telemedicine_room": { "type": "string", "nullable": true, "maxLength": 60 }, "ward": { "type": "string", "format": "uri", "nullable": true }, "client_notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "request_hash": { "type": "string", "readOnly": true }, "invoice_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "related_shifts": { "type": "array", "items": { "type": "string", "format": "uri" } }, "allow_double_booking": { "type": "boolean", "default": false }, "confirmed": { "type": "boolean" }, "holding_place_numbers": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Holding place number" }, "title": "Holding place number" } }, "required": [ "department", "end", "id", "invoice_extras", "prepayment_amount", "price", "price_starting_from", "request_hash", "start", "title", "type", "url" ] }, "AppointmentCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "complaint": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "reason": { "type": "string", "format": "uri", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "additional_users": { "type": "array", "items": { "type": "string", "format": "uri" } }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "parent_appointment": { "type": "string", "format": "uri", "nullable": true }, "notes": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "department": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/TypeAe4Enum" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "active": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "telemedicine_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "telemedicine_url_master": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "cancellation_reason_text": { "type": "string", "nullable": true, "maxLength": 255 }, "cancellation_reason": { "type": "string", "format": "uri", "nullable": true }, "no_show": { "type": "boolean" }, "telemedicine_room": { "type": "string", "nullable": true, "maxLength": 60 }, "ward": { "type": "string", "format": "uri", "nullable": true }, "client_notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "related_shifts": { "type": "array", "items": { "type": "string", "format": "uri" } }, "allow_double_booking": { "type": "boolean", "default": false }, "confirmed": { "type": "boolean" }, "holding_place_numbers": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Holding place number" }, "title": "Holding place number" } }, "required": [ "department", "end", "start", "title", "type" ] }, "AppointmentDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true, "description": "Unique appointment ID" }, "url": { "type": "string", "format": "uri", "readOnly": true, "description": "URL to this appointment resource" }, "start": { "type": "string", "format": "date-time", "description": "Appointment start datetime (ISO 8601 format)" }, "end": { "type": "string", "format": "date-time", "description": "Appointment end datetime (ISO 8601 format)" }, "title": { "type": "string", "description": "Appointment title/summary", "maxLength": 255 }, "complaint": { "type": "string", "nullable": true, "description": "Chief complaint or reason for visit (text)", "maxLength": 255 }, "reason": { "type": "string", "format": "uri" }, "instructions": { "type": "string", "nullable": true, "description": "Special instructions for appointment" }, "user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to primary veterinarian/user assigned to appointment" }, "additional_users": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to additional staff members assigned to appointment" }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to equipment or resources reserved for appointment" }, "client": { "type": "string", "format": "uri", "nullable": true, "description": "URL to client attending appointment" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to patients included in appointment" }, "consultation": { "type": "string", "format": "uri", "nullable": true, "description": "URL to consultation record linked to this appointment" }, "related_appointments": { "type": "string", "format": "uri", "nullable": true, "description": "List of URLs to other appointments related to this one" }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "Appointment duration in minutes" }, "notes": { "type": "string", "nullable": true, "description": "Internal notes about appointment" }, "parent_appointment": { "type": "string", "format": "uri", "nullable": true, "description": "URL to parent appointment if this is a sub-appointment" }, "child_appointments": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to sub-appointments under this parent appointment" }, "active": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "True if appointment is active (not cancelled)" }, "department": { "type": "string", "format": "uri", "description": "URL to department where appointment takes place" }, "ward": { "type": "string", "format": "uri" }, "type": { "allOf": [ { "$ref": "#/components/schemas/TypeB05Enum" } ], "description": "Appointment type: 1=Consultation, 2=Online booking, 3=Other, 4=Internal booking, 5=Unknown client, 6=Farm visit, 7=Preliminary booking, 8=Boarding, 9=Pet service\n\n* `1` - Consultation\n* `4` - Internal booking\n* `2` - Online booking\n* `3` - Other\n* `5` - Unknown client\n* `6` - Farm visit\n* `8` - Boarding\n* `9` - Pet service\n* `7` - Preliminary booking", "minimum": -2147483648, "maximum": 2147483647 }, "start_date": { "type": "string", "format": "date", "nullable": true, "description": "Appointment start date (YYYY-MM-DD)" }, "end_date": { "type": "string", "format": "date", "nullable": true, "description": "Appointment end date (YYYY-MM-DD)" }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when appointment was created" }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when appointment was last modified" }, "created_user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to user who created appointment" }, "modified_user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to user who last modified appointment" }, "request_hash": { "type": "string", "readOnly": true, "description": "Unique hash for online booking request" }, "telemedicine_url": { "type": "string", "nullable": true, "description": "Telemedicine video call URL for client", "format": "uri", "maxLength": 200 }, "telemedicine_url_master": { "type": "string", "nullable": true, "description": "Telemedicine video call URL for veterinarian", "format": "uri", "maxLength": 200 }, "telemedicine_room": { "type": "string", "nullable": true, "description": "Telemedicine room identifier", "maxLength": 60 }, "cancellation_reason_text": { "type": "string", "nullable": true, "description": "Free text cancellation reason", "maxLength": 255 }, "cancellation_reason": { "type": "string", "format": "uri", "nullable": true, "description": "URL to structured cancellation reason code" }, "no_show": { "type": "boolean", "description": "True if client did not show up for appointment" }, "client_notes": { "type": "string", "nullable": true, "description": "Notes visible to client", "maxLength": 1000 }, "invoice_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true, "description": "List of URLs to additional invoice line items added to appointment" }, "related_shifts": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to staff shifts related to this appointment" }, "complaint_type": { "type": "string", "format": "uri", "nullable": true, "description": "URL to complaint type classification" }, "price": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "price_starting_from": { "type": "boolean", "readOnly": true, "nullable": true }, "prepayment_amount": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "confirmed": { "type": "boolean", "description": "True if appointment has been confirmed" }, "holding_place_numbers": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Holding place number" }, "title": "Holding place number", "description": "List of URLs to holding place numbers for production animal visits" }, "onlinebooking_confirm_by_default": { "type": "string", "readOnly": true }, "appointment_confirmation_url": { "type": "string", "readOnly": true } }, "required": [ "additional_users", "appointment_confirmation_url", "child_appointments", "created", "department", "end", "holding_place_numbers", "id", "invoice_extras", "modified", "onlinebooking_confirm_by_default", "patients", "prepayment_amount", "price", "price_starting_from", "reason", "request_hash", "start", "title", "url", "ward" ] }, "AppointmentMultiUpload": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 32 }, "description": { "type": "string" }, "created": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created" ] }, "AppointmentMultiUploadRequest": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 32 }, "description": { "type": "string" } } }, "AppointmentReminder": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "appointment": { "type": "string", "readOnly": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode095Enum" } ], "minimum": -32768, "maximum": 32767 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "send_date": { "type": "string", "format": "date", "nullable": true }, "send_datetime": { "type": "string", "format": "date-time" }, "send_externally": { "type": "boolean" }, "sent_datetime": { "type": "string", "format": "date-time", "nullable": true }, "phone_number": { "type": "string", "maxLength": 31 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "sms_text": { "type": "string" } }, "required": [ "appointment", "created", "modified", "phone_number", "send_datetime", "sms_text", "type_code", "url" ] }, "AppointmentReminderCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "appointment": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode095Enum" } ], "minimum": -32768, "maximum": 32767 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "send_date": { "type": "string", "format": "date", "nullable": true }, "send_datetime": { "type": "string", "format": "date-time" }, "send_externally": { "type": "boolean" }, "sent_datetime": { "type": "string", "format": "date-time", "nullable": true }, "phone_number": { "type": "string", "maxLength": 31 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "sms_text": { "type": "string" } }, "required": [ "appointment", "created", "modified", "type_code", "url" ] }, "AppointmentReminderCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "appointment": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode095Enum" } ], "minimum": -32768, "maximum": 32767 }, "send_date": { "type": "string", "format": "date", "nullable": true }, "send_datetime": { "type": "string", "format": "date-time" }, "send_externally": { "type": "boolean" }, "sent_datetime": { "type": "string", "format": "date-time", "nullable": true }, "phone_number": { "type": "string", "minLength": 1, "maxLength": 31 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "sms_text": { "type": "string", "minLength": 1 } }, "required": [ "appointment", "type_code" ] }, "AppointmentReminderDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "appointment": { "type": "string", "readOnly": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode095Enum" } ], "minimum": -32768, "maximum": 32767 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "send_date": { "type": "string", "format": "date", "nullable": true }, "send_datetime": { "type": "string", "format": "date-time" }, "send_externally": { "type": "boolean" }, "sent_datetime": { "type": "string", "format": "date-time", "nullable": true }, "phone_number": { "type": "string", "maxLength": 31 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "sms_text": { "type": "string" }, "sms_text_sent": { "type": "string", "nullable": true } }, "required": [ "appointment", "created", "modified", "phone_number", "send_datetime", "sms_text", "type_code", "url" ] }, "AppointmentReminderDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode095Enum" } ], "minimum": -32768, "maximum": 32767 }, "send_date": { "type": "string", "format": "date", "nullable": true }, "send_datetime": { "type": "string", "format": "date-time" }, "send_externally": { "type": "boolean" }, "sent_datetime": { "type": "string", "format": "date-time", "nullable": true }, "phone_number": { "type": "string", "minLength": 1, "maxLength": 31 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "sms_text": { "type": "string", "minLength": 1 }, "sms_text_sent": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "phone_number", "send_datetime", "sms_text", "type_code" ] }, "AppointmentReminderRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode095Enum" } ], "minimum": -32768, "maximum": 32767 }, "send_date": { "type": "string", "format": "date", "nullable": true }, "send_datetime": { "type": "string", "format": "date-time" }, "send_externally": { "type": "boolean" }, "sent_datetime": { "type": "string", "format": "date-time", "nullable": true }, "phone_number": { "type": "string", "minLength": 1, "maxLength": 31 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "sms_text": { "type": "string", "minLength": 1 } }, "required": [ "phone_number", "send_datetime", "sms_text", "type_code" ] }, "AppointmentUpload": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "file": { "type": "string", "format": "uri" }, "original_name": { "type": "string", "maxLength": 255 }, "thumbnail_url": { "type": "string", "format": "uri" }, "size": { "type": "integer", "readOnly": true } }, "required": [ "file", "id", "original_name", "size" ] }, "AppointmentUploadRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "file": { "type": "string", "format": "binary" }, "original_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "thumbnail_url": { "type": "string", "format": "uri", "minLength": 1 } }, "required": [ "file", "original_name" ] }, "ArchiveImportJob": { "type": "object", "description": "Serializer for import jobs.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "job_type": { "allOf": [ { "$ref": "#/components/schemas/JobTypeEnum" } ], "readOnly": true }, "source": { "type": "string", "readOnly": true, "description": "Source system name (e.g. VETERA, or custom import source)." }, "status": { "allOf": [ { "$ref": "#/components/schemas/ArchiveImportJobStatusEnum" } ], "readOnly": true }, "department": { "type": "integer", "readOnly": true }, "started_by": { "type": "integer", "readOnly": true }, "invoices_processed": { "type": "integer", "readOnly": true }, "invoices_created": { "type": "integer", "readOnly": true }, "invoices_skipped": { "type": "integer", "readOnly": true }, "invoices_failed": { "type": "integer", "readOnly": true }, "rows_created": { "type": "integer", "readOnly": true }, "payments_created": { "type": "integer", "readOnly": true }, "source_file_name": { "type": "string", "readOnly": true, "nullable": true }, "error_log": { "readOnly": true, "nullable": true, "description": "Per-record errors encountered during processing" }, "started_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "completed_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_invoices": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "description": "Map of Provet archived invoice id to 3rd-party source_invoice_id.", "readOnly": true } }, "required": [ "completed_at", "created", "created_invoices", "department", "error_log", "id", "invoices_created", "invoices_failed", "invoices_processed", "invoices_skipped", "job_type", "payments_created", "rows_created", "source", "source_file_name", "started_at", "started_by", "status", "url" ] }, "ArchiveImportJobStatusEnum": { "enum": [ "PENDING", "RUNNING", "COMPLETED", "FAILED", "PARTIAL" ], "type": "string", "description": "* `PENDING` - Pending\n* `RUNNING` - Running\n* `COMPLETED` - Completed\n* `FAILED` - Failed\n* `PARTIAL` - Partially Completed" }, "ArchivedInvoiceRead": { "type": "object", "description": "Serializer for reading archived invoices. Uses client_id/department_id to match POST body.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "source": { "type": "string", "description": "Source system name (e.g. VETERA, or custom import source).", "maxLength": 50 }, "source_invoice_id": { "type": "string", "description": "Original ID from source system", "maxLength": 100 }, "source_invoice_number": { "type": "string", "description": "Human-readable invoice number from source", "maxLength": 100 }, "original_provet_invoice_id": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "nullable": true }, "client_id": { "type": "integer", "readOnly": true }, "patients": { "type": "array", "items": { "type": "integer" }, "readOnly": true }, "supervising_veterinarian_id": { "type": "integer", "readOnly": true }, "department_id": { "type": "integer", "readOnly": true }, "invoice_date": { "type": "string", "format": "date" }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true }, "currency_code": { "type": "string", "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total excluding VAT (Subtotal)" }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total VAT amount" }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total including VAT" }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Outstanding balance (Due amount)" }, "status": { "$ref": "#/components/schemas/StatusC54Enum" }, "is_credit_note": { "type": "boolean" }, "is_countersale": { "type": "boolean" }, "credited_invoice": { "type": "integer", "readOnly": true }, "payer_snapshot": { "nullable": true, "description": "Payer/client details: name, email, id_number, organization_name, vat_number, register_number, street_address, zip_code, city, state, country" }, "receiver_snapshot": { "nullable": true, "description": "Recipient/clinic details: name, street_address, zip_code, city, state, vat_number, iban, bic" }, "invoice_details_snapshot": { "nullable": true, "description": "Additional invoice details: created_by, modified_by, due_date, email_sent_at, printed_at, payment_terms_days, penalty_interest, supervising_vet, remarks, internal_remarks, rounding_amount" }, "patients_snapshot": { "nullable": true, "description": "List of patients on invoice: [{id, name, species, breed, insurance_company, insurance_number, date_of_birth}, ...]" }, "vat_breakdown": { "nullable": true, "description": "VAT breakdown by rate: [{rate, name, net, vat, gross}, ...]" }, "meta_json": { "nullable": true, "description": "Source-specific fields not mapped to standard fields" }, "archived_at": { "type": "string", "format": "date-time", "readOnly": true }, "created": { "type": "string", "format": "date-time", "description": "Original creation date" }, "modified": { "type": "string", "format": "date-time", "description": "Original modification date" } }, "required": [ "archived_at", "client_id", "created", "credited_invoice", "department_id", "id", "invoice_date", "modified", "patients", "source", "source_invoice_id", "source_invoice_number", "supervising_veterinarian_id", "total", "total_vat", "total_with_vat", "url" ] }, "ArchivedInvoiceReadRequest": { "type": "object", "description": "Serializer for reading archived invoices. Uses client_id/department_id to match POST body.", "properties": { "source": { "type": "string", "minLength": 1, "description": "Source system name (e.g. VETERA, or custom import source).", "maxLength": 50 }, "source_invoice_id": { "type": "string", "minLength": 1, "description": "Original ID from source system", "maxLength": 100 }, "source_invoice_number": { "type": "string", "minLength": 1, "description": "Human-readable invoice number from source", "maxLength": 100 }, "original_provet_invoice_id": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "nullable": true }, "invoice_date": { "type": "string", "format": "date" }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true }, "currency_code": { "type": "string", "minLength": 1, "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total excluding VAT (Subtotal)" }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total VAT amount" }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total including VAT" }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Outstanding balance (Due amount)" }, "status": { "$ref": "#/components/schemas/StatusC54Enum" }, "is_credit_note": { "type": "boolean" }, "is_countersale": { "type": "boolean" }, "payer_snapshot": { "nullable": true, "description": "Payer/client details: name, email, id_number, organization_name, vat_number, register_number, street_address, zip_code, city, state, country" }, "receiver_snapshot": { "nullable": true, "description": "Recipient/clinic details: name, street_address, zip_code, city, state, vat_number, iban, bic" }, "invoice_details_snapshot": { "nullable": true, "description": "Additional invoice details: created_by, modified_by, due_date, email_sent_at, printed_at, payment_terms_days, penalty_interest, supervising_vet, remarks, internal_remarks, rounding_amount" }, "patients_snapshot": { "nullable": true, "description": "List of patients on invoice: [{id, name, species, breed, insurance_company, insurance_number, date_of_birth}, ...]" }, "vat_breakdown": { "nullable": true, "description": "VAT breakdown by rate: [{rate, name, net, vat, gross}, ...]" }, "meta_json": { "nullable": true, "description": "Source-specific fields not mapped to standard fields" }, "created": { "type": "string", "format": "date-time", "description": "Original creation date" }, "modified": { "type": "string", "format": "date-time", "description": "Original modification date" } }, "required": [ "created", "invoice_date", "modified", "source", "source_invoice_id", "source_invoice_number", "total", "total_vat", "total_with_vat" ] }, "ArchivedInvoiceRowRead": { "type": "object", "description": "Serializer for reading invoice rows.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "invoice": { "type": "integer", "readOnly": true }, "display_order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "description": "Display order on invoice" }, "patient": { "type": "integer", "readOnly": true }, "supervising_veterinarian_id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unit": { "type": "string", "maxLength": 63 }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Line total excluding VAT (Subtotal)" }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Line VAT amount" }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Line total including VAT (Total price)" }, "row_snapshot": { "nullable": true, "description": "Row details: date, patient_name, print_name, item_code, got_number, type_code, invoice_group, veterinarian, stock_location, cost_center, project_code, account_number, unit_price, unit_price_with_vat, discount_percentage, price_change_percentage, cost_price, original_row_id, original_item_id, original_invoicerow_id" }, "meta_json": { "nullable": true } }, "required": [ "id", "invoice", "name", "patient", "supervising_veterinarian_id", "url" ] }, "ArchivedInvoiceRowWrite": { "type": "object", "description": "One line item on an archived invoice. Column fields are validated;\nextra details go into row_snapshot.", "properties": { "display_order": { "type": "integer", "default": 0, "description": "Order of the row on the invoice (0-based)." }, "patient_id": { "type": "integer", "nullable": true, "description": "Provet patient ID for this line, if applicable." }, "supervising_veterinarian_id": { "type": "integer", "nullable": true, "description": "Provet user ID of the supervising veterinarian for this line." }, "name": { "type": "string", "description": "Line description (e.g. 'Consultation', 'Vaccination').", "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Quantity (up to 4 decimal places)." }, "unit": { "type": "string", "default": "", "description": "Unit (e.g. kpl, pcs).", "maxLength": 63 }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "VAT rate (e.g. 24.0000, 10.0000)." }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Unit price excluding VAT." }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "VAT amount for this line." }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Line total including VAT." }, "row_snapshot": { "nullable": true, "description": "Extra row details (item_code, veterinarian, dates, etc.). Any structure." }, "meta_json": { "nullable": true, "description": "Source-specific row metadata." } }, "required": [ "name" ] }, "ArchivedInvoiceRowWriteRequest": { "type": "object", "description": "One line item on an archived invoice. Column fields are validated;\nextra details go into row_snapshot.", "properties": { "display_order": { "type": "integer", "default": 0, "description": "Order of the row on the invoice (0-based)." }, "patient_id": { "type": "integer", "nullable": true, "description": "Provet patient ID for this line, if applicable." }, "supervising_veterinarian_id": { "type": "integer", "nullable": true, "description": "Provet user ID of the supervising veterinarian for this line." }, "name": { "type": "string", "minLength": 1, "description": "Line description (e.g. 'Consultation', 'Vaccination').", "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Quantity (up to 4 decimal places)." }, "unit": { "type": "string", "default": "", "description": "Unit (e.g. kpl, pcs).", "maxLength": 63 }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "VAT rate (e.g. 24.0000, 10.0000)." }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Unit price excluding VAT." }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "VAT amount for this line." }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Line total including VAT." }, "row_snapshot": { "nullable": true, "description": "Extra row details (item_code, veterinarian, dates, etc.). Any structure." }, "meta_json": { "nullable": true, "description": "Source-specific row metadata." } }, "required": [ "name" ] }, "ArchivedInvoiceUpdate": { "type": "object", "description": "Serializer for updating an existing archived invoice (PATCH/PUT).\n\nAll fields are optional; only provided fields are updated.\nIf rows or payments are provided, existing rows/payments are replaced.", "properties": { "source": { "type": "string", "description": "Source system name (e.g. VETERA, or custom).", "maxLength": 50 }, "source_invoice_number": { "type": "string", "maxLength": 100 }, "client_id": { "type": "integer" }, "patient_ids": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "supervising_veterinarian_id": { "type": "integer", "nullable": true }, "department_id": { "type": "integer" }, "invoice_date": { "type": "string", "format": "date" }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true }, "currency_code": { "type": "string", "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "status": { "$ref": "#/components/schemas/StatusC54Enum" }, "is_credit_note": { "type": "boolean" }, "is_countersale": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "payer_snapshot": { "allOf": [ { "$ref": "#/components/schemas/PayerSnapshot" } ], "nullable": true }, "receiver_snapshot": { "allOf": [ { "$ref": "#/components/schemas/ReceiverSnapshot" } ], "nullable": true }, "invoice_details_snapshot": { "nullable": true }, "patients_snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/PatientSnapshotItem" }, "nullable": true }, "vat_breakdown": { "nullable": true }, "meta_json": { "nullable": true }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRowWrite" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedPaymentWrite" } } } }, "ArchivedInvoiceUpdateRequest": { "type": "object", "description": "Serializer for updating an existing archived invoice (PATCH/PUT).\n\nAll fields are optional; only provided fields are updated.\nIf rows or payments are provided, existing rows/payments are replaced.", "properties": { "source": { "type": "string", "description": "Source system name (e.g. VETERA, or custom).", "maxLength": 50 }, "source_invoice_number": { "type": "string", "minLength": 1, "maxLength": 100 }, "client_id": { "type": "integer" }, "patient_ids": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "supervising_veterinarian_id": { "type": "integer", "nullable": true }, "department_id": { "type": "integer" }, "invoice_date": { "type": "string", "format": "date" }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true }, "currency_code": { "type": "string", "minLength": 1, "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "status": { "$ref": "#/components/schemas/StatusC54Enum" }, "is_credit_note": { "type": "boolean" }, "is_countersale": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "payer_snapshot": { "allOf": [ { "$ref": "#/components/schemas/PayerSnapshotRequest" } ], "nullable": true }, "receiver_snapshot": { "allOf": [ { "$ref": "#/components/schemas/ReceiverSnapshotRequest" } ], "nullable": true }, "invoice_details_snapshot": { "nullable": true }, "patients_snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/PatientSnapshotItemRequest" }, "nullable": true }, "vat_breakdown": { "nullable": true }, "meta_json": { "nullable": true }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRowWriteRequest" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedPaymentWriteRequest" } } } }, "ArchivedInvoiceWrite": { "type": "object", "description": "Single archived invoice for import. Required: source_invoice_id,\nsource_invoice_number, client_id, department_id, invoice_date, created,\nmodified, total, total_vat, total_with_vat. Optional: source (for single\ncreate), patient_ids, snapshots, rows, payments.", "properties": { "source": { "type": "string", "description": "Source system name (e.g. VETERA, or custom). Omit in bulk import.", "maxLength": 50 }, "source_invoice_id": { "type": "string", "description": "Original invoice ID from the source system (unique per source).", "maxLength": 100 }, "source_invoice_number": { "type": "string", "description": "Human-readable invoice number (e.g. RG-1079).", "maxLength": 100 }, "client_id": { "type": "integer", "description": "Provet client ID (health.Client) for this invoice." }, "patient_ids": { "type": "array", "items": { "type": "integer" }, "description": "Provet patient IDs (health.Patient) linked to this invoice. Optional." }, "supervising_veterinarian_id": { "type": "integer", "nullable": true, "description": "Provet user ID of the supervising veterinarian for this invoice." }, "department_id": { "type": "integer", "description": "Provet department ID (organization.Department)." }, "invoice_date": { "type": "string", "format": "date", "description": "Invoice date (YYYY-MM-DD)." }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the invoice was finalized (ISO 8601). Optional." }, "currency_code": { "type": "string", "default": "EUR", "description": "ISO 4217 currency code (e.g. EUR).", "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total excluding VAT (subtotal)." }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total VAT amount." }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total including VAT." }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "default": 0.0, "description": "Outstanding balance (due amount)." }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusC54Enum" } ], "default": "FINALIZED", "description": "DRAFT, FINALIZED, PAID, PARTIALLY_PAID, OVERPAID, CANCELLED.\n\n* `DRAFT` - Draft\n* `FINALIZED` - Finalized\n* `PAID` - Paid\n* `PARTIALLY_PAID` - Partially Paid\n* `OVERPAID` - Overpaid\n* `CANCELLED` - Cancelled" }, "is_credit_note": { "type": "boolean", "default": false, "description": "True if this is a credit note." }, "is_countersale": { "type": "boolean", "default": false, "description": "True if countersale." }, "created": { "type": "string", "format": "date-time", "description": "Original creation time from source (ISO 8601)." }, "modified": { "type": "string", "format": "date-time", "description": "Original last modification time from source (ISO 8601)." }, "payer_snapshot": { "allOf": [ { "$ref": "#/components/schemas/PayerSnapshot" } ], "nullable": true, "description": "Payer/client display snapshot. Object with optional keys: name, email, phone, id_number, organization_name, vat_number, register_number, street_address, zip_code, city, country, tags." }, "receiver_snapshot": { "allOf": [ { "$ref": "#/components/schemas/ReceiverSnapshot" } ], "nullable": true, "description": "Clinic/recipient display snapshot. Object with optional keys: name, street_address, zip_code, city, vat_number, iban, bic." }, "invoice_details_snapshot": { "nullable": true, "description": "Extra invoice details (payment_terms, due_date, remarks, etc.). Any structure." }, "patients_snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/PatientSnapshotItem" }, "nullable": true, "description": "Display-only list of patients. Array of objects with optional name, species, breed, date_of_birth." }, "vat_breakdown": { "nullable": true, "description": "VAT by rate. Array of { rate, name, net, vat, gross } (numbers as string or number)." }, "meta_json": { "nullable": true, "description": "Source-specific metadata. Any structure." }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRowWrite" }, "description": "Line items. Array of { display_order, patient_id?, name, quantity?, unit?, vat_percentage?, price?, total_vat?, total_with_vat?, row_snapshot?, meta_json? }." }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedPaymentWrite" }, "description": "Payments. Array of { payment_date, payment_method_name, amount, currency_code?, is_cancelled?, payment_snapshot?, meta_json? }." } }, "required": [ "client_id", "created", "department_id", "invoice_date", "modified", "source_invoice_id", "source_invoice_number", "total", "total_vat", "total_with_vat" ] }, "ArchivedInvoiceWriteRequest": { "type": "object", "description": "Single archived invoice for import. Required: source_invoice_id,\nsource_invoice_number, client_id, department_id, invoice_date, created,\nmodified, total, total_vat, total_with_vat. Optional: source (for single\ncreate), patient_ids, snapshots, rows, payments.", "properties": { "source": { "type": "string", "description": "Source system name (e.g. VETERA, or custom). Omit in bulk import.", "maxLength": 50 }, "source_invoice_id": { "type": "string", "minLength": 1, "description": "Original invoice ID from the source system (unique per source).", "maxLength": 100 }, "source_invoice_number": { "type": "string", "minLength": 1, "description": "Human-readable invoice number (e.g. RG-1079).", "maxLength": 100 }, "client_id": { "type": "integer", "description": "Provet client ID (health.Client) for this invoice." }, "patient_ids": { "type": "array", "items": { "type": "integer" }, "description": "Provet patient IDs (health.Patient) linked to this invoice. Optional." }, "supervising_veterinarian_id": { "type": "integer", "nullable": true, "description": "Provet user ID of the supervising veterinarian for this invoice." }, "department_id": { "type": "integer", "description": "Provet department ID (organization.Department)." }, "invoice_date": { "type": "string", "format": "date", "description": "Invoice date (YYYY-MM-DD)." }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the invoice was finalized (ISO 8601). Optional." }, "currency_code": { "type": "string", "minLength": 1, "default": "EUR", "description": "ISO 4217 currency code (e.g. EUR).", "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total excluding VAT (subtotal)." }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total VAT amount." }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total including VAT." }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "default": 0.0, "description": "Outstanding balance (due amount)." }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusC54Enum" } ], "default": "FINALIZED", "description": "DRAFT, FINALIZED, PAID, PARTIALLY_PAID, OVERPAID, CANCELLED.\n\n* `DRAFT` - Draft\n* `FINALIZED` - Finalized\n* `PAID` - Paid\n* `PARTIALLY_PAID` - Partially Paid\n* `OVERPAID` - Overpaid\n* `CANCELLED` - Cancelled" }, "is_credit_note": { "type": "boolean", "default": false, "description": "True if this is a credit note." }, "is_countersale": { "type": "boolean", "default": false, "description": "True if countersale." }, "created": { "type": "string", "format": "date-time", "description": "Original creation time from source (ISO 8601)." }, "modified": { "type": "string", "format": "date-time", "description": "Original last modification time from source (ISO 8601)." }, "payer_snapshot": { "allOf": [ { "$ref": "#/components/schemas/PayerSnapshotRequest" } ], "nullable": true, "description": "Payer/client display snapshot. Object with optional keys: name, email, phone, id_number, organization_name, vat_number, register_number, street_address, zip_code, city, country, tags." }, "receiver_snapshot": { "allOf": [ { "$ref": "#/components/schemas/ReceiverSnapshotRequest" } ], "nullable": true, "description": "Clinic/recipient display snapshot. Object with optional keys: name, street_address, zip_code, city, vat_number, iban, bic." }, "invoice_details_snapshot": { "nullable": true, "description": "Extra invoice details (payment_terms, due_date, remarks, etc.). Any structure." }, "patients_snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/PatientSnapshotItemRequest" }, "nullable": true, "description": "Display-only list of patients. Array of objects with optional name, species, breed, date_of_birth." }, "vat_breakdown": { "nullable": true, "description": "VAT by rate. Array of { rate, name, net, vat, gross } (numbers as string or number)." }, "meta_json": { "nullable": true, "description": "Source-specific metadata. Any structure." }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRowWriteRequest" }, "description": "Line items. Array of { display_order, patient_id?, name, quantity?, unit?, vat_percentage?, price?, total_vat?, total_with_vat?, row_snapshot?, meta_json? }." }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedPaymentWriteRequest" }, "description": "Payments. Array of { payment_date, payment_method_name, amount, currency_code?, is_cancelled?, payment_snapshot?, meta_json? }." } }, "required": [ "client_id", "created", "department_id", "invoice_date", "modified", "source_invoice_id", "source_invoice_number", "total", "total_vat", "total_with_vat" ] }, "ArchivedPaymentRead": { "type": "object", "description": "Serializer for reading payments.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "invoice": { "type": "integer", "readOnly": true }, "payment_date": { "type": "string", "format": "date-time" }, "payment_method_name": { "type": "string", "description": "Payment method name (e.g., Cash, Card, Prepayment)", "maxLength": 100 }, "amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "currency_code": { "type": "string", "maxLength": 3 }, "is_cancelled": { "type": "boolean" }, "payment_snapshot": { "nullable": true, "description": "Payment details: info, receipt_number, payment_reference, source_payment_id, original_payment_id, created, tse_signature, tse_transaction_number, tse_serial_number, tse_time_format" }, "meta_json": { "nullable": true } }, "required": [ "amount", "id", "invoice", "payment_date", "payment_method_name", "url" ] }, "ArchivedPaymentWrite": { "type": "object", "description": "One payment against an archived invoice. Column fields are validated;\nextra details go into payment_snapshot.", "properties": { "payment_date": { "type": "string", "format": "date-time", "description": "When the payment was made (ISO 8601)." }, "payment_method_name": { "type": "string", "description": "Method name (e.g. 'Card', 'Bank transfer', 'Cash').", "maxLength": 100 }, "amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Payment amount." }, "currency_code": { "type": "string", "default": "EUR", "description": "ISO 4217 currency (e.g. EUR).", "maxLength": 3 }, "is_cancelled": { "type": "boolean", "default": false, "description": "True if this payment was later cancelled." }, "payment_snapshot": { "nullable": true, "description": "Extra payment details (reference, receipt, etc.). Any structure." }, "meta_json": { "nullable": true, "description": "Source-specific payment metadata." } }, "required": [ "amount", "payment_date", "payment_method_name" ] }, "ArchivedPaymentWriteRequest": { "type": "object", "description": "One payment against an archived invoice. Column fields are validated;\nextra details go into payment_snapshot.", "properties": { "payment_date": { "type": "string", "format": "date-time", "description": "When the payment was made (ISO 8601)." }, "payment_method_name": { "type": "string", "minLength": 1, "description": "Method name (e.g. 'Card', 'Bank transfer', 'Cash').", "maxLength": 100 }, "amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Payment amount." }, "currency_code": { "type": "string", "minLength": 1, "default": "EUR", "description": "ISO 4217 currency (e.g. EUR).", "maxLength": 3 }, "is_cancelled": { "type": "boolean", "default": false, "description": "True if this payment was later cancelled." }, "payment_snapshot": { "nullable": true, "description": "Extra payment details (reference, receipt, etc.). Any structure." }, "meta_json": { "nullable": true, "description": "Source-specific payment metadata." } }, "required": [ "amount", "payment_date", "payment_method_name" ] }, "AvailableWholesaler": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 63 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 }, "webhook_callback_url": { "type": "string", "format": "uri", "maxLength": 200 } }, "required": [ "id", "name", "url", "webhook_callback_url" ] }, "AvailableWholesalerRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 63 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 }, "webhook_callback_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 200 }, "verification_salt": { "type": "string", "writeOnly": true, "minLength": 16, "description": "Shared secret used to HMAC-sign webhook deliveries. Required on create; send a new value to rotate it.", "maxLength": 128 } }, "required": [ "name", "verification_salt", "webhook_callback_url" ] }, "BackgroundColorEnum": { "enum": [ "000000", "ffffff", "3780b9", "6b37b9", "f39c12", "ff9a80", "c0392b", "2c3e50", "f1c40f", "8A5B33", "7f8c8d", "3ecc71" ], "type": "string", "description": "* `000000` - Black\n* `ffffff` - White\n* `3780b9` - Blue\n* `6b37b9` - Purple\n* `f39c12` - Orange\n* `ff9a80` - Pink\n* `c0392b` - Red\n* `2c3e50` - Midnight blue\n* `f1c40f` - Sun\n* `8A5B33` - Tree\n* `7f8c8d` - Gray\n* `3ecc71` - Green" }, "Batch": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "batch_number": { "type": "string", "maxLength": 63 }, "department_id": { "type": "integer" }, "expiry_date": { "type": "string", "format": "date" }, "item_id": { "type": "integer" }, "stock_item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "units": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true } }, "required": [ "batch_number", "quantity", "units", "url" ] }, "BatchDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "batch_number": { "type": "string", "maxLength": 63 }, "department_id": { "type": "integer" }, "expiry_date": { "type": "string", "format": "date" }, "item_id": { "type": "integer" }, "stock_item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "units": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "location_levels": { "type": "string", "readOnly": true } }, "required": [ "batch_number", "location_levels", "quantity", "units", "url" ] }, "BatchRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "batch_number": { "type": "string", "minLength": 1, "maxLength": 63 }, "department_id": { "type": "integer" }, "expiry_date": { "type": "string", "format": "date" }, "item_id": { "type": "integer" }, "stock_item": { "type": "string", "format": "uri" } }, "required": [ "batch_number" ] }, "BlankEnum": { "enum": [ "" ] }, "BloodGroupEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ], "type": "integer", "description": "* `1` - DEA 1.1 NEG\n* `2` - DEA 1.1 POS\n* `3` - A\n* `4` - B\n* `5` - AB\n* `6` - C\n* `7` - D\n* `8` - K\n* `9` - P\n* `10` - Q\n* `11` - U\n* `12` - T" }, "BloodPressure": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "blood_pressure_max": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "blood_pressure_min": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "body_position": { "allOf": [ { "$ref": "#/components/schemas/BodyPositionEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "id", "timestamp" ] }, "BloodPressureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "blood_pressure_max": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "blood_pressure_min": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "body_position": { "allOf": [ { "$ref": "#/components/schemas/BodyPositionEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "timestamp" ] }, "BodyConditionScore": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "body_condition_score": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "id", "timestamp" ] }, "BodyConditionScoreRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "body_condition_score": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "timestamp" ] }, "BodyPositionEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Sitting\n* `2` - Laterally recumbent / lying on one side\n* `3` - Standing" }, "BulkImportInvoice": { "type": "object", "description": "Invoice serializer for bulk import - source is provided by parent serializer.\n\nSkips source validation during initial validation since source comes from\nthe parent BulkImportRequestSerializer context during create().", "properties": { "source_invoice_id": { "type": "string", "description": "Original invoice ID from the source system (unique per source).", "maxLength": 100 }, "source_invoice_number": { "type": "string", "description": "Human-readable invoice number (e.g. RG-1079).", "maxLength": 100 }, "client_id": { "type": "integer", "description": "Provet client ID (health.Client) for this invoice." }, "patient_ids": { "type": "array", "items": { "type": "integer" }, "description": "Provet patient IDs (health.Patient) linked to this invoice. Optional." }, "supervising_veterinarian_id": { "type": "integer", "nullable": true, "description": "Provet user ID of the supervising veterinarian for this invoice." }, "department_id": { "type": "integer", "description": "Provet department ID (organization.Department)." }, "invoice_date": { "type": "string", "format": "date", "description": "Invoice date (YYYY-MM-DD)." }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the invoice was finalized (ISO 8601). Optional." }, "currency_code": { "type": "string", "default": "EUR", "description": "ISO 4217 currency code (e.g. EUR).", "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total excluding VAT (subtotal)." }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total VAT amount." }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total including VAT." }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "default": 0.0, "description": "Outstanding balance (due amount)." }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusC54Enum" } ], "default": "FINALIZED", "description": "DRAFT, FINALIZED, PAID, PARTIALLY_PAID, OVERPAID, CANCELLED.\n\n* `DRAFT` - Draft\n* `FINALIZED` - Finalized\n* `PAID` - Paid\n* `PARTIALLY_PAID` - Partially Paid\n* `OVERPAID` - Overpaid\n* `CANCELLED` - Cancelled" }, "is_credit_note": { "type": "boolean", "default": false, "description": "True if this is a credit note." }, "is_countersale": { "type": "boolean", "default": false, "description": "True if countersale." }, "created": { "type": "string", "format": "date-time", "description": "Original creation time from source (ISO 8601)." }, "modified": { "type": "string", "format": "date-time", "description": "Original last modification time from source (ISO 8601)." }, "payer_snapshot": { "allOf": [ { "$ref": "#/components/schemas/PayerSnapshot" } ], "nullable": true, "description": "Payer/client display snapshot. Object with optional keys: name, email, phone, id_number, organization_name, vat_number, register_number, street_address, zip_code, city, country, tags." }, "receiver_snapshot": { "allOf": [ { "$ref": "#/components/schemas/ReceiverSnapshot" } ], "nullable": true, "description": "Clinic/recipient display snapshot. Object with optional keys: name, street_address, zip_code, city, vat_number, iban, bic." }, "invoice_details_snapshot": { "nullable": true, "description": "Extra invoice details (payment_terms, due_date, remarks, etc.). Any structure." }, "patients_snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/PatientSnapshotItem" }, "nullable": true, "description": "Display-only list of patients. Array of objects with optional name, species, breed, date_of_birth." }, "vat_breakdown": { "nullable": true, "description": "VAT by rate. Array of { rate, name, net, vat, gross } (numbers as string or number)." }, "meta_json": { "nullable": true, "description": "Source-specific metadata. Any structure." }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRowWrite" }, "description": "Line items. Array of { display_order, patient_id?, name, quantity?, unit?, vat_percentage?, price?, total_vat?, total_with_vat?, row_snapshot?, meta_json? }." }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedPaymentWrite" }, "description": "Payments. Array of { payment_date, payment_method_name, amount, currency_code?, is_cancelled?, payment_snapshot?, meta_json? }." } }, "required": [ "client_id", "created", "department_id", "invoice_date", "modified", "source_invoice_id", "source_invoice_number", "total", "total_vat", "total_with_vat" ] }, "BulkImportInvoiceRequest": { "type": "object", "description": "Invoice serializer for bulk import - source is provided by parent serializer.\n\nSkips source validation during initial validation since source comes from\nthe parent BulkImportRequestSerializer context during create().", "properties": { "source_invoice_id": { "type": "string", "minLength": 1, "description": "Original invoice ID from the source system (unique per source).", "maxLength": 100 }, "source_invoice_number": { "type": "string", "minLength": 1, "description": "Human-readable invoice number (e.g. RG-1079).", "maxLength": 100 }, "client_id": { "type": "integer", "description": "Provet client ID (health.Client) for this invoice." }, "patient_ids": { "type": "array", "items": { "type": "integer" }, "description": "Provet patient IDs (health.Patient) linked to this invoice. Optional." }, "supervising_veterinarian_id": { "type": "integer", "nullable": true, "description": "Provet user ID of the supervising veterinarian for this invoice." }, "department_id": { "type": "integer", "description": "Provet department ID (organization.Department)." }, "invoice_date": { "type": "string", "format": "date", "description": "Invoice date (YYYY-MM-DD)." }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true, "description": "When the invoice was finalized (ISO 8601). Optional." }, "currency_code": { "type": "string", "minLength": 1, "default": "EUR", "description": "ISO 4217 currency code (e.g. EUR).", "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total excluding VAT (subtotal)." }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total VAT amount." }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Total including VAT." }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "default": 0.0, "description": "Outstanding balance (due amount)." }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusC54Enum" } ], "default": "FINALIZED", "description": "DRAFT, FINALIZED, PAID, PARTIALLY_PAID, OVERPAID, CANCELLED.\n\n* `DRAFT` - Draft\n* `FINALIZED` - Finalized\n* `PAID` - Paid\n* `PARTIALLY_PAID` - Partially Paid\n* `OVERPAID` - Overpaid\n* `CANCELLED` - Cancelled" }, "is_credit_note": { "type": "boolean", "default": false, "description": "True if this is a credit note." }, "is_countersale": { "type": "boolean", "default": false, "description": "True if countersale." }, "created": { "type": "string", "format": "date-time", "description": "Original creation time from source (ISO 8601)." }, "modified": { "type": "string", "format": "date-time", "description": "Original last modification time from source (ISO 8601)." }, "payer_snapshot": { "allOf": [ { "$ref": "#/components/schemas/PayerSnapshotRequest" } ], "nullable": true, "description": "Payer/client display snapshot. Object with optional keys: name, email, phone, id_number, organization_name, vat_number, register_number, street_address, zip_code, city, country, tags." }, "receiver_snapshot": { "allOf": [ { "$ref": "#/components/schemas/ReceiverSnapshotRequest" } ], "nullable": true, "description": "Clinic/recipient display snapshot. Object with optional keys: name, street_address, zip_code, city, vat_number, iban, bic." }, "invoice_details_snapshot": { "nullable": true, "description": "Extra invoice details (payment_terms, due_date, remarks, etc.). Any structure." }, "patients_snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/PatientSnapshotItemRequest" }, "nullable": true, "description": "Display-only list of patients. Array of objects with optional name, species, breed, date_of_birth." }, "vat_breakdown": { "nullable": true, "description": "VAT by rate. Array of { rate, name, net, vat, gross } (numbers as string or number)." }, "meta_json": { "nullable": true, "description": "Source-specific metadata. Any structure." }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRowWriteRequest" }, "description": "Line items. Array of { display_order, patient_id?, name, quantity?, unit?, vat_percentage?, price?, total_vat?, total_with_vat?, row_snapshot?, meta_json? }." }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedPaymentWriteRequest" }, "description": "Payments. Array of { payment_date, payment_method_name, amount, currency_code?, is_cancelled?, payment_snapshot?, meta_json? }." } }, "required": [ "client_id", "created", "department_id", "invoice_date", "modified", "source_invoice_id", "source_invoice_number", "total", "total_vat", "total_with_vat" ] }, "BulkImportRequest": { "type": "object", "description": "Bulk import request: source, department_id, and a list of invoices.\nEach invoice uses the same shape as a single create; source is taken from here.", "properties": { "source": { "type": "string", "description": "Source system name for all invoices (e.g. VETERA, or custom).", "maxLength": 50 }, "source_file_name": { "type": "string", "nullable": true, "description": "Optional filename (e.g. upload name) for the import.", "maxLength": 255 }, "department_id": { "type": "integer", "description": "Provet department ID for the import job and default for invoices." }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/BulkImportInvoice" }, "description": "List of archived invoices (max 100). Each item has the same shape as a single POST body (source_invoice_id, source_invoice_number, client_id, department_id, invoice_date, totals, snapshots, rows, payments). Source is inherited from this request." } }, "required": [ "department_id", "invoices", "source" ] }, "BulkImportRequestRequest": { "type": "object", "description": "Bulk import request: source, department_id, and a list of invoices.\nEach invoice uses the same shape as a single create; source is taken from here.", "properties": { "source": { "type": "string", "minLength": 1, "description": "Source system name for all invoices (e.g. VETERA, or custom).", "maxLength": 50 }, "source_file_name": { "type": "string", "nullable": true, "description": "Optional filename (e.g. upload name) for the import.", "maxLength": 255 }, "department_id": { "type": "integer", "description": "Provet department ID for the import job and default for invoices." }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/BulkImportInvoiceRequest" }, "description": "List of archived invoices (max 100). Each item has the same shape as a single POST body (source_invoice_id, source_invoice_number, client_id, department_id, invoice_date, totals, snapshots, rows, payments). Source is inherited from this request." } }, "required": [ "department_id", "invoices", "source" ] }, "BundleNavigationSearch": { "type": "object", "description": "A `Serializer` is a model-less serializer class with additional\nsupport for JSON:API spec features.\n\nAs in JSON:API specification a type is always required you need to\nmake sure that you define `resource_name` in your `Meta` class\nwhen deriving from this class.\n\nIncluded Mixins:\n\n* A mixin class to enable sparse fieldsets is included\n* A mixin class to enable validation of included resources is included", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "department_id": { "type": "integer", "nullable": true }, "item_list_id": { "type": "integer", "nullable": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000000, "minimum": -1000000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price_fixed": { "type": "number", "format": "double", "maximum": 1000000000000000000, "minimum": -1000000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price_starting_from": { "type": "number", "format": "double", "maximum": 1000000000000000000, "minimum": -1000000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "highlight": {} }, "required": [ "id", "name" ] }, "CanCancelReasonEnum": { "enum": [ "already_cancelled", "unsupported_status", "unsupported_payment_method" ], "type": "string", "description": "* `already_cancelled` - Already Cancelled\n* `unsupported_status` - Unsupported Status\n* `unsupported_payment_method` - Unsupported Payment Method" }, "CanceledEnum": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "* `1` - Death\n* `2` - Missing payments\n* `3` - Other\n* `4` - Chargeback\n* `5` - Patient archived\n* `6` - Cancelled by the client" }, "CancellationReason": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "department": { "type": "string", "format": "uri" }, "archived": { "type": "boolean" }, "mapping": { "allOf": [ { "$ref": "#/components/schemas/MappingEnum" } ], "minimum": 0, "maximum": 65535 }, "external": { "type": "boolean" } }, "required": [ "department", "id", "name", "url" ] }, "CancellationReasonRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "department": { "type": "string", "format": "uri" }, "archived": { "type": "boolean" }, "mapping": { "allOf": [ { "$ref": "#/components/schemas/MappingEnum" } ], "minimum": 0, "maximum": 65535 }, "external": { "type": "boolean" } }, "required": [ "department", "name" ] }, "CashBookEntry": { "type": "object", "description": "Flat CashBookEntry payload for the EFSTA tentacle.\n\nExposes the fields required to build a Kassenbewegung signing\nreceipt. No writes are accepted; the JSON:API viewset owns\ncreation.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "cash_register": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri", "readOnly": true }, "movement_type": { "allOf": [ { "$ref": "#/components/schemas/MovementTypeEnum" } ], "readOnly": true }, "amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "description": { "type": "string", "readOnly": true }, "invoice_number": { "type": "string", "readOnly": true }, "notes": { "type": "string", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "booking_id": { "type": "integer", "readOnly": true, "nullable": true }, "payment_method": { "type": "integer", "readOnly": true }, "fiscal_registration_status": { "type": "integer", "readOnly": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "amount", "booking_id", "cash_register", "created", "department", "description", "fiscal_registration_status", "id", "invoice_number", "modified", "movement_type", "notes", "payment_method", "timestamp", "url" ] }, "CatalogItemExportStartRequest": { "type": "object", "description": "Async export start request — filters plus explicit department.", "properties": { "ids": { "type": "array", "items": { "type": "integer" } }, "search": { "type": "string", "default": "" }, "item_type": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTypeEnum" } }, "subgroup_ids": { "type": "array", "items": { "type": "integer" } }, "item_category_ids": { "type": "array", "items": { "type": "integer" } }, "wholesaler_ids": { "type": "array", "items": { "type": "integer" } }, "archived": { "type": "boolean", "nullable": true, "default": false }, "external_item_lists": { "type": "boolean", "nullable": true }, "is_external_lab": { "type": "boolean", "nullable": true }, "modified_from": { "type": "string", "format": "date-time", "nullable": true }, "modified_to": { "type": "string", "format": "date-time", "nullable": true }, "department_id": { "type": "integer" } }, "required": [ "department_id" ] }, "CatalogItemExportStartResponse": { "type": "object", "description": "Response body for the async export start action.", "properties": { "task_id": { "type": "string", "readOnly": true } }, "required": [ "task_id" ] }, "CatalogItemExportStatusResponse": { "type": "object", "description": "Response body for the async export status poll.", "properties": { "task_id": { "type": "string", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/CatalogItemExportStatusResponseStatusEnum" } ], "readOnly": true }, "completed_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true, "description": "Set when status is 'completed' or 'failed'." }, "download_url": { "type": "string", "format": "uri", "readOnly": true, "nullable": true, "description": "Set when status is 'completed'. Short-lived URL pointing at the generated XLSX file." }, "reason": { "type": "string", "readOnly": true, "nullable": true, "description": "Set when status is 'failed'. Human-readable failure reason." } }, "required": [ "completed_at", "download_url", "reason", "status", "task_id" ] }, "CatalogItemExportStatusResponseStatusEnum": { "enum": [ "processing", "completed", "failed" ], "type": "string", "description": "* `processing` - processing\n* `completed` - completed\n* `failed` - failed" }, "CatalogItemExportThrottledResponse": { "type": "object", "description": "Response body when a start is refused because an export is already running.\n\n``task_id`` is the in-flight export's id so a racing or retrying caller can\nconverge on it by polling ``/status/`` instead of hitting a dead-end.", "properties": { "detail": { "type": "string", "readOnly": true }, "task_id": { "type": "string", "readOnly": true, "nullable": true, "description": "The in-progress export's task_id. Null only if that export just finished between the throttle check and this response." } }, "required": [ "detail", "task_id" ] }, "CatalogProcessedAvailableWholesaler": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of your registered `AvailableWholesaler`." }, "name": { "type": "string", "description": "Name of that `AvailableWholesaler`." } }, "required": [ "id", "name" ] }, "CatalogProcessedError": { "type": "object", "properties": { "row": { "type": "integer", "nullable": true, "description": "1-based line in your file, `null` for a problem with the file as a whole." }, "code": { "type": "string", "description": "Machine-readable reason." }, "field": { "type": "string", "nullable": true, "description": "Offending column, when the reason names one." }, "detail": { "type": "string", "description": "Human-readable explanation." } }, "required": [ "code", "detail", "field", "row" ] }, "CatalogProcessedErrorSummary": { "type": "object", "properties": { "code": { "type": "string" }, "field": { "type": "string", "nullable": true }, "count": { "type": "integer", "description": "Exact number of rows with this reason." } }, "required": [ "code", "count", "field" ] }, "CatalogProcessedEvent": { "type": "object", "description": "Provet finished validating a catalog you uploaded.", "properties": { "event": { "type": "string", "enum": [ "catalog.processed" ], "description": "Always `\"catalog.processed\"`." }, "event_id": { "type": "string", "format": "uuid", "description": "Identifies this event, unchanged across all delivery attempts of it. Use it to discard redundant deliveries." }, "available_wholesaler": { "$ref": "#/components/schemas/CatalogProcessedAvailableWholesaler" }, "wholesaler": { "$ref": "#/components/schemas/CatalogProcessedWholesaler" }, "upload": { "$ref": "#/components/schemas/CatalogProcessedUpload" } }, "required": [ "available_wholesaler", "event", "event_id", "upload", "wholesaler" ] }, "CatalogProcessedUpload": { "type": "object", "properties": { "id": { "type": "integer", "description": "The `upload_id` you were given." }, "catalog_id": { "type": "string", "format": "uuid", "description": "The `catalog_id` you were given when requesting the upload URL." }, "filename": { "type": "string", "description": "The filename you supplied." }, "status": { "enum": [ "accepted", "partially_accepted", "rejected" ], "type": "string", "description": "`rejected` means no usable product came out of the file, so the clinic's previous catalog is untouched.\n\n* `accepted` - accepted\n* `partially_accepted` - partially_accepted\n* `rejected` - rejected" }, "rows_total": { "type": "integer", "description": "Data rows read, excluding header." }, "rows_accepted": { "type": "integer", "description": "Rows that became importable products." }, "rows_rejected": { "type": "integer", "description": "Rows dropped, with a reason." }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogProcessedError" }, "nullable": true, "description": "Every rejected row, or `null` when there were too many to send. Never a partial list." }, "errors_truncated": { "type": "boolean", "description": "`true` when `errors` is withheld; use `error_summary` and `error_report_url` instead." }, "error_summary": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogProcessedErrorSummary" }, "nullable": true, "description": "Exact per-reason counts, sent only when `errors` is withheld." }, "error_report_url": { "type": "string", "nullable": true, "description": "Pre-signed download of the complete error list, sent only when `errors` is withheld. Valid for 7 days." } }, "required": [ "catalog_id", "error_report_url", "error_summary", "errors", "errors_truncated", "filename", "id", "rows_accepted", "rows_rejected", "rows_total", "status" ] }, "CatalogProcessedWholesaler": { "type": "object", "properties": { "id": { "type": "integer", "description": "The `wholesaler_pk` the catalog was uploaded against, as received in `wholesaler.created`." } }, "required": [ "id" ] }, "Category8beEnum": { "enum": [ 0, 1 ], "type": "integer", "description": "* `0` - Primary\n* `1` - Secondary" }, "CategoryFd9Enum": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "* `0` - ---------\n* `1` - Surgery\n* `2` - Sedation\n* `3` - Recovery\n* `4` - Anesthesia\n* `5` - Monitoring\n* `6` - Imaging" }, "ChannelEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Clinic\n* `2` - Online" }, "Client": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri", "readOnly": true, "description": "URL to this client resource" }, "title": { "type": "string", "nullable": true, "description": "Title or honorific (e.g., Dr., Mr., Mrs.)", "maxLength": 32 }, "firstname": { "type": "string", "title": "First name", "description": "Client's first name", "maxLength": 127 }, "lastname": { "type": "string", "title": "Last name", "description": "Client's last name", "maxLength": 127 }, "organization_name": { "type": "string", "nullable": true, "description": "Name of organization (for company clients)", "maxLength": 127 }, "customer_type": { "allOf": [ { "$ref": "#/components/schemas/CustomerTypeEnum" } ], "description": "Customer type: 0=Private person, 1=Company, 2=EU Company, 3=Charitable organization, 4=UK charity\n\n* `0` - Private person\n* `1` - Company\n* `2` - EU Company\n* `3` - Charitable organization\n* `4` - UK charity", "minimum": -2147483648, "maximum": 2147483647 }, "vat_number": { "type": "string", "description": "VAT/Tax identification number", "maxLength": 31 }, "register_number": { "type": "string", "nullable": true, "description": "Business register number", "maxLength": 31 }, "home_department": { "type": "string", "format": "uri", "nullable": true, "description": "URL to primary department this client belongs to" }, "due_date_delay": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "Number of days to delay invoice due date (can be negative)" }, "street_address": { "type": "string", "description": "Primary street address line", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "title": "Second address line", "description": "Second street address line (optional)", "maxLength": 255 }, "street_address_3": { "type": "string", "nullable": true, "title": "Third address line", "description": "Third street address line (optional)", "maxLength": 255 }, "zip_code": { "type": "string", "title": "Post code", "description": "Postal code", "maxLength": 12 }, "city": { "type": "string", "description": "City name", "maxLength": 63 }, "state": { "nullable": true, "description": "US state (for US addresses)\n\n* `AL` - Alabama\n* `AK` - Alaska\n* `AS` - American Samoa\n* `AZ` - Arizona\n* `AR` - Arkansas\n* `AA` - Armed Forces Americas\n* `AE` - Armed Forces Europe\n* `AP` - Armed Forces Pacific\n* `CA` - California\n* `CO` - Colorado\n* `CT` - Connecticut\n* `DE` - Delaware\n* `DC` - District of Columbia\n* `FL` - Florida\n* `GA` - Georgia\n* `GU` - Guam\n* `HI` - Hawaii\n* `ID` - Idaho\n* `IL` - Illinois\n* `IN` - Indiana\n* `IA` - Iowa\n* `KS` - Kansas\n* `KY` - Kentucky\n* `LA` - Louisiana\n* `ME` - Maine\n* `MD` - Maryland\n* `MA` - Massachusetts\n* `MI` - Michigan\n* `MN` - Minnesota\n* `MS` - Mississippi\n* `MO` - Missouri\n* `MT` - Montana\n* `NE` - Nebraska\n* `NV` - Nevada\n* `NH` - New Hampshire\n* `NJ` - New Jersey\n* `NM` - New Mexico\n* `NY` - New York\n* `NC` - North Carolina\n* `ND` - North Dakota\n* `MP` - Northern Mariana Islands\n* `OH` - Ohio\n* `OK` - Oklahoma\n* `OR` - Oregon\n* `PA` - Pennsylvania\n* `PR` - Puerto Rico\n* `RI` - Rhode Island\n* `SC` - South Carolina\n* `SD` - South Dakota\n* `TN` - Tennessee\n* `TX` - Texas\n* `UT` - Utah\n* `VT` - Vermont\n* `VI` - Virgin Islands\n* `VA` - Virginia\n* `WA` - Washington\n* `WV` - West Virginia\n* `WI` - Wisconsin\n* `WY` - Wyoming", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, US-CA)", "maxLength": 100 }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Primary email address", "maxLength": 254 }, "alt_emails": { "type": "string", "nullable": true, "title": "Additional emails", "description": "Additional email addresses (comma-separated)", "maxLength": 127 }, "id_number": { "type": "string", "description": "Client ID/customer number", "maxLength": 63 }, "old_client_id": { "type": "string", "nullable": true, "description": "Legacy client ID from previous system", "maxLength": 32 }, "critical_notes": { "type": "string", "nullable": true, "description": "Critical notes displayed prominently (max 255 chars)", "maxLength": 255 }, "critical_accounting_notes": { "type": "string", "nullable": true, "description": "Critical accounting notes (max 255 chars)", "maxLength": 255 }, "remarks": { "type": "string", "nullable": true, "description": "General remarks and notes (no length limit)" }, "archived": { "type": "boolean", "description": "True if client is archived/inactive" }, "country": { "nullable": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US).\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe", "oneOf": [ { "$ref": "#/components/schemas/CountryEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "no_sms": { "type": "boolean", "title": "Disable SMS sending", "description": "True if SMS sending is disabled for this client" }, "no_email": { "type": "boolean", "title": "Disable email sending", "description": "True if email sending is disabled for this client" }, "external": { "type": "boolean", "description": "True if client is external (not a regular customer)" }, "referring_organization": { "type": "boolean", "description": "True if this client is a referring organization" }, "parent_referring_organization": { "type": "string", "format": "uri", "nullable": true, "description": "URL to parent organization this referring vet belongs to" }, "breeder": { "type": "boolean" }, "referring_vet": { "type": "boolean", "title": "Referring veterinarian", "description": "True if this client is a referring veterinarian" }, "imported": { "type": "boolean", "description": "True if client was imported from another system" }, "date_imported": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when client was imported" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to patients owned by this client" }, "invoicing_client": { "type": "string", "format": "uri", "nullable": true, "description": "URL to another client who receives invoices for this client" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when client was created" }, "created_user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to user who created this client" }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when client was last modified" }, "modified_user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to user who last modified this client" }, "phone_numbers": { "type": "array", "items": {}, "readOnly": true }, "status_type": { "allOf": [ { "$ref": "#/components/schemas/StatusTypeEnum" } ], "title": "Client status", "description": "Client status: 0=Internal, 1=Research, 2=External\n\n* `0` - Internal\n* `1` - Research\n* `2` - External", "minimum": -2147483648, "maximum": 2147483647 }, "fields_rel": { "type": "array", "items": {} }, "farm_code": { "type": "string", "nullable": true, "title": "Unique farm code", "description": "Unique farm identification code", "maxLength": 31 }, "holdingplacenumbers": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "communication_preferences": { "type": "string", "format": "uri", "readOnly": true }, "production_animal_client": { "type": "boolean", "description": "True if client owns production animals (farm animals)" }, "einvoice_address": { "type": "string", "nullable": true, "title": "E-invoice electronic address", "description": "Electronic invoice address (e-invoicing)", "maxLength": 100 }, "einvoice_operator": { "type": "string", "nullable": true, "title": "E-invoice operator identifier", "description": "Electronic invoice operator identifier", "maxLength": 100 }, "alternative_payer": { "type": "string", "format": "uri", "nullable": true, "description": "URL to alternative payer for invoices (e.g., insurance company)" }, "secondary_owner_first_name": { "type": "string", "description": "First name of secondary owner/contact person", "maxLength": 127 }, "secondary_owner_last_name": { "type": "string", "description": "Last name of secondary owner/contact person", "maxLength": 127 }, "on_stop": { "type": "boolean", "description": "True if client is on stop (blocked from receiving services)" }, "has_alive_patients": { "type": "boolean", "description": "True if client has at least one non-deceased patient" }, "gender": { "nullable": true, "description": "Client gender: 1=Male, 2=Female, 3=Other\n\n* `1` - Male\n* `2` - Female\n* `3` - Other", "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/ClientGenderEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Client's date of birth (YYYY-MM-DD)" }, "drivers_licence_number": { "type": "string", "title": "Driver's license number", "description": "Driver's license number", "maxLength": 31 } }, "required": [ "communication_preferences", "created", "holdingplacenumbers", "modified", "patients", "phone_numbers", "url" ] }, "ClientCommunicationPreferenceRow": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "sms": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "post": { "type": "boolean" }, "client_preferences": { "type": "string", "format": "uri" }, "organization_preference_row": { "type": "string", "format": "uri" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client_preferences", "created", "id", "modified", "organization_preference_row" ] }, "ClientCommunicationPreferenceRowRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "sms": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "post": { "type": "boolean" }, "client_preferences": { "type": "string", "format": "uri" }, "organization_preference_row": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client_preferences", "organization_preference_row" ] }, "ClientCommunicationPreferences": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "valid_from": { "type": "string", "format": "date" }, "valid_to": { "type": "string", "format": "date" }, "privacy_policy_version": { "type": "string", "nullable": true }, "consent_given": { "allOf": [ { "$ref": "#/components/schemas/ConsentGivenEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "preference_rows": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consent_given", "created", "id", "modified", "preference_rows", "valid_from", "valid_to" ] }, "ClientCommunicationPreferencesRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri", "nullable": true }, "valid_from": { "type": "string", "format": "date" }, "valid_to": { "type": "string", "format": "date" }, "privacy_policy_version": { "type": "string", "nullable": true }, "consent_given": { "allOf": [ { "$ref": "#/components/schemas/ConsentGivenEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "preference_rows": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consent_given", "preference_rows", "valid_from", "valid_to" ] }, "ClientExportDoneResponse": { "type": "object", "properties": { "status": { "type": "string" }, "snapshot_cutoff": { "type": "string" }, "row_count": { "type": "integer" }, "download_url": { "type": "string" } }, "required": [ "download_url", "row_count", "snapshot_cutoff", "status" ] }, "ClientExportFailedResponse": { "type": "object", "properties": { "status": { "type": "string" }, "error": { "type": "string" } }, "required": [ "error", "status" ] }, "ClientExportRunningResponse": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "ClientExportStatusResponse": { "oneOf": [ { "$ref": "#/components/schemas/ClientExportRunningResponse" }, { "$ref": "#/components/schemas/ClientExportDoneResponse" }, { "$ref": "#/components/schemas/ClientExportFailedResponse" } ] }, "ClientExportTriggerResponse": { "type": "object", "properties": { "export_id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "export_id", "status" ] }, "ClientGenderEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Male\n* `2` - Female\n* `3` - Other" }, "ClientHoldingPlace": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "client": { "type": "string", "format": "uri" }, "holding_place_number": { "type": "string", "maxLength": 31 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "client", "holding_place_number", "id", "patients", "url" ] }, "ClientHoldingPlaceRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "holding_place_number": { "type": "string", "minLength": 1, "maxLength": 31 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "client", "holding_place_number", "patients" ] }, "ClientRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer" }, "title": { "type": "string", "nullable": true, "description": "Title or honorific (e.g., Dr., Mr., Mrs.)", "maxLength": 32 }, "firstname": { "type": "string", "title": "First name", "description": "Client's first name", "maxLength": 127 }, "lastname": { "type": "string", "title": "Last name", "description": "Client's last name", "maxLength": 127 }, "organization_name": { "type": "string", "nullable": true, "description": "Name of organization (for company clients)", "maxLength": 127 }, "customer_type": { "allOf": [ { "$ref": "#/components/schemas/CustomerTypeEnum" } ], "description": "Customer type: 0=Private person, 1=Company, 2=EU Company, 3=Charitable organization, 4=UK charity\n\n* `0` - Private person\n* `1` - Company\n* `2` - EU Company\n* `3` - Charitable organization\n* `4` - UK charity", "minimum": -2147483648, "maximum": 2147483647 }, "vat_number": { "type": "string", "description": "VAT/Tax identification number", "maxLength": 31 }, "register_number": { "type": "string", "nullable": true, "description": "Business register number", "maxLength": 31 }, "home_department": { "type": "string", "format": "uri", "nullable": true, "description": "URL to primary department this client belongs to" }, "due_date_delay": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "Number of days to delay invoice due date (can be negative)" }, "street_address": { "type": "string", "description": "Primary street address line", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "title": "Second address line", "description": "Second street address line (optional)", "maxLength": 255 }, "street_address_3": { "type": "string", "nullable": true, "title": "Third address line", "description": "Third street address line (optional)", "maxLength": 255 }, "zip_code": { "type": "string", "title": "Post code", "description": "Postal code", "maxLength": 12 }, "city": { "type": "string", "description": "City name", "maxLength": 63 }, "state": { "nullable": true, "description": "US state (for US addresses)\n\n* `AL` - Alabama\n* `AK` - Alaska\n* `AS` - American Samoa\n* `AZ` - Arizona\n* `AR` - Arkansas\n* `AA` - Armed Forces Americas\n* `AE` - Armed Forces Europe\n* `AP` - Armed Forces Pacific\n* `CA` - California\n* `CO` - Colorado\n* `CT` - Connecticut\n* `DE` - Delaware\n* `DC` - District of Columbia\n* `FL` - Florida\n* `GA` - Georgia\n* `GU` - Guam\n* `HI` - Hawaii\n* `ID` - Idaho\n* `IL` - Illinois\n* `IN` - Indiana\n* `IA` - Iowa\n* `KS` - Kansas\n* `KY` - Kentucky\n* `LA` - Louisiana\n* `ME` - Maine\n* `MD` - Maryland\n* `MA` - Massachusetts\n* `MI` - Michigan\n* `MN` - Minnesota\n* `MS` - Mississippi\n* `MO` - Missouri\n* `MT` - Montana\n* `NE` - Nebraska\n* `NV` - Nevada\n* `NH` - New Hampshire\n* `NJ` - New Jersey\n* `NM` - New Mexico\n* `NY` - New York\n* `NC` - North Carolina\n* `ND` - North Dakota\n* `MP` - Northern Mariana Islands\n* `OH` - Ohio\n* `OK` - Oklahoma\n* `OR` - Oregon\n* `PA` - Pennsylvania\n* `PR` - Puerto Rico\n* `RI` - Rhode Island\n* `SC` - South Carolina\n* `SD` - South Dakota\n* `TN` - Tennessee\n* `TX` - Texas\n* `UT` - Utah\n* `VT` - Vermont\n* `VI` - Virgin Islands\n* `VA` - Virginia\n* `WA` - Washington\n* `WV` - West Virginia\n* `WI` - Wisconsin\n* `WY` - Wyoming", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, US-CA)", "maxLength": 100 }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Primary email address", "maxLength": 254 }, "alt_emails": { "type": "string", "nullable": true, "title": "Additional emails", "description": "Additional email addresses (comma-separated)", "maxLength": 127 }, "id_number": { "type": "string", "description": "Client ID/customer number", "maxLength": 63 }, "old_client_id": { "type": "string", "nullable": true, "description": "Legacy client ID from previous system", "maxLength": 32 }, "critical_notes": { "type": "string", "nullable": true, "description": "Critical notes displayed prominently (max 255 chars)", "maxLength": 255 }, "critical_accounting_notes": { "type": "string", "nullable": true, "description": "Critical accounting notes (max 255 chars)", "maxLength": 255 }, "remarks": { "type": "string", "nullable": true, "description": "General remarks and notes (no length limit)" }, "archived": { "type": "boolean", "description": "True if client is archived/inactive" }, "country": { "nullable": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US).\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe", "oneOf": [ { "$ref": "#/components/schemas/CountryEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "no_sms": { "type": "boolean", "title": "Disable SMS sending", "description": "True if SMS sending is disabled for this client" }, "no_email": { "type": "boolean", "title": "Disable email sending", "description": "True if email sending is disabled for this client" }, "external": { "type": "boolean", "description": "True if client is external (not a regular customer)" }, "referring_organization": { "type": "boolean", "description": "True if this client is a referring organization" }, "parent_referring_organization": { "type": "string", "format": "uri", "nullable": true, "description": "URL to parent organization this referring vet belongs to" }, "breeder": { "type": "boolean" }, "referring_vet": { "type": "boolean", "title": "Referring veterinarian", "description": "True if this client is a referring veterinarian" }, "imported": { "type": "boolean", "description": "True if client was imported from another system" }, "date_imported": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when client was imported" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to patients owned by this client" }, "invoicing_client": { "type": "string", "format": "uri", "nullable": true, "description": "URL to another client who receives invoices for this client" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to user who created this client" }, "modified_user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to user who last modified this client" }, "status_type": { "allOf": [ { "$ref": "#/components/schemas/StatusTypeEnum" } ], "title": "Client status", "description": "Client status: 0=Internal, 1=Research, 2=External\n\n* `0` - Internal\n* `1` - Research\n* `2` - External", "minimum": -2147483648, "maximum": 2147483647 }, "fields_rel": { "type": "array", "items": {} }, "farm_code": { "type": "string", "nullable": true, "title": "Unique farm code", "description": "Unique farm identification code", "maxLength": 31 }, "production_animal_client": { "type": "boolean", "description": "True if client owns production animals (farm animals)" }, "einvoice_address": { "type": "string", "nullable": true, "title": "E-invoice electronic address", "description": "Electronic invoice address (e-invoicing)", "maxLength": 100 }, "einvoice_operator": { "type": "string", "nullable": true, "title": "E-invoice operator identifier", "description": "Electronic invoice operator identifier", "maxLength": 100 }, "alternative_payer": { "type": "string", "format": "uri", "nullable": true, "description": "URL to alternative payer for invoices (e.g., insurance company)" }, "secondary_owner_first_name": { "type": "string", "description": "First name of secondary owner/contact person", "maxLength": 127 }, "secondary_owner_last_name": { "type": "string", "description": "Last name of secondary owner/contact person", "maxLength": 127 }, "on_stop": { "type": "boolean", "description": "True if client is on stop (blocked from receiving services)" }, "has_alive_patients": { "type": "boolean", "description": "True if client has at least one non-deceased patient" }, "gender": { "nullable": true, "description": "Client gender: 1=Male, 2=Female, 3=Other\n\n* `1` - Male\n* `2` - Female\n* `3` - Other", "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/ClientGenderEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Client's date of birth (YYYY-MM-DD)" }, "drivers_licence_number": { "type": "string", "title": "Driver's license number", "description": "Driver's license number", "maxLength": 31 } }, "required": [ "patients" ] }, "ClientWithPatientNavigationSearch": { "type": "object", "description": "A `Serializer` is a model-less serializer class with additional\nsupport for JSON:API spec features.\n\nAs in JSON:API specification a type is always required you need to\nmake sure that you define `resource_name` in your `Meta` class\nwhen deriving from this class.\n\nIncluded Mixins:\n\n* A mixin class to enable sparse fieldsets is included\n* A mixin class to enable validation of included resources is included", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "address": { "type": "string" }, "emails": { "type": "array", "items": { "type": "string" } }, "phone_numbers": { "type": "array", "items": { "type": "string" } }, "patients": { "type": "array", "items": { "$ref": "#/components/schemas/NestedPatientNavigationSearch" } }, "highlight": {}, "id_number": { "type": "string", "default": "" }, "organization_name": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "secondary_owner_name": { "type": "string", "nullable": true }, "secondary_owner_phone_numbers": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "required": [ "address", "emails", "first_name", "id", "last_name", "patients", "phone_numbers" ] }, "ClinicalSign": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "clinical_sign": { "type": "string", "format": "uri" }, "category": { "allOf": [ { "$ref": "#/components/schemas/Category8beEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "code": { "type": "string", "maxLength": 20 }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "clinical_sign", "code", "consultation", "created", "id", "modified", "name", "patient" ] }, "CloudPrinter": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "apitype": { "allOf": [ { "$ref": "#/components/schemas/ApitypeEnum" } ], "title": "API type", "minimum": 0, "maximum": 65535 }, "label": { "type": "string", "title": "Name/Designation", "maxLength": 255 }, "username": { "type": "string", "title": "API username", "maxLength": 255 }, "department": { "type": "string", "format": "uri" }, "last_seen": { "type": "string", "format": "date-time", "nullable": true, "title": "Last online" }, "archived": { "type": "boolean" } }, "required": [ "apitype", "department", "id", "label", "url", "username" ] }, "CodeEnum": { "enum": [ "species:dog", "species:cat", "species:horse", "species:rabbit", "species:pig", "species:sheep", "species:goat", "species:bird", "species:fish", "species:hedgehog", "species:ferret", "species:turtle", "species:snake", "species:lizard", "species:guinea_pig", "species:rat", "species:mouse", "species:cow", "species:hamster", "species:other", "clinical_note:anamnesis" ], "type": "string", "description": "* `species:dog` - Dog\n* `species:cat` - Cat\n* `species:horse` - Horse\n* `species:rabbit` - Rabbit\n* `species:pig` - Pig\n* `species:sheep` - Sheep\n* `species:goat` - Goat\n* `species:bird` - Bird\n* `species:fish` - Fish\n* `species:hedgehog` - Hedgehog\n* `species:ferret` - Ferret\n* `species:turtle` - Turtle\n* `species:snake` - Snake\n* `species:lizard` - Lizard\n* `species:guinea_pig` - Guinea pig\n* `species:rat` - Rat\n* `species:mouse` - Mouse\n* `species:cow` - Cow\n* `species:hamster` - Hamster\n* `species:other` - Other\n* `clinical_note:anamnesis` - Anamnesis" }, "CodeSystemEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Custom\n* `2` - Venom" }, "CombinedAppointment": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "start": { "type": "string", "format": "date-time", "readOnly": true }, "end": { "type": "string", "format": "date-time", "readOnly": true }, "department_id": { "type": "integer", "readOnly": true, "nullable": true }, "complaint": { "type": "string", "readOnly": true, "nullable": true }, "client_id": { "type": "integer", "readOnly": true, "nullable": true }, "onlinebookingclient_id": { "type": "integer", "readOnly": true, "nullable": true }, "patient_id": { "type": "integer", "readOnly": true, "nullable": true }, "onlinebookingpatient_id": { "type": "integer", "readOnly": true, "nullable": true }, "patient_name": { "type": "string", "readOnly": true, "nullable": true }, "patient_species_master_code": { "type": "string", "readOnly": true, "nullable": true }, "species_id": { "type": "integer", "readOnly": true, "nullable": true }, "reason_id": { "type": "integer", "readOnly": true, "nullable": true }, "price": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "price_starting_from": { "type": "boolean", "readOnly": true, "nullable": true }, "prepayment_amount": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "resources": { "type": "array", "items": { "$ref": "#/components/schemas/CombinedAppointmentResource" }, "readOnly": true }, "provet_specialist_id": { "type": "integer", "readOnly": true, "nullable": true }, "specialist_name": { "type": "string", "readOnly": true, "nullable": true } }, "required": [ "client_id", "complaint", "department_id", "end", "id", "onlinebookingclient_id", "onlinebookingpatient_id", "patient_id", "patient_name", "patient_species_master_code", "prepayment_amount", "price", "price_starting_from", "provet_specialist_id", "reason_id", "resources", "specialist_name", "species_id", "start" ] }, "CombinedAppointmentResource": { "type": "object", "properties": { "provet_resource_id": { "type": "integer", "readOnly": true, "nullable": true }, "resource_name": { "type": "string", "readOnly": true, "nullable": true } }, "required": [ "provet_resource_id", "resource_name" ] }, "CommunicationPreferenceRow": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "active": { "type": "boolean" }, "editable": { "type": "boolean" }, "sms": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "post": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "id", "modified", "name" ] }, "CommunicationPreferenceRowRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "active": { "type": "boolean" }, "editable": { "type": "boolean" }, "sms": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "post": { "type": "boolean" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "name" ] }, "ConditionalPriceOverride": { "type": "object", "properties": { "id": { "type": "integer" }, "rule": { "type": "integer" }, "item": { "type": "integer" }, "no_effect": { "type": "boolean" }, "value": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true } }, "required": [ "rule", "value" ] }, "ConditionalPriceOverrideRequest": { "type": "object", "properties": { "id": { "type": "integer" }, "rule": { "type": "integer" }, "item": { "type": "integer" }, "no_effect": { "type": "boolean" }, "value": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true } }, "required": [ "rule", "value" ] }, "ConsentGivenEnum": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `1` - Face to face\n* `2` - Over email\n* `3` - Carried over from legacy system\n* `4` - Over telephone\n* `5` - Self-service" }, "Consultation": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true, "description": "Unique consultation ID" }, "url": { "type": "string", "format": "uri", "readOnly": true, "description": "URL to this consultation resource" }, "client": { "type": "string", "format": "uri", "description": "URL to client associated with this consultation" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to patients being treated in this consultation" }, "complaint": { "type": "string", "nullable": true, "description": "Chief complaint or reason for consultation", "maxLength": 255 }, "complaint_type": { "type": "string", "format": "uri", "nullable": true, "description": "URL to structured complaint type classification" }, "admitted_time": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when patient was admitted" }, "first_entry": { "type": "string", "format": "date-time", "nullable": true, "description": "Time of first clinical entry" }, "started": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation officially started" }, "finished": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation was finished" }, "ended": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation was ended/closed" }, "status": { "nullable": true, "description": "Consultation status (open, in progress, completed, etc.)\n\n* `0` - Checked in\n* `8` - In progress\n* `5` - Ready for discharge\n* `7` - Invoicing\n* `6` - Discharged\n* `9` - Invoice paid\n* `10` - Finalized\n* `11` - Draft", "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status9c9Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type2a8Enum" } ], "description": "Type of consultation (standard, emergency, follow-up, etc.)\n\n* `1` - Outpatient\n* `0` - Inpatient\n* `2` - Home call\n* `3` - Farm visit\n* `4` - Boarding\n* `5` - Pet service", "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "string", "format": "uri" }, "supervising_veterinarian": { "type": "string", "format": "uri", "description": "URL to veterinarian supervising/performing consultation" }, "department": { "type": "string", "format": "uri", "description": "URL to department where consultation took place" }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to items used/administered (medications, procedures, etc.)" }, "reporting_dimension_1": { "type": "string", "description": "Reporting dimension 1 id can be found on active Reporting dimension 1 list" }, "reporting_dimension_2": { "type": "string", "description": "Reporting dimension 2 id can be found on active Reporting dimension 2 list" }, "reporting_dimension_3": { "type": "string", "description": "Reporting dimension 3 id can be found on active Reporting dimension 3 list" }, "consultation_notes": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_diagnosis": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_dischargeinstructions": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_patient_status": { "type": "array", "items": { "type": "string", "format": "uri" } }, "triage": { "type": "string", "format": "uri", "description": "URL to triage assessment and priority level" }, "external_sent": { "type": "string", "format": "date-time", "nullable": true, "description": "True if consultation was sent to external system" }, "ward": { "type": "string", "format": "uri" }, "patient_location": { "type": "string", "format": "uri" }, "integration_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "Status of integration with external systems" }, "holding_place_number": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "URL to holding place number for production animal consultation" }, "report_to_authorities": { "type": "boolean", "description": "True if consultation should be reported to authorities" }, "consultation_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true, "description": "URL to additional consultation data for export/import" }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when consultation was created" }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when consultation was last modified" }, "custom_fields": { "type": "string" }, "referring_organization": { "type": "string", "format": "uri", "nullable": true, "description": "URL to organization that referred this consultation" }, "referring_vet": { "type": "string", "format": "uri", "nullable": true, "description": "URL to veterinarian who referred this consultation" } }, "required": [ "client", "consultation_diagnosis", "consultation_dischargeinstructions", "consultation_extras", "consultation_items", "consultation_notes", "consultation_patient_status", "created", "custom_fields", "department", "holding_place_number", "id", "invoice", "modified", "patient_location", "patients", "supervising_veterinarian", "triage", "type", "url", "ward" ] }, "ConsultationAntibiotic": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "antibiotic": { "type": "string", "format": "uri" }, "consultation_organism": { "type": "string", "format": "uri" }, "panel": { "type": "string", "format": "uri", "nullable": true }, "resistant": { "type": "boolean" }, "intermediate": { "type": "boolean" }, "sensitive": { "type": "boolean" }, "mic": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true } }, "required": [ "antibiotic", "consultation_organism", "created", "created_user", "id", "modified", "modified_user", "name", "url" ] }, "ConsultationAntibioticPanel": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "antibiotic_panel": { "type": "string", "format": "uri" }, "consultation_organism": { "type": "string", "format": "uri", "nullable": true }, "consultation_antibiotics": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true } }, "required": [ "antibiotic_panel", "consultation_antibiotics", "created", "created_user", "id", "modified", "modified_user", "name", "url" ] }, "ConsultationAntibioticPanelRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "antibiotic_panel": { "type": "string", "format": "uri" }, "consultation_organism": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "antibiotic_panel" ] }, "ConsultationAntibioticRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "antibiotic": { "type": "string", "format": "uri" }, "consultation_organism": { "type": "string", "format": "uri" }, "panel": { "type": "string", "format": "uri", "nullable": true }, "resistant": { "type": "boolean" }, "intermediate": { "type": "boolean" }, "sensitive": { "type": "boolean" }, "mic": { "type": "string", "nullable": true } }, "required": [ "antibiotic", "consultation_organism" ] }, "ConsultationCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "reporting_dimension_1": { "type": "string", "description": "Reporting dimension 1 id can be found on active Reporting dimension 1 list" }, "reporting_dimension_2": { "type": "string", "description": "Reporting dimension 2 id can be found on active Reporting dimension 2 list" }, "reporting_dimension_3": { "type": "string", "description": "Reporting dimension 3 id can be found on active Reporting dimension 3 list" }, "invoice": { "type": "string", "format": "uri" }, "consultation_notes": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_diagnosis": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_dischargeinstructions": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_patient_status": { "type": "array", "items": { "type": "string", "format": "uri" } }, "ward": { "type": "string", "format": "uri" }, "patient_location": { "type": "string", "format": "uri" }, "consultation_extras": { "$ref": "#/components/schemas/ConsultationExtras" }, "id": { "type": "integer" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Type2a8Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "patient_type": { "allOf": [ { "$ref": "#/components/schemas/PatientTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "complaint": { "type": "string", "nullable": true, "maxLength": 255 }, "admitted_time": { "type": "string", "format": "date-time", "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "first_entry": { "type": "string", "format": "date-time", "nullable": true }, "finished": { "type": "string", "format": "date-time", "nullable": true }, "ended": { "type": "string", "format": "date-time", "nullable": true }, "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status9c9Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "preliminarynote": { "type": "string", "nullable": true }, "upper_spend_limit": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "info": { "nullable": true }, "external_sent": { "type": "string", "format": "date-time", "nullable": true }, "integration_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "report_to_authorities": { "type": "boolean" }, "client": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "complaint_type": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "residing_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "referring_organization": { "type": "string", "format": "uri", "nullable": true }, "referring_vet": { "type": "string", "format": "uri", "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "team": { "type": "string", "format": "uri", "nullable": true }, "patient_location_2": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "personnels": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "holding_place_number": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "tasks": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } } }, "required": [ "client", "created", "modified", "patients", "personnels", "url" ] }, "ConsultationCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "reporting_dimension_1": { "type": "string", "minLength": 1, "description": "Reporting dimension 1 id can be found on active Reporting dimension 1 list" }, "reporting_dimension_2": { "type": "string", "minLength": 1, "description": "Reporting dimension 2 id can be found on active Reporting dimension 2 list" }, "reporting_dimension_3": { "type": "string", "minLength": 1, "description": "Reporting dimension 3 id can be found on active Reporting dimension 3 list" }, "invoice": { "type": "string", "format": "uri" }, "consultation_notes": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_diagnosis": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_dischargeinstructions": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_patient_status": { "type": "array", "items": { "type": "string", "format": "uri" } }, "ward": { "type": "string", "format": "uri" }, "patient_location": { "type": "string", "format": "uri" }, "consultation_extras": { "$ref": "#/components/schemas/ConsultationExtrasRequest" }, "id": { "type": "integer" }, "type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Type2a8Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "patient_type": { "allOf": [ { "$ref": "#/components/schemas/PatientTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "complaint": { "type": "string", "nullable": true, "maxLength": 255 }, "admitted_time": { "type": "string", "format": "date-time", "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "first_entry": { "type": "string", "format": "date-time", "nullable": true }, "finished": { "type": "string", "format": "date-time", "nullable": true }, "ended": { "type": "string", "format": "date-time", "nullable": true }, "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status9c9Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "preliminarynote": { "type": "string", "nullable": true, "minLength": 1 }, "upper_spend_limit": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "info": { "nullable": true }, "external_sent": { "type": "string", "format": "date-time", "nullable": true }, "integration_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "report_to_authorities": { "type": "boolean" }, "client": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "complaint_type": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "residing_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "referring_organization": { "type": "string", "format": "uri", "nullable": true }, "referring_vet": { "type": "string", "format": "uri", "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "team": { "type": "string", "format": "uri", "nullable": true }, "patient_location_2": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "holding_place_number": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "tasks": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } } }, "required": [ "client", "patients" ] }, "ConsultationDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true, "description": "Unique consultation ID" }, "url": { "type": "string", "format": "uri", "readOnly": true, "description": "URL to this consultation resource" }, "client": { "type": "string", "format": "uri", "description": "URL to client associated with this consultation" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to patients being treated in this consultation" }, "complaint": { "type": "string", "nullable": true, "description": "Chief complaint or reason for consultation", "maxLength": 255 }, "complaint_type": { "type": "string", "format": "uri", "nullable": true, "description": "URL to structured complaint type classification" }, "admitted_time": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when patient was admitted" }, "first_entry": { "type": "string", "format": "date-time", "nullable": true, "description": "Time of first clinical entry" }, "started": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation officially started" }, "finished": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation was finished" }, "ended": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation was ended/closed" }, "status": { "nullable": true, "description": "Consultation status (open, in progress, completed, etc.)\n\n* `0` - Checked in\n* `8` - In progress\n* `5` - Ready for discharge\n* `7` - Invoicing\n* `6` - Discharged\n* `9` - Invoice paid\n* `10` - Finalized\n* `11` - Draft", "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status9c9Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type2a8Enum" } ], "description": "Type of consultation (standard, emergency, follow-up, etc.)\n\n* `1` - Outpatient\n* `0` - Inpatient\n* `2` - Home call\n* `3` - Farm visit\n* `4` - Boarding\n* `5` - Pet service", "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "string", "format": "uri" }, "supervising_veterinarian": { "type": "string", "format": "uri", "description": "URL to veterinarian supervising/performing consultation" }, "department": { "type": "string", "format": "uri", "description": "URL to department where consultation took place" }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to items used/administered (medications, procedures, etc.)" }, "reporting_dimension_1": { "type": "string", "description": "Reporting dimension 1 id can be found on active Reporting dimension 1 list" }, "reporting_dimension_2": { "type": "string", "description": "Reporting dimension 2 id can be found on active Reporting dimension 2 list" }, "reporting_dimension_3": { "type": "string", "description": "Reporting dimension 3 id can be found on active Reporting dimension 3 list" }, "consultation_notes": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_diagnosis": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_dischargeinstructions": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_patient_status": { "type": "array", "items": { "type": "string", "format": "uri" } }, "triage": { "type": "string", "format": "uri", "description": "URL to triage assessment and priority level" }, "external_sent": { "type": "string", "format": "date-time", "nullable": true, "description": "True if consultation was sent to external system" }, "ward": { "type": "string", "format": "uri" }, "patient_location": { "type": "string", "format": "uri" }, "integration_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "Status of integration with external systems" }, "holding_place_number": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "URL to holding place number for production animal consultation" }, "report_to_authorities": { "type": "boolean", "description": "True if consultation should be reported to authorities" }, "consultation_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true, "description": "URL to additional consultation data for export/import" }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when consultation was created" }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when consultation was last modified" }, "custom_fields": { "type": "string" }, "referring_organization": { "type": "string", "format": "uri", "nullable": true, "description": "URL to organization that referred this consultation" }, "referring_vet": { "type": "string", "format": "uri", "nullable": true, "description": "URL to veterinarian who referred this consultation" }, "templates_used": { "type": "string", "readOnly": true }, "appointment": { "type": "string", "readOnly": true } }, "required": [ "appointment", "client", "consultation_diagnosis", "consultation_dischargeinstructions", "consultation_extras", "consultation_items", "consultation_notes", "consultation_patient_status", "created", "custom_fields", "department", "holding_place_number", "id", "invoice", "modified", "patient_location", "patients", "supervising_veterinarian", "templates_used", "triage", "type", "url", "ward" ] }, "ConsultationExternalSent": { "type": "object", "description": "Serializer that will only allow modifying the external_sent field", "properties": { "external_sent": { "type": "string", "format": "date-time", "nullable": true } } }, "ConsultationExternalSentRequest": { "type": "object", "description": "Serializer that will only allow modifying the external_sent field", "properties": { "external_sent": { "type": "string", "format": "date-time", "nullable": true } } }, "ConsultationExtras": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "exported": { "type": "string", "format": "date-time", "nullable": true }, "export_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "imported": { "type": "string", "format": "date-time", "nullable": true }, "import_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "discharge_time": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "url" ] }, "ConsultationExtrasRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "exported": { "type": "string", "format": "date-time", "nullable": true }, "export_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "imported": { "type": "string", "format": "date-time", "nullable": true }, "import_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "discharge_time": { "type": "string", "format": "date-time", "nullable": true } } }, "ConsultationFood": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "readOnly": true }, "invoicerow": { "type": "string", "format": "uri", "readOnly": true }, "batch_number": { "type": "string", "readOnly": true }, "batch_expiry_date": { "type": "string", "nullable": true, "readOnly": true }, "code": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "maxLength": 63 }, "package_description": { "type": "string", "maxLength": 63 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "batch_expiry_date", "batch_number", "code", "consultation", "created", "external_reporting_code", "invoicerow", "item", "modified", "name", "url" ] }, "ConsultationFoodRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "minLength": 1, "maxLength": 63 }, "package_description": { "type": "string", "minLength": 1, "maxLength": 63 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consultation", "item" ] }, "ConsultationIntegrationStatus": { "type": "object", "description": "Serializer that will only allow modifying the integration_status field", "properties": { "integration_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true } } }, "ConsultationIntegrationStatusRequest": { "type": "object", "description": "Serializer that will only allow modifying the integration_status field", "properties": { "integration_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true } } }, "ConsultationItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "code": { "type": "string", "maxLength": 40 }, "name": { "type": "string", "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "supervising_veterinarian_name": { "type": "string", "readOnly": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "invoicerow": { "type": "string", "format": "uri" }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "usage_type": { "type": "string", "readOnly": true }, "usage_size": { "type": "string", "readOnly": true }, "unit": { "type": "string", "readOnly": true }, "package_description": { "type": "string", "readOnly": true }, "units": { "type": "string", "readOnly": true }, "instructions": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "administration_method": { "type": "string", "readOnly": true }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true } }, "required": [ "administration_method", "created", "description", "instructions", "invoicerow", "item", "linked_items", "modified", "name", "package_description", "supervising_veterinarian_name", "type_code", "unit", "units", "url", "usage_size", "usage_type" ] }, "ConsultationItemTemplate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "main_consultation_template": { "type": "string", "format": "uri", "nullable": true }, "base_template": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 } }, "required": [ "base_template", "consultation", "id", "name", "patient", "url" ] }, "ConsultationItemTemplateCreateUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "main_consultation_template": { "type": "string", "format": "uri", "nullable": true }, "base_template": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 }, "use_fixed_price": { "type": "boolean", "readOnly": true }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "subtotal": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "vat": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "total": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "price_change_item": { "type": "string", "format": "uri", "nullable": true }, "price_change_org_item": { "type": "string", "format": "uri", "readOnly": true, "nullable": true } }, "required": [ "base_template", "consultation", "fixed_price", "id", "name", "patient", "price_change_org_item", "subtotal", "total", "url", "use_fixed_price", "vat" ] }, "ConsultationItemTemplateCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "main_consultation_template": { "type": "string", "format": "uri", "nullable": true }, "base_template": { "type": "string", "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "price_change_item": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "base_template", "consultation", "name", "patient" ] }, "ConsultationItemTemplateDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "main_consultation_template": { "type": "string", "format": "uri", "nullable": true }, "base_template": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 }, "use_fixed_price": { "type": "boolean" }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price_change_item": { "type": "string", "format": "uri", "nullable": true }, "price_change_org_item": { "type": "string", "format": "uri", "nullable": true }, "subtotal": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "total": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "base_template", "consultation", "id", "items", "name", "patient", "subtotal", "total", "vat" ] }, "ConsultationLaboratoryAnalysis": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "readOnly": true }, "invoicerow": { "type": "string", "format": "uri", "readOnly": true }, "batch_number": { "type": "string", "readOnly": true }, "batch_expiry_date": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "reference_low": { "type": "string", "nullable": true, "readOnly": true }, "reference_high": { "type": "string", "nullable": true, "readOnly": true }, "external_id": { "type": "string", "nullable": true, "readOnly": true }, "consultation_organisms": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true, "description": "Organisms related to analysis. Only for microbiology referral." }, "code": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "result_numeric": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "result": { "type": "string", "nullable": true }, "result_entered": { "type": "string", "format": "date-time", "nullable": true }, "approved": { "type": "boolean" }, "approved_date": { "type": "string", "format": "date-time", "nullable": true }, "measurement_unit": { "type": "string", "maxLength": 100 }, "device": { "type": "string", "maxLength": 255 }, "remarks": { "type": "string", "nullable": true }, "order_in_panel": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "description": { "type": "string", "nullable": true, "maxLength": 60 }, "calculate_additional_tax": { "type": "boolean" }, "result_code": { "type": "string", "maxLength": 40 }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "referral": { "type": "string", "format": "uri" }, "panel": { "type": "string", "format": "uri", "nullable": true }, "approved_by": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "batch_expiry_date", "batch_number", "code", "consultation", "consultation_organisms", "created", "external_id", "external_reporting_code", "id", "invoicerow", "item", "modified", "name", "reference_high", "reference_low", "referral", "url" ] }, "ConsultationLaboratoryAnalysisUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "readOnly": true }, "invoicerow": { "type": "string", "format": "uri", "readOnly": true }, "batch_number": { "type": "string", "readOnly": true }, "batch_expiry_date": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "reference_low": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "reference_high": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_id": { "type": "string", "nullable": true, "readOnly": true }, "consultation_organisms": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true, "description": "Organisms related to analysis. Only for microbiology referral." }, "code": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "result_numeric": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "result": { "type": "string", "nullable": true }, "result_entered": { "type": "string", "format": "date-time", "nullable": true }, "approved": { "type": "boolean" }, "approved_date": { "type": "string", "format": "date-time", "nullable": true }, "measurement_unit": { "type": "string", "maxLength": 100 }, "device": { "type": "string", "maxLength": 255 }, "remarks": { "type": "string", "nullable": true }, "order_in_panel": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "description": { "type": "string", "nullable": true, "maxLength": 60 }, "calculate_additional_tax": { "type": "boolean" }, "result_code": { "type": "string", "maxLength": 40 }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "referral": { "type": "string", "format": "uri" }, "panel": { "type": "string", "format": "uri", "nullable": true }, "approved_by": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "batch_expiry_date", "batch_number", "code", "consultation", "consultation_organisms", "created", "external_id", "external_reporting_code", "id", "invoicerow", "item", "modified", "name", "reference_high", "reference_low", "referral", "url" ] }, "ConsultationLaboratoryAnalysisUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "reference_low": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "reference_high": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "result_numeric": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "result": { "type": "string", "nullable": true }, "result_entered": { "type": "string", "format": "date-time", "nullable": true }, "approved": { "type": "boolean" }, "approved_date": { "type": "string", "format": "date-time", "nullable": true }, "measurement_unit": { "type": "string", "maxLength": 100 }, "device": { "type": "string", "maxLength": 255 }, "remarks": { "type": "string", "nullable": true }, "order_in_panel": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "description": { "type": "string", "nullable": true, "maxLength": 60 }, "calculate_additional_tax": { "type": "boolean" }, "result_code": { "type": "string", "maxLength": 40 }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "referral": { "type": "string", "format": "uri" }, "panel": { "type": "string", "format": "uri", "nullable": true }, "approved_by": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consultation", "item", "reference_high", "reference_low", "referral" ] }, "ConsultationLaboratoryReferral": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "consultation": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "nullable": true }, "laboratory_type": { "allOf": [ { "$ref": "#/components/schemas/LaboratoryTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "type": { "allOf": [ { "$ref": "#/components/schemas/ConsultationLaboratoryReferralTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status7c4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "inhouse_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks": { "type": "string", "nullable": true }, "laboratory_remarks": { "type": "string", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "referral_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "laboratory_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "laboratory_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "internal_notes_user": { "type": "string", "format": "uri", "nullable": true }, "internal_notes_modified": { "type": "string", "format": "date-time", "nullable": true }, "sample_location": { "nullable": true }, "locked": { "type": "string", "format": "date-time", "nullable": true }, "locked_user": { "type": "string", "format": "uri", "nullable": true }, "never_require_results": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "external_status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalStatusEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "external_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "internal_id": { "type": "string", "nullable": true, "maxLength": 31 }, "internal_status": { "type": "string", "format": "uri", "nullable": true }, "sampler": { "type": "string", "format": "uri", "nullable": true }, "sample_taken": { "type": "string", "format": "date-time", "nullable": true }, "referring_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "create_task_for": { "type": "array", "items": { "type": "string", "format": "uri" } }, "urgent": { "type": "boolean" }, "analyses": { "type": "array", "items": { "type": "string", "format": "uri" } }, "panels": { "type": "array", "items": { "type": "string", "format": "uri" } }, "samples": { "type": "array", "items": { "type": "string", "format": "uri" } }, "attachment_note": { "type": "string", "format": "uri", "readOnly": true }, "for_idexx": { "type": "boolean", "readOnly": true } }, "required": [ "attachment_note", "consultation", "created", "department", "for_idexx", "id", "laboratory_type", "modified", "url" ] }, "ConsultationLaboratoryReferralRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "nullable": true }, "laboratory_type": { "allOf": [ { "$ref": "#/components/schemas/LaboratoryTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "type": { "allOf": [ { "$ref": "#/components/schemas/ConsultationLaboratoryReferralTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status7c4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "inhouse_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks": { "type": "string", "nullable": true }, "laboratory_remarks": { "type": "string", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "referral_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "laboratory_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "laboratory_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "internal_notes_user": { "type": "string", "format": "uri", "nullable": true }, "internal_notes_modified": { "type": "string", "format": "date-time", "nullable": true }, "sample_location": { "nullable": true }, "locked": { "type": "string", "format": "date-time", "nullable": true }, "locked_user": { "type": "string", "format": "uri", "nullable": true }, "never_require_results": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "external_status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalStatusEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "external_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "internal_id": { "type": "string", "nullable": true, "maxLength": 31 }, "internal_status": { "type": "string", "format": "uri", "nullable": true }, "sampler": { "type": "string", "format": "uri", "nullable": true }, "sample_taken": { "type": "string", "format": "date-time", "nullable": true }, "referring_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "create_task_for": { "type": "array", "items": { "type": "string", "format": "uri" } }, "urgent": { "type": "boolean" }, "analyses": { "type": "array", "items": { "type": "string", "format": "uri" } }, "panels": { "type": "array", "items": { "type": "string", "format": "uri" } }, "samples": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consultation", "department", "laboratory_type" ] }, "ConsultationLaboratoryReferralTypeEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Clinical laboratory\n* `2` - Microbiology\n* `3` - Pathology" }, "ConsultationMedicine": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "readOnly": true }, "invoicerow": { "type": "string", "format": "uri", "readOnly": true }, "batch_number": { "type": "string", "readOnly": true }, "batch_expiry_date": { "type": "string", "nullable": true, "readOnly": true }, "numeric_withdrawal_periods": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationMedicineWithdrawalPeriod" } }, "use_reason": { "type": "string", "format": "uri" }, "vila_reporting_required": { "type": "boolean", "readOnly": true }, "vaccination_disease": { "type": "string", "nullable": true }, "code": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "administration_method": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/AdministrationMethodEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "administration_speed": { "type": "number", "format": "double", "maximum": 100000, "minimum": -100000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "administration_hours": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "active_substance": { "type": "string", "nullable": true }, "controlled_substance": { "type": "boolean" }, "vaccination": { "type": "boolean" }, "vaccination_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/VaccinationTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "contraindications": { "type": "string", "nullable": true }, "preparation": { "type": "string", "nullable": true, "maxLength": 255 }, "manufacturer_data": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "maxLength": 63 }, "package_description": { "type": "string", "maxLength": 63 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "withdrawal_periods": { "type": "string", "nullable": true }, "measurement_loss_quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "measurement_loss_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "dispense_fee": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Handling fee" }, "injection_fee": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "dispense_fee_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Handling fee with VAT" }, "injection_fee_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_default_dispense_fee": { "type": "boolean", "title": "Use default handling fee" }, "not_for_food": { "type": "boolean" }, "use_dispense_fee": { "type": "boolean", "title": "Use handling fee" }, "effect_time": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "medication_duration_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "medication_diagnosis": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "batch_expiry_date", "batch_number", "code", "consultation", "created", "external_reporting_code", "invoicerow", "item", "modified", "name", "url", "vila_reporting_required" ] }, "ConsultationMedicineRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "numeric_withdrawal_periods": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationMedicineWithdrawalPeriodRequest" } }, "use_reason": { "type": "string", "format": "uri" }, "vaccination_disease": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "administration_method": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/AdministrationMethodEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "administration_speed": { "type": "number", "format": "double", "maximum": 100000, "minimum": -100000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "administration_hours": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "active_substance": { "type": "string", "nullable": true }, "controlled_substance": { "type": "boolean" }, "vaccination": { "type": "boolean" }, "vaccination_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/VaccinationTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "contraindications": { "type": "string", "nullable": true }, "preparation": { "type": "string", "nullable": true, "maxLength": 255 }, "manufacturer_data": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "minLength": 1, "maxLength": 63 }, "package_description": { "type": "string", "minLength": 1, "maxLength": 63 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "withdrawal_periods": { "type": "string", "nullable": true }, "measurement_loss_quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "measurement_loss_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "dispense_fee": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Handling fee" }, "injection_fee": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "dispense_fee_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Handling fee with VAT" }, "injection_fee_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_default_dispense_fee": { "type": "boolean", "title": "Use default handling fee" }, "not_for_food": { "type": "boolean" }, "use_dispense_fee": { "type": "boolean", "title": "Use handling fee" }, "effect_time": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "medication_duration_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "medication_diagnosis": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consultation", "item" ] }, "ConsultationMedicineWithdrawalPeriod": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ConsultationMedicineWithdrawalPeriodTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "duration_in_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "duration_in_hours": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "lifelong": { "type": "boolean" } }, "required": [ "type" ] }, "ConsultationMedicineWithdrawalPeriodRequest": { "type": "object", "properties": { "id": { "type": "integer" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ConsultationMedicineWithdrawalPeriodTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "duration_in_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "duration_in_hours": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "lifelong": { "type": "boolean" } }, "required": [ "type" ] }, "ConsultationMedicineWithdrawalPeriodTypeEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Doping\n* `2` - Meat\n* `3` - Milk or eggs" }, "ConsultationOrganism": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "description": { "type": "string", "nullable": true }, "organism": { "type": "string", "format": "uri" }, "consultation_analysis": { "type": "string", "format": "uri" }, "consultation_antibiotics": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "consultation_antibiotic_panels": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "result": { "type": "string", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true } }, "required": [ "consultation_analysis", "consultation_antibiotic_panels", "consultation_antibiotics", "created", "created_user", "id", "modified", "modified_user", "organism", "result", "url" ] }, "ConsultationOrganismRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "description": { "type": "string", "nullable": true }, "organism": { "type": "string", "format": "uri" }, "consultation_analysis": { "type": "string", "format": "uri" } }, "required": [ "consultation_analysis", "organism" ] }, "ConsultationProcedure": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "readOnly": true }, "invoicerow": { "type": "string", "format": "uri", "readOnly": true }, "batch_number": { "type": "string", "readOnly": true }, "batch_expiry_date": { "type": "string", "nullable": true, "readOnly": true }, "code": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "description": { "type": "string", "nullable": true }, "calculate_additional_tax": { "type": "boolean" }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "sub_category": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "batch_expiry_date", "batch_number", "code", "consultation", "created", "external_reporting_code", "invoicerow", "item", "modified", "name", "url" ] }, "ConsultationProcedureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "description": { "type": "string", "nullable": true }, "calculate_additional_tax": { "type": "boolean" }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "sub_category": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consultation", "item" ] }, "ConsultationSample": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "referral": { "type": "string", "format": "uri" }, "coded_sample_type": { "type": "string" }, "quantity": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "site": { "type": "string", "nullable": true, "maxLength": 255 }, "comment": { "type": "string", "nullable": true }, "received_date": { "type": "string", "format": "date-time", "nullable": true }, "received_user": { "type": "string", "format": "uri", "nullable": true }, "analyses": { "type": "string", "readOnly": true }, "panels": { "type": "string", "readOnly": true } }, "required": [ "analyses", "id", "panels", "referral", "url" ] }, "ConsultationSampleUpdate": { "type": "object", "properties": { "referral": { "type": "integer" }, "coded_sample_type": { "type": "integer", "nullable": true, "minimum": -9223372036854775808, "maximum": 9223372036854775807 }, "quantity": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "site": { "type": "string", "nullable": true, "maxLength": 255 }, "comment": { "type": "string", "nullable": true }, "received_date": { "type": "string", "format": "date-time", "nullable": true }, "received_user": { "type": "integer", "nullable": true }, "items": { "type": "array", "items": { "type": "integer" } } }, "required": [ "items", "referral" ] }, "ConsultationSampleUpdateRequest": { "type": "object", "properties": { "referral": { "type": "integer" }, "coded_sample_type": { "type": "integer", "nullable": true, "minimum": -9223372036854775808, "maximum": 9223372036854775807 }, "quantity": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "site": { "type": "string", "nullable": true, "maxLength": 255 }, "comment": { "type": "string", "nullable": true }, "received_date": { "type": "string", "format": "date-time", "nullable": true }, "received_user": { "type": "integer", "nullable": true }, "items": { "type": "array", "items": { "type": "integer" } } }, "required": [ "items", "referral" ] }, "ConsultationStartedTime": { "type": "object", "description": "Serializer for updating Consultation's started time", "properties": { "started": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "started" ] }, "ConsultationStartedTimeRequest": { "type": "object", "description": "Serializer for updating Consultation's started time", "properties": { "started": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "started" ] }, "ConsultationStatus": { "type": "object", "description": "Serializer for updating Consultation's status", "properties": { "status": { "type": "integer" } }, "required": [ "status" ] }, "ConsultationStatusRequest": { "type": "object", "description": "Serializer for updating Consultation's status", "properties": { "status": { "type": "integer" } }, "required": [ "status" ] }, "ConsultationSubCategory": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 50 }, "is_package": { "type": "boolean" }, "is_fixed": { "type": "boolean" }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "sub_category": { "type": "string", "format": "uri" }, "procedure": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "modified", "name", "sub_category", "url" ] }, "ConsultationSupply": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "readOnly": true }, "invoicerow": { "type": "string", "format": "uri", "readOnly": true }, "batch_number": { "type": "string", "readOnly": true }, "batch_expiry_date": { "type": "string", "nullable": true, "readOnly": true }, "code": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "maxLength": 63 }, "package_description": { "type": "string", "maxLength": 63 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "batch_expiry_date", "batch_number", "code", "consultation", "created", "external_reporting_code", "invoicerow", "item", "modified", "name", "url" ] }, "ConsultationSupplyRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "minLength": 1, "maxLength": 63 }, "package_description": { "type": "string", "minLength": 1, "maxLength": 63 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consultation", "item" ] }, "ConsultationTargetArea": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "target_area": { "type": "string", "format": "uri" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "maxLength": 50 }, "code": { "type": "string", "nullable": true, "maxLength": 16 }, "procedure": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "category_id": { "type": "integer", "nullable": true }, "sub_category_id": { "type": "integer", "nullable": true } }, "required": [ "created", "id", "modified", "name", "target_area", "url" ] }, "ConsultationTargetAreaRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "target_area": { "type": "string", "format": "uri" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "code": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 16 }, "procedure": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "category_id": { "type": "integer", "nullable": true }, "sub_category_id": { "type": "integer", "nullable": true } }, "required": [ "name", "target_area" ] }, "ContentType": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "app_label": { "type": "string", "maxLength": 100 }, "model": { "type": "string", "title": "Python model class name", "maxLength": 100 } }, "required": [ "app_label", "id", "model", "name", "url" ] }, "ContentTypeEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - application/x-www-form-urlencoded\n* `2` - application/json" }, "Countersale": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri", "title": "Countersale department" }, "client": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "invoice_detail": { "type": "string", "format": "uri", "readOnly": true }, "status": { "type": "string", "readOnly": true }, "invoice_row": { "type": "array", "items": { "type": "string", "format": "uri" } }, "remarks": { "type": "string", "nullable": true }, "health_plan": { "type": "string", "nullable": true, "readOnly": true } }, "required": [ "created", "department", "health_plan", "invoice_detail", "invoice_row", "modified", "status", "url" ] }, "CountersaleCreateUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "invoice_number": { "type": "string", "readOnly": true }, "status": { "type": "string", "readOnly": true }, "client": { "type": "string", "format": "uri", "nullable": true, "description": "Client for the sale. Null is anonymous sale" }, "remarks": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri", "title": "Countersale department", "description": "department of the countersale. the data is a url pointing to a department (see department-endpoint)" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true, "title": "Tags" }, "nullable": true, "title": "Tags", "description": "Tags for the sale/invoice" }, "details": { "type": "string", "format": "uri", "readOnly": true, "description": "This is a read-only link to the actual invoice details" }, "health_plan": { "type": "string" } }, "required": [ "client", "created", "department", "details", "id", "invoice_number", "modified", "status", "url" ] }, "CountersaleCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri", "nullable": true, "description": "Client for the sale. Null is anonymous sale" }, "remarks": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri", "title": "Countersale department", "description": "department of the countersale. the data is a url pointing to a department (see department-endpoint)" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true, "title": "Tags" }, "nullable": true, "title": "Tags", "description": "Tags for the sale/invoice" }, "health_plan": { "type": "string" } }, "required": [ "client", "department" ] }, "CountersaleDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "invoice_number": { "type": "string", "readOnly": true }, "status": { "type": "string", "readOnly": true }, "client": { "type": "string", "format": "uri", "nullable": true, "description": "Client for the sale. Null is anonymous sale" }, "remarks": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri", "title": "Countersale department", "description": "department of the countersale. the data is a url pointing to a department (see department-endpoint)" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true, "title": "Tags" }, "nullable": true, "title": "Tags", "description": "Tags for the sale/invoice" }, "details": { "type": "string", "format": "uri", "readOnly": true, "description": "This is a read-only link to the actual invoice details" }, "health_plan": { "type": "string", "nullable": true, "readOnly": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "invoice_row": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true } }, "required": [ "client", "created", "department", "details", "health_plan", "id", "invoice_number", "invoice_row", "modified", "status", "url" ] }, "CountersaleRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri", "title": "Countersale department" }, "client": { "type": "string", "format": "uri", "nullable": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "invoice_row": { "type": "array", "items": { "type": "string", "format": "uri" } }, "remarks": { "type": "string", "nullable": true } }, "required": [ "department", "invoice_row" ] }, "CountryEnum": { "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe" }, "CprAgreementEnum": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "* `0` - ---------\n* `1` - No (DNR)\n* `2` - YES (CPR)\n* `3` - YES (Advanced CPR)" }, "CurrencyEnum": { "enum": [ "ALL", "AFN", "ARS", "AWG", "AUD", "AZN", "BSD", "BBD", "BYR", "BZD", "BMD", "BOB", "BAM", "BWP", "BGN", "BRL", "BND", "KHR", "CAD", "KYD", "CLP", "CNY", "COP", "CRC", "HRK", "CUP", "CZK", "DKK", "DOP", "XCD", "EGP", "SVC", "EUR", "FKP", "FJD", "GHC", "GIP", "GTQ", "GGP", "GYD", "HNL", "HKD", "HUF", "ISK", "INR", "IDR", "IRR", "IMP", "ILS", "JMD", "JPY", "JEP", "KZT", "KES", "KPW", "KRW", "KGS", "LAK", "LBP", "LRD", "MKD", "MYR", "MUR", "MXN", "MNT", "MZN", "NAD", "NPR", "ANG", "NZD", "NIO", "NGN", "NOK", "OMR", "PKR", "PAB", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "SHP", "SAR", "RSD", "SCR", "SGD", "SBD", "SOS", "ZAR", "LKR", "SEK", "CHF", "SRD", "SYP", "TWD", "THB", "TTD", "TRY", "TRL", "TVD", "UAH", "GBP", "USD", "UYU", "UZS", "VEF", "VND", "YER", "ZWD", "AED", "MOP", "KWD", "ZMW", "WST" ], "type": "string", "description": "* `ALL` - Albania Lek (ALL)\n* `AFN` - Afghanistan Afghani (AFN)\n* `ARS` - Argentina Peso (ARS)\n* `AWG` - Aruba Guilder (AWG)\n* `AUD` - Australia Dollar (AUD)\n* `AZN` - Azerbaijan New Manat (AZN)\n* `BSD` - Bahamas Dollar (BSD)\n* `BBD` - Barbados Dollar (BBD)\n* `BYR` - Belarus Ruble (BYR)\n* `BZD` - Belize Dollar (BZD)\n* `BMD` - Bermuda Dollar (BMD)\n* `BOB` - Bolivia Boliviano (BOB)\n* `BAM` - Bosnia and Herzegovina Convertible Marka (BAM)\n* `BWP` - Botswana Pula (BWP)\n* `BGN` - Bulgaria Lev (BGN)\n* `BRL` - Brazil Real (BRL)\n* `BND` - Brunei Darussalam Dollar (BND)\n* `KHR` - Cambodia Riel (KHR)\n* `CAD` - Canadian Dollar (CAD)\n* `KYD` - Cayman Islands Dollar (KYD)\n* `CLP` - Chile Peso (CLP)\n* `CNY` - China Yuan Renminbi (CNY)\n* `COP` - Colombia Peso (COP)\n* `CRC` - Costa Rica Colon (CRC)\n* `HRK` - Croatia Kuna (HRK)\n* `CUP` - Cuba Peso (CUP)\n* `CZK` - Czech Republic Koruna (CZK)\n* `DKK` - Denmark Krone (DKK)\n* `DOP` - Dominican Republic Peso (DOP)\n* `XCD` - East Caribbean Dollar (XCD)\n* `EGP` - Egypt Pound (EGP)\n* `SVC` - El Salvador Colon (SVC)\n* `EUR` - Euro (EUR)\n* `FKP` - Falkland Islands (Malvinas) Pound (FKP)\n* `FJD` - Fiji Dollar (FJD)\n* `GHC` - Ghana Cedi (GHC)\n* `GIP` - Gibraltar Pound (GIP)\n* `GTQ` - Guatemala Quetzal (GTQ)\n* `GGP` - Guernsey Pound (GGP)\n* `GYD` - Guyana Dollar (GYD)\n* `HNL` - Honduras Lempira (HNL)\n* `HKD` - Hong Kong Dollar (HKD)\n* `HUF` - Hungary Forint (HUF)\n* `ISK` - Iceland Krona (ISK)\n* `INR` - India Rupee (INR)\n* `IDR` - Indonesia Rupiah (IDR)\n* `IRR` - Iran Rial (IRR)\n* `IMP` - Isle of Man Pound (IMP)\n* `ILS` - Israel Shekel (ILS)\n* `JMD` - Jamaica Dollar (JMD)\n* `JPY` - Japan Yen (JPY)\n* `JEP` - Jersey Pound (JEP)\n* `KZT` - Kazakhstan Tenge (KZT)\n* `KES` - Kenyan shilling (KES)\n* `KPW` - Korea (North) Won (KPW)\n* `KRW` - Korea (South) Won (KRW)\n* `KGS` - Kyrgyzstan Som (KGS)\n* `LAK` - Laos Kip (LAK)\n* `LBP` - Lebanon Pound (LBP)\n* `LRD` - Liberia Dollar (LRD)\n* `MKD` - Macedonia Denar (MKD)\n* `MYR` - Malaysia Ringgit (MYR)\n* `MUR` - Mauritius Rupee (MUR)\n* `MXN` - Mexico Peso (MXN)\n* `MNT` - Mongolia Tughrik (MNT)\n* `MZN` - Mozambique Metical (MZN)\n* `NAD` - Namibia Dollar (NAD)\n* `NPR` - Nepal Rupee (NPR)\n* `ANG` - Netherlands Antilles Guilder (ANG)\n* `NZD` - New Zealand Dollar (NZD)\n* `NIO` - Nicaragua Cordoba (NIO)\n* `NGN` - Nigeria Naira (NGN)\n* `NOK` - Norway Krone (NOK)\n* `OMR` - Oman Rial (OMR)\n* `PKR` - Pakistan Rupee (PKR)\n* `PAB` - Panama Balboa (PAB)\n* `PYG` - Paraguay Guarani (PYG)\n* `PEN` - Peru Nuevo Sol (PEN)\n* `PHP` - Philippines Peso (PHP)\n* `PLN` - Poland Zloty (PLN)\n* `QAR` - Qatar Riyal (QAR)\n* `RON` - Romania New Leu (RON)\n* `RUB` - Russia Ruble (RUB)\n* `SHP` - Saint Helena Pound (SHP)\n* `SAR` - Saudi Arabia Riyal (SAR)\n* `RSD` - Serbia Dinar (RSD)\n* `SCR` - Seychelles Rupee (SCR)\n* `SGD` - Singapore Dollar (SGD)\n* `SBD` - Solomon Islands Dollar (SBD)\n* `SOS` - Somalia Shilling (SOS)\n* `ZAR` - South Africa Rand (ZAR)\n* `LKR` - Sri Lanka Rupee (LKR)\n* `SEK` - Sweden Krona (SEK)\n* `CHF` - Switzerland Franc (CHF)\n* `SRD` - Suriname Dollar (SRD)\n* `SYP` - Syria Pound (SYP)\n* `TWD` - Taiwan New Dollar (TWD)\n* `THB` - Thailand Baht (THB)\n* `TTD` - Trinidad and Tobago Dollar (TTD)\n* `TRY` - Turkey Lira (TRY)\n* `TRL` - Turkey Lira (TRL)\n* `TVD` - Tuvalu Dollar (TVD)\n* `UAH` - Ukraine Hryvnia (UAH)\n* `GBP` - United Kingdom Pound (GBP)\n* `USD` - United States Dollar (USD)\n* `UYU` - Uruguay Peso (UYU)\n* `UZS` - Uzbekistan Som (UZS)\n* `VEF` - Venezuela Bolivar (VEF)\n* `VND` - Viet Nam Dong (VND)\n* `YER` - Yemen Rial (YER)\n* `ZWD` - Zimbabwe Dollar (ZWD)\n* `AED` - United Arab Emirates Dirham (AED)\n* `MOP` - Macanese Pataca (MOP)\n* `KWD` - Kuwaiti Dinar (KWD)\n* `ZMW` - Zambian Kwacha (ZMW)\n* `WST` - Samoan Tala (WST)" }, "CustomField": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 150 }, "field_type": { "allOf": [ { "$ref": "#/components/schemas/FieldTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "default_value": { "type": "string", "description": "Optional. For checkbox use True or False", "maxLength": 5000 }, "is_required": { "type": "boolean" }, "content_type": { "type": "string", "readOnly": true }, "archived": { "type": "boolean" }, "custom_field_options": { "type": "string", "readOnly": true } }, "required": [ "content_type", "custom_field_options", "id", "name" ] }, "CustomFieldOptionValue": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "custom_field_option_value": { "type": "string", "readOnly": true } }, "required": [ "custom_field_option_value", "id" ] }, "CustomFieldValue": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "field": { "type": "integer" }, "value": { "type": "string" }, "object_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "compound_values": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "field", "id", "object_id", "value" ] }, "CustomFieldValueRequest": { "type": "object", "properties": { "field": { "type": "integer" }, "value": { "type": "string" }, "object_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "compound_values": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "field", "object_id", "value" ] }, "CustomFieldValueUpdate": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "required": [ "value" ] }, "CustomFieldValueUpdateRequest": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "required": [ "value" ] }, "CustomIntegration": { "type": "object", "description": "Opt-in mixin to reject unknown input fields for POST/PATCH.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 }, "enabled": { "type": "boolean" }, "type": { "allOf": [ { "$ref": "#/components/schemas/CustomIntegrationTypeEnum" } ], "minimum": -32768, "maximum": 32767 }, "action": { "allOf": [ { "$ref": "#/components/schemas/ActionEnum" } ], "minimum": -32768, "maximum": 32767 }, "action_parameters": { "type": "string", "maxLength": 255 }, "method": { "allOf": [ { "$ref": "#/components/schemas/MethodEnum" } ], "minimum": -32768, "maximum": 32767 }, "parameter_name": { "type": "string", "maxLength": 255 }, "headers": { "nullable": true }, "verification": { "type": "boolean" }, "verification_payload": { "type": "boolean", "default": false }, "verification_salt": { "type": "string", "maxLength": 255 }, "expose_organization_info": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "action", "created", "department", "id", "method", "modified", "name", "parameter_name", "type", "url", "verification_salt" ] }, "CustomIntegrationRequest": { "type": "object", "description": "Opt-in mixin to reject unknown input fields for POST/PATCH.", "properties": { "url": { "type": "string", "minLength": 1, "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "enabled": { "type": "boolean" }, "type": { "allOf": [ { "$ref": "#/components/schemas/CustomIntegrationTypeEnum" } ], "minimum": -32768, "maximum": 32767 }, "action": { "allOf": [ { "$ref": "#/components/schemas/ActionEnum" } ], "minimum": -32768, "maximum": 32767 }, "action_parameters": { "type": "string", "maxLength": 255 }, "method": { "allOf": [ { "$ref": "#/components/schemas/MethodEnum" } ], "minimum": -32768, "maximum": 32767 }, "parameter_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "headers": { "nullable": true }, "verification": { "type": "boolean" }, "verification_payload": { "type": "boolean", "default": false }, "verification_salt": { "type": "string", "maxLength": 255 }, "expose_organization_info": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "action", "department", "method", "name", "parameter_name", "type", "url", "verification_salt" ] }, "CustomIntegrationTypeEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 ], "type": "integer", "description": "* `0` - Client\n* `1` - Patient\n* `2` - Invoice\n* `3` - Consultation\n* `4` - Laboratory referral\n* `5` - Appointments calendar\n* `6` - Shifts calendar\n* `7` - Diagnostic imaging\n* `8` - Reminder\n* `9` - Health plan\n* `10` - Online prescription client page\n* `11` - Online prescription patient page\n* `12` - Online prescription consultation page\n* `13` - Home deliveries dashboard" }, "CustomerTypeEnum": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "* `0` - Private person\n* `1` - Company\n* `2` - EU Company\n* `3` - Charitable organization\n* `4` - UK charity" }, "DefaultRenewalEnum": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "* `0` - Do not renew\n* `1` - Renew once\n* `2` - Renew continuously" }, "DefaultSelectedEnum": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "* `0` - Un-ticked\n* `1` - Pre-ticked\n* `2` - Mandatory" }, "DefaultUsageSizeEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Package\n* `2` - Units" }, "DeliveryMethodEnum": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "* `0` - None\n* `1` - All\n* `2` - Email\n* `3` - Phone" }, "Department": { "type": "object", "description": "wards = HyperlinkedIdentityField(\n view_name='ward-list',\n lookup_url_kwarg='parent_lookup_department'\n)", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "active_item_list": { "type": "string", "format": "uri" }, "email": { "type": "string", "readOnly": true }, "website": { "type": "string", "readOnly": true }, "address_info": { "type": "string", "readOnly": true }, "logo": { "type": "string", "readOnly": true }, "social_links": { "type": "string", "readOnly": true }, "allow_nhp_processing": { "type": "string", "readOnly": true }, "timezone": { "type": "string", "readOnly": true } }, "required": [ "active_item_list", "address_info", "allow_nhp_processing", "email", "id", "logo", "name", "social_links", "timezone", "url", "website" ] }, "DepartmentGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "boolean" }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "departments", "id", "modified", "name", "url" ] }, "DepartmentLogoRequest": { "type": "object", "description": "Writable serializer for the department logo upload (PUT).", "properties": { "logo": { "type": "string", "format": "binary" } }, "required": [ "logo" ] }, "DepartmentSettings": { "type": "object", "description": "Use namespaced fields.", "properties": { "department_settings": { "type": "string", "readOnly": true }, "organization_settings": { "type": "string", "readOnly": true } }, "required": [ "department_settings", "organization_settings" ] }, "DepartmentSettingsApi": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "alternative_emails": { "type": "string", "description": "Define alternative email addresses that can be used when sending emails from the system. Separate with commas." }, "invoice_street_address": { "type": "string", "description": "Street address to be shown in an invoice." }, "invoice_street_address_2": { "type": "string", "description": "The second line of the street address." }, "invoice_zip_code": { "type": "string" }, "invoice_city": { "type": "string" }, "invoice_country": { "nullable": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US).\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe", "oneOf": [ { "$ref": "#/components/schemas/InvoiceCountryEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_state": { "nullable": true, "description": "US state\n\n* `AL` - Alabama\n* `AK` - Alaska\n* `AS` - American Samoa\n* `AZ` - Arizona\n* `AR` - Arkansas\n* `AA` - Armed Forces Americas\n* `AE` - Armed Forces Europe\n* `AP` - Armed Forces Pacific\n* `CA` - California\n* `CO` - Colorado\n* `CT` - Connecticut\n* `DE` - Delaware\n* `DC` - District of Columbia\n* `FL` - Florida\n* `GA` - Georgia\n* `GU` - Guam\n* `HI` - Hawaii\n* `ID` - Idaho\n* `IL` - Illinois\n* `IN` - Indiana\n* `IA` - Iowa\n* `KS` - Kansas\n* `KY` - Kentucky\n* `LA` - Louisiana\n* `ME` - Maine\n* `MD` - Maryland\n* `MA` - Massachusetts\n* `MI` - Michigan\n* `MN` - Minnesota\n* `MS` - Mississippi\n* `MO` - Missouri\n* `MT` - Montana\n* `NE` - Nebraska\n* `NV` - Nevada\n* `NH` - New Hampshire\n* `NJ` - New Jersey\n* `NM` - New Mexico\n* `NY` - New York\n* `NC` - North Carolina\n* `ND` - North Dakota\n* `MP` - Northern Mariana Islands\n* `OH` - Ohio\n* `OK` - Oklahoma\n* `OR` - Oregon\n* `PA` - Pennsylvania\n* `PR` - Puerto Rico\n* `RI` - Rhode Island\n* `SC` - South Carolina\n* `SD` - South Dakota\n* `TN` - Tennessee\n* `TX` - Texas\n* `UT` - Utah\n* `VT` - Vermont\n* `VI` - Virgin Islands\n* `VA` - Virginia\n* `WA` - Washington\n* `WV` - West Virginia\n* `WI` - Wisconsin\n* `WY` - Wyoming", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_country_region": { "type": "string", "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, FI-18)." }, "navbar_color": { "type": "string" }, "timezone": { "nullable": true, "description": "Select the time zone that applies to your clinic location/department.\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Coyhaique` - America/Coyhaique\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GMT` - GMT\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC", "oneOf": [ { "$ref": "#/components/schemas/TimezoneEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "financial_period_lock_date": { "type": "string", "format": "date", "nullable": true, "description": "Earliest possible date for financial events (invoices, payments, credit notes)." }, "automatic_financial_period_lock_enabled": { "type": "boolean", "readOnly": true, "description": "Whether automatic financial period locking is enabled." }, "automatic_financial_period_lock_monthday": { "type": "integer", "readOnly": true, "description": "Day of month when automatic financial period locking occurs (1-31)." } }, "required": [ "automatic_financial_period_lock_enabled", "automatic_financial_period_lock_monthday", "department", "id" ] }, "DepartmentSettingsApiRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "phone": { "type": "string" }, "email": { "type": "string" }, "alternative_emails": { "type": "string", "description": "Define alternative email addresses that can be used when sending emails from the system. Separate with commas." }, "invoice_street_address": { "type": "string", "description": "Street address to be shown in an invoice." }, "invoice_street_address_2": { "type": "string", "description": "The second line of the street address." }, "invoice_zip_code": { "type": "string" }, "invoice_city": { "type": "string" }, "invoice_country": { "nullable": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US).\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe", "oneOf": [ { "$ref": "#/components/schemas/InvoiceCountryEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_state": { "nullable": true, "description": "US state\n\n* `AL` - Alabama\n* `AK` - Alaska\n* `AS` - American Samoa\n* `AZ` - Arizona\n* `AR` - Arkansas\n* `AA` - Armed Forces Americas\n* `AE` - Armed Forces Europe\n* `AP` - Armed Forces Pacific\n* `CA` - California\n* `CO` - Colorado\n* `CT` - Connecticut\n* `DE` - Delaware\n* `DC` - District of Columbia\n* `FL` - Florida\n* `GA` - Georgia\n* `GU` - Guam\n* `HI` - Hawaii\n* `ID` - Idaho\n* `IL` - Illinois\n* `IN` - Indiana\n* `IA` - Iowa\n* `KS` - Kansas\n* `KY` - Kentucky\n* `LA` - Louisiana\n* `ME` - Maine\n* `MD` - Maryland\n* `MA` - Massachusetts\n* `MI` - Michigan\n* `MN` - Minnesota\n* `MS` - Mississippi\n* `MO` - Missouri\n* `MT` - Montana\n* `NE` - Nebraska\n* `NV` - Nevada\n* `NH` - New Hampshire\n* `NJ` - New Jersey\n* `NM` - New Mexico\n* `NY` - New York\n* `NC` - North Carolina\n* `ND` - North Dakota\n* `MP` - Northern Mariana Islands\n* `OH` - Ohio\n* `OK` - Oklahoma\n* `OR` - Oregon\n* `PA` - Pennsylvania\n* `PR` - Puerto Rico\n* `RI` - Rhode Island\n* `SC` - South Carolina\n* `SD` - South Dakota\n* `TN` - Tennessee\n* `TX` - Texas\n* `UT` - Utah\n* `VT` - Vermont\n* `VI` - Virgin Islands\n* `VA` - Virginia\n* `WA` - Washington\n* `WV` - West Virginia\n* `WI` - Wisconsin\n* `WY` - Wyoming", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_country_region": { "type": "string", "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, FI-18)." }, "navbar_color": { "type": "string", "minLength": 1 }, "timezone": { "nullable": true, "description": "Select the time zone that applies to your clinic location/department.\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Coyhaique` - America/Coyhaique\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GMT` - GMT\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC", "oneOf": [ { "$ref": "#/components/schemas/TimezoneEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "financial_period_lock_date": { "type": "string", "format": "date", "nullable": true, "description": "Earliest possible date for financial events (invoices, payments, credit notes)." } } }, "DeterminingPriceEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Price including VAT\n* `2` - Price excluding VAT" }, "Diagnosis": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "diagnosis": { "type": "string", "format": "uri" }, "category": { "allOf": [ { "$ref": "#/components/schemas/Category8beEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "type": { "allOf": [ { "$ref": "#/components/schemas/DiagnosisTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "code": { "type": "string", "maxLength": 20 }, "name": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "code", "consultation", "created", "diagnosis", "id", "modified", "name", "patient" ] }, "DiagnosisRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "diagnosis": { "type": "string", "format": "uri" }, "category": { "allOf": [ { "$ref": "#/components/schemas/Category8beEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "type": { "allOf": [ { "$ref": "#/components/schemas/DiagnosisTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "code": { "type": "string", "minLength": 1, "maxLength": 20 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "code", "consultation", "diagnosis", "name", "patient" ] }, "DiagnosisTypeEnum": { "enum": [ 0, 1 ], "type": "integer", "description": "* `0` - Differential\n* `1` - Final" }, "DiagnosticImagingReferral": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "department": { "type": "string", "format": "uri" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "ward": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status315Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "referral_remarks": { "type": "string", "nullable": true }, "answer_remarks": { "type": "string", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "internal_notes_user": { "type": "string", "format": "uri", "nullable": true }, "internal_notes_modified": { "type": "string", "format": "date-time", "nullable": true }, "referral_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "answer_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "answer_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "diagnosis": { "type": "string", "nullable": true }, "diagnosis_user": { "type": "string", "format": "uri", "nullable": true }, "diagnosis_modified": { "type": "string", "format": "date-time", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "responsible_radiologist": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client", "created", "department", "id", "modified", "patient", "url" ] }, "DiagnosticImagingReferralRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "external_id": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "department": { "type": "string", "format": "uri" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "ward": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status315Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "referral_remarks": { "type": "string", "nullable": true }, "answer_remarks": { "type": "string", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "internal_notes_user": { "type": "string", "format": "uri", "nullable": true }, "internal_notes_modified": { "type": "string", "format": "date-time", "nullable": true }, "referral_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "answer_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "answer_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "diagnosis": { "type": "string", "nullable": true }, "diagnosis_user": { "type": "string", "format": "uri", "nullable": true }, "diagnosis_modified": { "type": "string", "format": "date-time", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "responsible_radiologist": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client", "department", "patient" ] }, "DiagnosticImagingWorklist": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "department": { "type": "integer" }, "date": { "type": "string", "format": "date", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status315Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "consultation_id": { "type": "integer" }, "supervising_veterinarian": { "type": "string" }, "user": { "type": "string" }, "user_initials": { "type": "string" }, "modality": { "type": "string" }, "modality_type": { "type": "integer" }, "modality_procedure": { "type": "string" }, "modality_dicom_ae_title": { "type": "string" }, "modality_callsign": { "type": "string" }, "modality_list_format": { "type": "integer" }, "referral_remarks": { "type": "string" }, "supervising_veterinarian_user_initials": { "type": "string" }, "client": { "type": "integer" }, "patient": { "type": "integer" }, "patient_id": { "type": "integer" }, "patient_name": { "type": "string" }, "patient_date_of_birth": { "type": "string", "format": "date" }, "patient_gender": { "type": "integer" }, "patient_weight": { "type": "string", "readOnly": true }, "patient_remarks": { "type": "string" }, "client_name": { "type": "string", "readOnly": true }, "target_areas": { "type": "string", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modality_type_abbreviation": { "type": "string", "readOnly": true }, "referral_id": { "type": "integer", "nullable": true }, "time": { "type": "string", "format": "time", "nullable": true } }, "required": [ "client", "client_name", "created", "department", "id", "modality", "modality_callsign", "modality_dicom_ae_title", "modality_list_format", "modality_type", "modality_type_abbreviation", "patient", "patient_date_of_birth", "patient_gender", "patient_id", "patient_name", "patient_remarks", "patient_weight", "referral_remarks", "supervising_veterinarian", "target_areas", "user" ] }, "DiagnosticImagingWorklistCreateUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "date": { "type": "string", "format": "date", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status315Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "modality": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "target_areas": { "type": "array", "items": { "type": "string", "format": "uri" } }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "time": { "type": "string", "format": "time", "nullable": true } }, "required": [ "client", "created", "department", "id", "modality", "patient", "url" ] }, "DiagnosticImagingWorklistCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "date": { "type": "string", "format": "date", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status315Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "modality": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "target_areas": { "type": "array", "items": { "type": "string", "format": "uri" } }, "time": { "type": "string", "format": "time", "nullable": true } }, "required": [ "client", "department", "modality", "patient" ] }, "DischargeInstructions": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "nullable": true }, "text": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "modified_session": { "type": "string", "nullable": true, "maxLength": 63 }, "printed_at": { "type": "string", "format": "date-time", "nullable": true }, "merge_by_field": { "type": "string", "readOnly": true } }, "required": [ "consultation", "created", "merge_by_field", "modified" ] }, "DischargeInstructionsRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "nullable": true }, "text": { "type": "string", "minLength": 1, "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "modified_session": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 63 }, "printed_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "consultation" ] }, "DiscountScheme": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 127 }, "default_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_sum": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "internal_notes": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "times": { "type": "array", "items": { "type": "string", "format": "uri" } }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "targets": { "type": "array", "items": { "type": "string", "format": "uri" } }, "bulk_discounts": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "bulk_discounts", "department", "id", "items", "name", "targets", "times", "url" ] }, "DiscountSchemeBulkDiscountDetails": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "quantity_min": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "title": "From" }, "quantity_max": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "title": "To" }, "discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true } }, "required": [ "id", "quantity_max", "quantity_min", "url" ] }, "DiscountSchemeBulkDiscountUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity_min": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "title": "From" }, "quantity_max": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "title": "To" }, "discount": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 } }, "required": [ "discount", "quantity_max", "quantity_min" ] }, "DiscountSchemeBulkDiscountUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity_min": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "title": "From" }, "quantity_max": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "title": "To" }, "discount": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 } }, "required": [ "discount", "quantity_max", "quantity_min" ] }, "DiscountSchemeItemDetails": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "rule_type": { "allOf": [ { "$ref": "#/components/schemas/RuleTypeAfbEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "item_types": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTypesEnum" } }, "item_subgroups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "estimate_templates": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "estimate_templates", "id", "item_types", "rule_type", "url" ] }, "DiscountSchemeItemUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "rule_type": { "$ref": "#/components/schemas/RuleTypeAfbEnum" }, "discount": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 }, "item_types": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTypesEnum" } }, "item_subgroups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "estimate_templates": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "rule_type" ] }, "DiscountSchemeItemUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "rule_type": { "$ref": "#/components/schemas/RuleTypeAfbEnum" }, "discount": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 }, "item_types": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTypesEnum" } }, "item_subgroups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "estimate_templates": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "rule_type" ] }, "DiscountSchemePartialUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 127 }, "default_discount": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 }, "minimum_sum": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "internal_notes": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true } }, "required": [ "default_discount", "department", "name", "url" ] }, "DiscountSchemeTargetDetails": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "rule_type": { "allOf": [ { "$ref": "#/components/schemas/RuleType4b6Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "clients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "species": { "type": "string" } }, "required": [ "id", "rule_type", "species", "url" ] }, "DiscountSchemeTargetUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "rule_type": { "allOf": [ { "$ref": "#/components/schemas/RuleType4b6Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "clients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "species": { "type": "string" } }, "required": [ "rule_type" ] }, "DiscountSchemeTargetUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "rule_type": { "allOf": [ { "$ref": "#/components/schemas/RuleType4b6Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "clients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "species": { "type": "string" } }, "required": [ "rule_type" ] }, "DiscountSchemeTimeDetails": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "discount_scheme": { "type": "string", "format": "uri" }, "rule_type": { "allOf": [ { "$ref": "#/components/schemas/RuleType3ebEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "weekdays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekdaysEnum" } }, "start_time": { "type": "string", "format": "time", "nullable": true }, "end_time": { "type": "string", "format": "time", "nullable": true } }, "required": [ "discount_scheme", "id", "rule_type", "url", "weekdays" ] }, "DiscountSchemeTimeUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "rule_type": { "$ref": "#/components/schemas/RuleType3ebEnum" }, "weekdays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekdaysEnum" } }, "start_time": { "type": "string", "format": "time", "nullable": true }, "end_time": { "type": "string", "format": "time", "nullable": true } }, "required": [ "rule_type", "weekdays" ] }, "DiscountSchemeTimeUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "rule_type": { "$ref": "#/components/schemas/RuleType3ebEnum" }, "weekdays": { "type": "array", "items": { "$ref": "#/components/schemas/WeekdaysEnum" } }, "start_time": { "type": "string", "format": "time", "nullable": true }, "end_time": { "type": "string", "format": "time", "nullable": true } }, "required": [ "rule_type", "weekdays" ] }, "DiscountSchemeUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 127 }, "default_discount": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 }, "minimum_sum": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "internal_notes": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "times": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeTimeUpdate" } }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeTargetUpdate" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeItemUpdate" } }, "bulk_discounts": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeBulkDiscountUpdate" } } }, "required": [ "default_discount", "department", "items", "minimum_sum", "name", "targets", "url" ] }, "DiscountSchemeUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 127 }, "default_discount": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 }, "minimum_sum": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "internal_notes": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "times": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeTimeUpdateRequest" } }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeTargetUpdateRequest" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeItemUpdateRequest" } }, "bulk_discounts": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeBulkDiscountUpdateRequest" } } }, "required": [ "default_discount", "department", "items", "minimum_sum", "name", "targets" ] }, "DispenseFeeRepetitionsEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - No handling fee\n* `2` - Once\n* `3` - Once a day\n* `4` - Every time" }, "DocumentTypeEnum": { "enum": [ "note", "health_plan" ], "type": "string", "description": "* `note` - note\n* `health_plan` - health_plan" }, "ElectronicPrescription": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "prescriber": { "type": "string", "format": "uri", "nullable": true }, "department": { "type": "string", "format": "uri" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status5c4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "client": { "type": "string", "format": "uri", "nullable": true }, "pharmacy_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "archived": { "type": "boolean" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "created", "department", "items", "modified", "patients", "url" ] }, "ElectronicPrescriptionDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "prescriber": { "type": "string", "format": "uri", "nullable": true }, "department": { "type": "string", "format": "uri" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status5c4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "client": { "type": "string", "format": "uri", "nullable": true }, "pharmacy_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "archived": { "type": "boolean" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "uuid": { "type": "string", "format": "uuid" }, "prescription_set_uuid": { "type": "string", "format": "uuid" }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "remarks": { "type": "string", "nullable": true }, "created_user": { "type": "string", "format": "uri" }, "modified_user": { "type": "string", "format": "uri" }, "modified_session": { "type": "string", "nullable": true, "maxLength": 63 }, "issue_time": { "type": "string", "format": "date-time" }, "is_order": { "type": "boolean" }, "is_payment": { "type": "boolean" }, "prescription_order": { "type": "string", "format": "uri", "nullable": true }, "payment_details": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "created_user", "department", "issue_time", "items", "modified", "modified_user", "patients", "url" ] }, "ElectronicPrescriptionItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "package_size": { "type": "string", "nullable": true, "maxLength": 255 }, "package_details": { "type": "string", "nullable": true, "maxLength": 255 }, "product_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "product_nplid": { "type": "string", "readOnly": true }, "article_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "article_nplpackid": { "type": "string", "readOnly": true }, "row_id": { "type": "string", "maxLength": 4 }, "license_id": { "type": "string", "nullable": true, "maxLength": 20 }, "pharmacy_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "prescription": { "type": "string", "format": "uri" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "valid_until": { "type": "string", "format": "date", "nullable": true }, "indication": { "type": "string", "nullable": true, "readOnly": true }, "dosage_form": { "type": "string", "readOnly": true }, "strength": { "type": "string", "nullable": true, "maxLength": 20 }, "quantity": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unit_description": { "$ref": "#/components/schemas/UnitDescriptionEnum" }, "package_content": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "quantity_packages": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "prescribed_medicine": { "type": "string", "readOnly": true }, "withdrawal_periods": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "atc_code": { "type": "string", "nullable": true, "maxLength": 63 } }, "required": [ "article_nplpackid", "created", "dosage_form", "indication", "modified", "name", "patients", "prescribed_medicine", "prescription", "product_nplid", "quantity_packages", "row_id", "url", "withdrawal_periods" ] }, "ElectronicPrescriptionItemDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "package_size": { "type": "string", "nullable": true, "maxLength": 255 }, "package_details": { "type": "string", "nullable": true, "maxLength": 255 }, "product_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "product_nplid": { "type": "string", "readOnly": true }, "article_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "article_nplpackid": { "type": "string", "readOnly": true }, "row_id": { "type": "string", "maxLength": 4 }, "license_id": { "type": "string", "nullable": true, "maxLength": 20 }, "pharmacy_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "prescription": { "type": "string", "format": "uri" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "valid_until": { "type": "string", "format": "date", "nullable": true }, "indication": { "type": "string", "nullable": true, "readOnly": true }, "dosage_form": { "type": "string", "readOnly": true }, "strength": { "type": "string", "nullable": true, "maxLength": 20 }, "quantity": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unit_description": { "$ref": "#/components/schemas/UnitDescriptionEnum" }, "package_content": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "quantity_packages": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "prescribed_medicine": { "type": "string", "readOnly": true }, "withdrawal_periods": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "atc_code": { "type": "string", "nullable": true, "maxLength": 63 }, "latest_dispensing": { "type": "string", "format": "date", "nullable": true }, "instructions": { "type": "string", "nullable": true, "maxLength": 254 }, "language": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ElectronicPrescriptionItemDetailLanguageEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "repeat_number": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "repeat_timevalue": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "repeat_timeunit": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RepeatTimeunitEnum" }, { "$ref": "#/components/schemas/BlankEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "patient_identification": { "type": "string", "nullable": true, "maxLength": 120 }, "patient_id_qualifier": { "$ref": "#/components/schemas/PatientIdQualifierEnum" }, "patient_species": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PatientSpeciesEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "supplimentary_information": { "type": "string", "nullable": true, "maxLength": 50 }, "created_user": { "type": "string", "format": "uri" }, "modified_user": { "type": "string", "format": "uri" }, "copied_from": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "article_nplpackid", "created", "created_user", "dosage_form", "indication", "modified", "modified_user", "name", "patients", "prescribed_medicine", "prescription", "product_nplid", "quantity_packages", "row_id", "url", "withdrawal_periods" ] }, "ElectronicPrescriptionItemDetailLanguageEnum": { "enum": [ "de", "en", "fi", "et", "hu", "sv", "no", "da", "is", "ru", "cs", "es", "ca", "fr", "it", "lt", "lv", "nl", "pl", "pt", "ro", "th", "bg" ], "type": "string", "description": "* `de` - German\n* `en` - English\n* `fi` - Finnish\n* `et` - Estonian\n* `hu` - Hungarian\n* `sv` - Swedish\n* `no` - Norwegian\n* `da` - Danish\n* `is` - Icelandic\n* `ru` - Russian\n* `cs` - Czech\n* `es` - Spanish\n* `ca` - Catalan\n* `fr` - French\n* `it` - Italian\n* `lt` - Lithuanian\n* `lv` - Latvian\n* `nl` - Dutch\n* `pl` - Polish\n* `pt` - Portuguese\n* `ro` - Romanian\n* `th` - Thai\n* `bg` - Bulgarian" }, "EmailLog": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "sent_time": { "type": "string", "format": "date-time" }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusCc4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "department": { "type": "string", "format": "uri", "nullable": true }, "sender": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "email_address": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "subject": { "type": "string", "nullable": true }, "message_id": { "type": "string", "nullable": true, "maxLength": 63 } }, "required": [ "created", "modified", "sent_time", "status", "url" ] }, "EmailLogDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "sent_time": { "type": "string", "format": "date-time" }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusCc4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "department": { "type": "string", "format": "uri", "nullable": true }, "sender": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "status_check_count": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "status_msg": { "type": "string", "nullable": true }, "success_timestamp": { "type": "string", "format": "date-time", "nullable": true }, "error_reported": { "type": "boolean" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "email_address": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "subject": { "type": "string", "nullable": true }, "message_id": { "type": "string", "nullable": true, "maxLength": 63 } }, "required": [ "created", "id", "modified", "patients", "sent_time", "status" ] }, "EmailMessageEnum": { "enum": [ 1, 3 ], "type": "integer", "description": "* `1` - Use instructions, same for confirmation and reminder\n* `3` - Use additional customised instructions for confirmation and reminder" }, "EndOfDayReport": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status85eEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "fiscal_registration_status": { "type": "integer", "readOnly": true, "nullable": true }, "start_timestamp": { "type": "string", "format": "date-time" }, "end_timestamp": { "type": "string", "format": "date-time", "nullable": true }, "start_amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "end_amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "cash_withdrawal": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "cash_withdrawal_description": { "type": "string", "nullable": true, "maxLength": 1000 }, "description": { "type": "string", "maxLength": 1000 }, "accounted_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true } }, "required": [ "cash_withdrawal", "department", "fiscal_registration_status", "id", "start_amount", "start_timestamp", "url" ] }, "EndOfDayReportDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status85eEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "fiscal_registration_status": { "type": "integer", "readOnly": true, "nullable": true }, "start_timestamp": { "type": "string", "format": "date-time" }, "end_timestamp": { "type": "string", "format": "date-time", "nullable": true }, "start_amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "end_amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "cash_withdrawal": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "cash_withdrawal_description": { "type": "string", "nullable": true, "maxLength": 1000 }, "description": { "type": "string", "maxLength": 1000 }, "user": { "type": "string", "format": "uri", "nullable": true }, "accounting": { "type": "string", "format": "uri", "nullable": true }, "accounted_cash": { "type": "string", "readOnly": true }, "accounted_card": { "type": "string", "readOnly": true }, "accounted_bank": { "type": "string", "readOnly": true }, "accounted_mobile": { "type": "string", "readOnly": true }, "accounted_cheque": { "type": "string", "readOnly": true }, "accounted_voucher": { "type": "string", "readOnly": true }, "accounted_present_card": { "type": "string", "readOnly": true }, "accounted_financing_company": { "type": "string", "readOnly": true }, "accounted_other": { "type": "string", "readOnly": true }, "accounted_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "accounted_corrections_cash": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri" }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri" }, "payments": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "accounted_bank", "accounted_card", "accounted_cash", "accounted_cheque", "accounted_financing_company", "accounted_mobile", "accounted_other", "accounted_present_card", "accounted_voucher", "cash_withdrawal", "created", "department", "fiscal_registration_status", "id", "modified", "start_amount", "start_timestamp", "url" ] }, "EstimateDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "title": { "type": "string", "maxLength": 60 }, "department": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "subtotal": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_subtotal": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_subtotal": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusA2dEnum" } ], "minimum": 0, "maximum": 65535 }, "archived": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "vat_calculation_method": { "allOf": [ { "$ref": "#/components/schemas/VatCalculationMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "determining_price": { "allOf": [ { "$ref": "#/components/schemas/DeterminingPriceEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "notes": { "type": "string", "nullable": true }, "notes_pdf": { "type": "boolean" }, "preference_time": { "type": "string", "format": "date-time", "nullable": true }, "veterinarian": { "type": "string", "format": "uri", "nullable": true }, "estimateitem_set": { "type": "array", "items": { "type": "string", "format": "uri" } }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "estimateitem_set", "id", "modified", "patients", "url" ] }, "EstimateItemDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "estimate": { "type": "string", "format": "uri" }, "item": { "type": "string", "format": "uri" }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unit": { "type": "string", "maxLength": 63 }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "package_description": { "type": "string", "maxLength": 63 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "dispense_fee": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "injection_fee": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "dispense_fee_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "injection_fee_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_default_dispense_fee": { "type": "boolean" }, "min_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "percentage_change": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Price change (%)" }, "min_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_sum_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_sum_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_sum_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_sum_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "declined": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "estimate", "id", "item", "modified", "name", "type_code", "url" ] }, "EstimateItemList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "estimate": { "type": "string", "format": "uri" }, "item": { "type": "string", "format": "uri" }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unit": { "type": "string", "maxLength": 63 }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true } }, "required": [ "estimate", "id", "item", "name", "type_code", "url" ] }, "EstimateItemTemplateUse": { "type": "object", "description": "Serializer for bundle template usage on estimates.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "estimate": { "type": "string", "format": "uri" }, "base_template": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 }, "only_title_on_estimate": { "type": "boolean" }, "show_items_in_bundle_on_estimate": { "type": "boolean" }, "use_fixed_price": { "type": "boolean" }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "subtotal": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "total": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true } }, "required": [ "base_template", "estimate", "id", "name", "subtotal", "total", "url", "vat" ] }, "EstimateList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "title": { "type": "string", "maxLength": 60 }, "department": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "subtotal": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_subtotal": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "min_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_subtotal": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "max_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusA2dEnum" } ], "minimum": 0, "maximum": 65535 }, "archived": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "id", "modified", "patients", "url" ] }, "EventEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Pet shared\n* `2` - Invoice finalized" }, "EveryNDaysEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "* `1` - Every day\n* `2` - Every other day\n* `3` - Every third day\n* `4` - Ever fourth day\n* `5` - Every fifth day\n* `6` - Every sixth day\n* `7` - Every seventh day" }, "ExplanationCodeEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Cooling Off\n* `2` - Ordinary Termination" }, "ExternalStatusEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Not sent\n* `2` - Sending\n* `3` - Sent\n* `4` - Ready" }, "ExternalSystemEnum": { "enum": [ 1 ], "type": "integer", "description": "* `1` - Referral portal" }, "ExternalTypeEnum": { "enum": [ 2, 3, 4 ], "type": "integer", "description": "* `2` - IDEXX\n* `3` - Labterm\n* `4` - External laboratory" }, "ExternalVaccination": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "vaccination_disease": { "type": "string", "default": [] }, "given_date": { "type": "string", "format": "date-time" }, "expiry_date": { "type": "string", "format": "date", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "given_date", "id", "modified", "name" ] }, "ExternalVaccinationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "vaccination_disease": { "type": "string", "default": [] }, "given_date": { "type": "string", "format": "date-time" }, "expiry_date": { "type": "string", "format": "date", "nullable": true } }, "required": [ "given_date", "name" ] }, "FieldTypeEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "* `1` - Text\n* `2` - Integer\n* `3` - Date\n* `4` - Check box\n* `5` - JSON field\n* `6` - Select\n* `7` - Multi Select" }, "FiscalData": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "invoice": { "type": "string", "format": "uri" }, "invoice_payment": { "type": "string", "format": "uri" }, "unallocated_payment": { "type": "string", "format": "uri" }, "fiscal_data_content": {} }, "required": [ "id", "url" ] }, "FiscalDataRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "invoice": { "type": "string", "format": "uri" }, "invoice_payment": { "type": "string", "format": "uri" }, "unallocated_payment": { "type": "string", "format": "uri" }, "fiscal_data_content": {} } }, "FoodList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "hide_on_consultation_search": { "type": "boolean" }, "hide_on_countersale_search": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri", "readOnly": true }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true }, "archived": { "type": "boolean" }, "item_list": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "main_item": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "alert_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "optimum_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "title": "Optimum level (packages)" }, "not_in_stock_management": { "type": "boolean" }, "discontinued_product": { "type": "boolean", "description": "These items can no longer be added into orders" }, "unit": { "type": "string", "nullable": true, "maxLength": 63 }, "default_order_amount": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "manufacturer": { "nullable": true }, "shelf_location": { "type": "string", "nullable": true, "maxLength": 63 }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "default_usage_size": { "allOf": [ { "$ref": "#/components/schemas/DefaultUsageSizeEnum" } ], "description": "USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2\n\n* `1` - Package\n* `2` - Units", "minimum": -32768, "maximum": 32767 }, "manufacturer_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "allow_home_delivery": { "type": "boolean" }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 }, "primary_wholesaler_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID of the primary wholesaler for this stock item. Null on non-stock items (procedures) or when unset." }, "primary_wholesaler_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Wholesaler-specific product code for the primary wholesaler. Null on non-stock items or when unset." } }, "required": [ "created", "id", "item_list", "main_item", "modified", "name", "polymorphic_ctype", "primary_wholesaler_code", "primary_wholesaler_id", "type_code", "url", "vat_group" ] }, "FromPharmacyEnum": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "* `0` - -----\n* `1` - Administered\n* `2` - Dispensed\n* `3` - Dispensed and Administered" }, "Gender2e2Enum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "* `0` - Unknown\n* `1` - Male\n* `2` - Female\n* `3` - Male, neutered\n* `4` - Female, neutered\n* `5` - Gelding\n* `6` - Mare\n* `7` - Stallion" }, "GeneralPrescriptionItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "name": { "type": "string", "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "nullable": true, "maxLength": 63 }, "package_description": { "type": "string", "nullable": true, "maxLength": 63 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "withdrawal_periods": { "type": "string", "nullable": true }, "numeric_withdrawal_periods": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationMedicineWithdrawalPeriod" }, "readOnly": true }, "refills": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "dosage_form": { "type": "string", "nullable": true, "maxLength": 254 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "prescription": { "type": "string", "format": "uri" }, "item": { "type": "string", "format": "uri" }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "medicine_metadata": { "type": "string", "format": "uri" } }, "required": [ "created", "id", "item", "medicine_metadata", "modified", "name", "numeric_withdrawal_periods", "prescription", "url" ] }, "GeneralPrescriptionItemDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "name": { "type": "string", "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "nullable": true, "maxLength": 63 }, "package_description": { "type": "string", "nullable": true, "maxLength": 63 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "withdrawal_periods": { "type": "string", "nullable": true }, "numeric_withdrawal_periods": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationMedicineWithdrawalPeriod" }, "readOnly": true }, "refills": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "dosage_form": { "type": "string", "nullable": true, "maxLength": 254 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "prescription": { "type": "string", "format": "uri" }, "item": { "type": "string", "format": "uri" }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "medicine_metadata": { "type": "string", "format": "uri" } }, "required": [ "created", "id", "item", "medicine_metadata", "modified", "name", "numeric_withdrawal_periods", "prescription", "url" ] }, "GoAfterEnum": { "enum": [ "dashboard", "consultation", "previous_page" ], "type": "string", "description": "* `dashboard` - dashboard\n* `consultation` - consultation\n* `previous_page` - previous_page" }, "Group": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 150 } }, "required": [ "id", "name", "url" ] }, "HealthPlan": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "display_name": { "type": "string", "maxLength": 255 }, "department": { "type": "string", "format": "uri", "nullable": true }, "additional_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "species": { "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status36bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "monthly_fee": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "transferable": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "billing_day": { "type": "integer", "readOnly": true }, "plan_price": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true, "description": "Price of the first term, as billed: the initial payment, if any, takes the first month's place. A renewal charges months x monthly_fee. Null for a draft template without a term length yet." }, "internal_name": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "weight_min": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "weight_max": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "age_min": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "age_max": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "ongoing": { "type": "boolean" }, "validity_start": { "type": "string", "format": "date", "nullable": true }, "validity_end": { "type": "string", "format": "date", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "invoicing_item": { "type": "string", "format": "uri", "nullable": true }, "compensation_item": { "type": "string", "format": "uri", "nullable": true }, "cancellation_fee_item": { "type": "string", "format": "uri", "nullable": true }, "default_renewal": { "allOf": [ { "$ref": "#/components/schemas/DefaultRenewalEnum" } ], "minimum": 0, "maximum": 65535 }, "default_renewal_plan": { "type": "string", "format": "uri", "nullable": true }, "healthplanitem_set": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "item_groups": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true } }, "required": [ "billing_day", "created", "display_name", "healthplanitem_set", "id", "internal_name", "item_groups", "modified", "plan_price", "species", "url" ] }, "HealthPlanCancellationPolicy": { "type": "object", "description": "The organization's current cancellation policy, shown before signup.\n\nv1 carries only the fee: the statutory cooling-off text is platform copy,\nand richer policy content does not exist as data. Amounts are flat\ndecimals without a currency: the health plan endpoints do not carry the\norg currency, clients read it once from the organization settings API.", "properties": { "cancellation_fee": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true } }, "required": [ "cancellation_fee" ] }, "HealthPlanItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "health_plan": { "type": "string", "format": "uri", "nullable": true }, "health_plan_item_group": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "name": { "type": "string", "maxLength": 255 }, "price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "unit": { "type": "string", "maxLength": 63 }, "package_description": { "type": "string", "maxLength": 63 }, "per_consultation": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unlimited_use": { "type": "boolean" }, "use_after_expiry": { "type": "boolean" }, "days_after_expiry": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "dosage_units", "id", "item", "modified", "name", "type_code", "url" ] }, "HealthPlanItemGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "health_plans": { "type": "array", "items": { "type": "string", "format": "uri" } }, "name": { "type": "string", "maxLength": 255 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status36bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "item_list": { "type": "string", "format": "uri" }, "usable_items_quantity": { "type": "integer", "maximum": 65535, "minimum": 0 }, "total_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "total_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unlimited_use": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "healthplanitem_set": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true } }, "required": [ "created", "healthplanitem_set", "id", "item_list", "modified", "name", "total_price", "url" ] }, "HealthPlanItemGroupList": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "health_plans": { "type": "array", "items": { "type": "string", "format": "uri" } }, "name": { "type": "string", "maxLength": 255 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status36bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "item_list": { "type": "string", "format": "uri" }, "usable_items_quantity": { "type": "integer", "maximum": 65535, "minimum": 0 }, "total_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "total_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unlimited_use": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "health_plans", "id", "item_list", "modified", "name", "url" ] }, "HealthPlanItemGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "health_plans": { "type": "array", "items": { "type": "string", "format": "uri" } }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status36bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "item_list": { "type": "string", "format": "uri" }, "usable_items_quantity": { "type": "integer", "maximum": 65535, "minimum": 0 }, "total_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unlimited_use": { "type": "boolean" } }, "required": [ "item_list", "name" ] }, "HealthPlanItemList": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "health_plan": { "type": "string", "format": "uri", "nullable": true }, "health_plan_item_group": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "name": { "type": "string", "maxLength": 255 }, "price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } }, "required": [ "id", "item", "name", "type_code", "url" ] }, "HealthPlanItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "health_plan": { "type": "string", "format": "uri", "nullable": true }, "health_plan_item_group": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "unit": { "type": "string", "minLength": 1, "maxLength": 63 }, "package_description": { "type": "string", "minLength": 1, "maxLength": 63 }, "per_consultation": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unlimited_use": { "type": "boolean" }, "use_after_expiry": { "type": "boolean" }, "days_after_expiry": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "item", "name", "type_code" ] }, "HealthPlanList": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "display_name": { "type": "string", "maxLength": 255 }, "department": { "type": "string", "format": "uri", "nullable": true }, "additional_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "species": { "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status36bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "monthly_fee": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "transferable": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "billing_day": { "type": "integer", "readOnly": true }, "plan_price": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true, "description": "Price of the first term, as billed: the initial payment, if any, takes the first month's place. A renewal charges months x monthly_fee. Null for a draft template without a term length yet." } }, "required": [ "additional_departments", "billing_day", "created", "display_name", "id", "modified", "plan_price", "species", "url" ] }, "HealthPlanRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "display_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "department": { "type": "string", "format": "uri", "nullable": true }, "additional_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "species": { "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status36bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "monthly_fee": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "transferable": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "internal_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "weight_min": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "weight_max": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "age_min": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "age_max": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "ongoing": { "type": "boolean" }, "validity_start": { "type": "string", "format": "date", "nullable": true }, "validity_end": { "type": "string", "format": "date", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "invoicing_item": { "type": "string", "format": "uri", "nullable": true }, "compensation_item": { "type": "string", "format": "uri", "nullable": true }, "cancellation_fee_item": { "type": "string", "format": "uri", "nullable": true }, "default_renewal": { "allOf": [ { "$ref": "#/components/schemas/DefaultRenewalEnum" } ], "minimum": 0, "maximum": 65535 }, "default_renewal_plan": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "display_name", "internal_name", "species" ] }, "HeartRate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "heart_rate": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "id", "timestamp" ] }, "HeartRateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "heart_rate": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "timestamp" ] }, "HomeDeliveryClientData": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "home_delivery_order": { "type": "string", "format": "uri" }, "title": { "type": "string", "nullable": true, "maxLength": 32 }, "first_name": { "type": "string", "maxLength": 127 }, "last_name": { "type": "string", "maxLength": 127 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "maxLength": 255 }, "street_address_3": { "type": "string", "nullable": true, "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "state": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country": { "nullable": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US).\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe", "oneOf": [ { "$ref": "#/components/schemas/CountryEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, US-CA).", "maxLength": 100 }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 } }, "required": [ "city", "home_delivery_order", "street_address", "url", "zip_code" ] }, "HomeDeliveryDepartmentData": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "home_delivery_order": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "state": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country": { "nullable": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US).\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe", "oneOf": [ { "$ref": "#/components/schemas/CountryEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, US-CA).", "maxLength": 100 } }, "required": [ "city", "home_delivery_order", "name", "street_address", "url", "zip_code" ] }, "HomeDeliveryItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "invoice": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "nullable": true }, "internal_status": { "allOf": [ { "$ref": "#/components/schemas/InternalStatus5bbEnum" } ], "minimum": 0, "maximum": 65535 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0ddEnum" } ], "minimum": 0, "maximum": 65535 }, "order": { "type": "string", "format": "uri", "title": "Home delivery order" }, "invoice_row": { "type": "string", "format": "uri" }, "prescriber": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "package_description": { "type": "string", "nullable": true, "maxLength": 63 }, "unit": { "type": "string", "nullable": true, "maxLength": 63 }, "name": { "type": "string", "maxLength": 255 }, "instructions": { "type": "string", "nullable": true }, "dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "code": { "type": "string", "maxLength": 40 }, "health_plan": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "consultation_start_date": { "type": "string", "format": "date-time", "nullable": true }, "consultation_end_date": { "type": "string", "format": "date-time", "nullable": true }, "patient_data": { "$ref": "#/components/schemas/HomeDeliveryPatientData" } }, "required": [ "invoice", "invoice_row", "item", "name", "order", "url" ] }, "HomeDeliveryItemStatusUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "order": { "type": "string", "format": "uri", "readOnly": true, "title": "Home delivery order" }, "internal_status": { "allOf": [ { "$ref": "#/components/schemas/InternalStatus5bbEnum" } ], "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status0ddEnum" } ], "minimum": 0, "maximum": 65535 } }, "required": [ "internal_status", "order", "status", "url" ] }, "HomeDeliveryItemStatusUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/Status0ddEnum" } ], "minimum": 0, "maximum": 65535 } }, "required": [ "status" ] }, "HomeDeliveryOrder": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "internal_status": { "allOf": [ { "$ref": "#/components/schemas/HomeDeliveryOrderInternalStatusEnum" } ], "minimum": 0, "maximum": 65535 }, "client": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "client_data": { "$ref": "#/components/schemas/HomeDeliveryClientData" }, "department_data": { "$ref": "#/components/schemas/HomeDeliveryDepartmentData" }, "home_delivery_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "client", "department", "home_delivery_items", "url" ] }, "HomeDeliveryOrderInternalStatusEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Active\n* `2` - Archived" }, "HomeDeliveryPatientData": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "species": { "type": "string", "nullable": true, "maxLength": 127 }, "breed": { "type": "string", "nullable": true, "maxLength": 127 }, "weight": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true } }, "required": [ "url" ] }, "HookNotification": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "active": { "type": "boolean" }, "attempts": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "object_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "param_name": { "type": "string", "maxLength": 255 }, "success": { "type": "boolean" }, "url": { "type": "string", "maxLength": 255 }, "webhook": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "id", "modified", "object_id", "param_name", "url" ] }, "ImagingCategoryDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 50 }, "modality": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department": { "type": "string", "format": "uri" }, "target_areas": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "boolean" } }, "required": [ "department", "id", "modality", "name", "target_areas", "url" ] }, "ImagingCategoryList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 50 }, "modality": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department": { "type": "string", "format": "uri" }, "archived": { "type": "boolean" } }, "required": [ "department", "id", "modality", "name", "url" ] }, "ImagingSubCategoryDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 50 }, "category": { "type": "string", "format": "uri" }, "is_package": { "type": "boolean" }, "is_fixed": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "procedure": { "type": "string", "format": "uri", "nullable": true }, "procedures": { "type": "array", "items": { "type": "string", "format": "uri" } }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "target_areas": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "boolean" } }, "required": [ "category", "department", "id", "name", "procedures", "target_areas", "url" ] }, "ImagingSubCategoryList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 50 }, "category": { "type": "string", "format": "uri" }, "is_package": { "type": "boolean" }, "is_fixed": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "procedure": { "type": "string", "format": "uri", "nullable": true }, "procedures": { "type": "array", "items": { "type": "string", "format": "uri" } }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "archived": { "type": "boolean" } }, "required": [ "category", "department", "id", "name", "procedures", "url" ] }, "ImportedHistory": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "patient": { "type": "string", "format": "uri" }, "document": { "type": "string" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "document", "id", "modified", "patient", "url" ] }, "ImportedHistoryRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "patient": { "type": "string", "format": "uri" }, "document": { "type": "string" } }, "required": [ "document", "patient" ] }, "InsuranceClaim": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/InsuranceClaimStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "compensation": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "case_number": { "type": "string", "nullable": true, "maxLength": 255 }, "reference_number": { "type": "string", "readOnly": true, "nullable": true }, "invoice": { "type": "string", "format": "uri", "readOnly": true, "nullable": true } }, "required": [ "id", "invoice", "reference_number", "url" ] }, "InsuranceClaimClient": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "firstname": { "type": "string", "title": "First name", "maxLength": 127 }, "lastname": { "type": "string", "title": "Last name", "maxLength": 127 }, "organization_name": { "type": "string", "nullable": true, "maxLength": 127 } }, "required": [ "id", "url" ] }, "InsuranceClaimClientDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "firstname": { "type": "string", "title": "First name", "maxLength": 127 }, "lastname": { "type": "string", "title": "Last name", "maxLength": 127 }, "organization_name": { "type": "string", "nullable": true, "maxLength": 127 }, "vat_number": { "type": "string", "maxLength": 31 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 }, "street_address": { "type": "string", "nullable": true, "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "maxLength": 255 }, "street_address_3": { "type": "string", "nullable": true, "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "id_number": { "type": "string", "maxLength": 63 }, "title": { "type": "string", "nullable": true, "maxLength": 32 }, "country": { "type": "string", "readOnly": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US)." }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "claims": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "claims", "country", "id", "url" ] }, "InsuranceClaimDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "patient": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "claim_patient": { "type": "string", "format": "uri", "nullable": true }, "claim_client": { "type": "string", "format": "uri", "nullable": true }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/InsuranceClaimStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "reference_number": { "type": "string", "nullable": true, "maxLength": 255 }, "compensation": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "case_number": { "type": "string", "nullable": true, "maxLength": 255 }, "archived": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri" }, "modified_user": { "type": "string", "format": "uri" } }, "required": [ "client", "created", "created_user", "department", "id", "modified", "modified_user", "patient", "url" ] }, "InsuranceClaimPatient": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 127 } }, "required": [ "id", "name", "url" ] }, "InsuranceClaimPatientDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 127 }, "species": { "type": "string", "description": "species code can be found on active species List" }, "breed": { "type": "string", "nullable": true, "description": "Breed code can be found on actice breed List" }, "gender": { "allOf": [ { "$ref": "#/components/schemas/Gender2e2Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "color": { "type": "string", "nullable": true, "maxLength": 31 }, "critical_notes": { "type": "string", "nullable": true, "maxLength": 255 }, "remarks": { "type": "string", "nullable": true }, "microchip": { "type": "string", "nullable": true, "maxLength": 15 }, "insurance": { "type": "string", "nullable": true, "maxLength": 255 }, "insurance_company": { "type": "string", "format": "uri", "readOnly": true }, "passport_number": { "type": "string", "maxLength": 50 }, "official_name": { "type": "string", "maxLength": 255 }, "claims": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "claims", "gender", "id", "insurance_company", "name", "species", "url" ] }, "InsuranceClaimRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/InsuranceClaimStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "compensation": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "case_number": { "type": "string", "nullable": true, "maxLength": 255 } } }, "InsuranceClaimStatusEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 7, 6, 8, 9, 11 ], "type": "integer", "description": "* `0` - Creating\n* `1` - Created\n* `2` - Sending\n* `3` - Sent\n* `4` - Waiting for info\n* `5` - Ready\n* `7` - Ready, paid\n* `6` - Rejected\n* `8` - Documents sent\n* `9` - Sending timed out\n* `11` - Sending failed" }, "InternalStatus5bbEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Active\n* `2` - Archived\n* `3` - Credited\n* `4` - Replaced" }, "Invoice": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "status": { "type": "integer", "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as an opaque object; actual API value is an integer status code." }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as a Money/string-style schema; actual API returns a numeric Decimal." }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as a Money/string-style schema; actual API returns a numeric Decimal." }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as a Money/string-style schema; actual API returns a numeric Decimal." }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "client_due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "payer_name": { "type": "string", "nullable": true, "maxLength": 255 }, "payer_id_number": { "type": "string", "nullable": true, "maxLength": 63 }, "payer_street_address": { "type": "string", "nullable": true, "maxLength": 255 }, "payer_zip_code": { "type": "string", "nullable": true, "maxLength": 12 }, "payer_city": { "type": "string", "nullable": true, "maxLength": 63 }, "payer_state": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "payer_organization_name": { "type": "string", "nullable": true, "maxLength": 63 }, "payer_register_number": { "type": "string", "nullable": true, "maxLength": 63 }, "payer_vat_number": { "type": "string", "nullable": true, "maxLength": 31 }, "payer_street_address_2": { "type": "string", "nullable": true, "maxLength": 255 }, "payer_street_address_3": { "type": "string", "nullable": true, "maxLength": 255 }, "payer_country": { "type": "string", "readOnly": true, "description": "Payer country name (code is ISO 3166-1 alpha-2)." }, "payer_country_code": { "type": "string", "readOnly": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US)." }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "original_consultation": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "readOnly": true }, "supervising_veterinarian_id": { "type": "integer", "readOnly": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "date_paid": { "type": "string", "format": "date-time", "nullable": true }, "invoice_date": { "type": "string", "format": "date-time" }, "invoice_due_date": { "type": "string", "format": "date", "nullable": true }, "send_date": { "type": "string", "readOnly": true }, "send_method": { "type": "string", "readOnly": true }, "invoice_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "invoice_number": { "type": "string", "readOnly": true }, "invoice_prefix": { "type": "string", "readOnly": true }, "additional_reference": { "type": "string", "readOnly": true }, "countersale": { "type": "boolean" }, "credit_note": { "type": "boolean" }, "credit_note_original_invoice": { "type": "string", "format": "uri", "nullable": true }, "invoice_row": { "type": "array", "items": { "type": "string", "format": "uri" } }, "remarks": { "type": "string", "nullable": true }, "internal_remarks": { "type": "string", "nullable": true }, "health_plan_payments": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "additional_reference", "client", "created", "department", "health_plan_payments", "id", "invoice_extras", "invoice_number", "invoice_prefix", "invoice_row", "modified", "payer_country", "payer_country_code", "send_date", "send_method", "status", "supervising_veterinarian_id", "total", "total_vat", "total_with_vat", "url" ] }, "InvoiceCountryEnum": { "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "KP", "MK", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "KR", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ], "type": "string", "description": "* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe" }, "InvoiceDateEdit": { "type": "object", "properties": { "invoice_date": { "type": "string", "format": "date-time" } }, "required": [ "invoice_date" ] }, "InvoiceDateEditRequest": { "type": "object", "properties": { "invoice_date": { "type": "string", "format": "date-time" } }, "required": [ "invoice_date" ] }, "InvoiceDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true, "description": "URL to this invoice resource" }, "id": { "type": "integer", "readOnly": true, "description": "Unique invoice ID" }, "supervising_veterinarian_id": { "type": "integer", "readOnly": true, "nullable": true }, "invoice_number": { "type": "string", "readOnly": true, "description": "Invoice number (unique within prefix)" }, "invoice_prefix": { "type": "string", "readOnly": true, "description": "Invoice number prefix (e.g., year or series)" }, "reference_number": { "type": "string", "nullable": true, "description": "Reference number for payment", "maxLength": 31 }, "additional_reference": { "type": "string", "readOnly": true }, "status": { "type": "integer", "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as an opaque object; actual API value is an integer status code." }, "inqueries": { "type": "string", "nullable": true, "description": "Number of inquiries/reminders sent", "maxLength": 255 }, "invoice_date": { "type": "string", "format": "date-time", "description": "Invoice issue date (YYYY-MM-DD)" }, "invoice_payed": { "type": "string", "format": "date-time", "nullable": true, "description": "Date when invoice was fully paid" }, "invoice_due_date": { "type": "string", "format": "date", "nullable": true, "description": "Payment due date (YYYY-MM-DD)" }, "penalty_interest": { "type": "number", "format": "double", "maximum": 100, "minimum": -100, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Penalty interest rate for late payment" }, "invoicing_client": { "type": "string", "format": "uri", "nullable": true, "description": "URL to different client who receives the invoice (if applicable)" }, "payer_name": { "type": "string", "nullable": true, "description": "Payer's name (individual or business contact)", "maxLength": 255 }, "payer_id_number": { "type": "string", "nullable": true, "description": "Payer's ID or customer number", "maxLength": 63 }, "payer_street_address": { "type": "string", "nullable": true, "description": "Payer's primary street address", "maxLength": 255 }, "payer_zip_code": { "type": "string", "nullable": true, "description": "Payer's postal code", "maxLength": 12 }, "payer_city": { "type": "string", "nullable": true, "description": "Payer's city", "maxLength": 63 }, "payer_state": { "nullable": true, "description": "Payer's state (for US addresses)\n\n* `AL` - Alabama\n* `AK` - Alaska\n* `AS` - American Samoa\n* `AZ` - Arizona\n* `AR` - Arkansas\n* `AA` - Armed Forces Americas\n* `AE` - Armed Forces Europe\n* `AP` - Armed Forces Pacific\n* `CA` - California\n* `CO` - Colorado\n* `CT` - Connecticut\n* `DE` - Delaware\n* `DC` - District of Columbia\n* `FL` - Florida\n* `GA` - Georgia\n* `GU` - Guam\n* `HI` - Hawaii\n* `ID` - Idaho\n* `IL` - Illinois\n* `IN` - Indiana\n* `IA` - Iowa\n* `KS` - Kansas\n* `KY` - Kentucky\n* `LA` - Louisiana\n* `ME` - Maine\n* `MD` - Maryland\n* `MA` - Massachusetts\n* `MI` - Michigan\n* `MN` - Minnesota\n* `MS` - Mississippi\n* `MO` - Missouri\n* `MT` - Montana\n* `NE` - Nebraska\n* `NV` - Nevada\n* `NH` - New Hampshire\n* `NJ` - New Jersey\n* `NM` - New Mexico\n* `NY` - New York\n* `NC` - North Carolina\n* `ND` - North Dakota\n* `MP` - Northern Mariana Islands\n* `OH` - Ohio\n* `OK` - Oklahoma\n* `OR` - Oregon\n* `PA` - Pennsylvania\n* `PR` - Puerto Rico\n* `RI` - Rhode Island\n* `SC` - South Carolina\n* `SD` - South Dakota\n* `TN` - Tennessee\n* `TX` - Texas\n* `UT` - Utah\n* `VT` - Vermont\n* `VI` - Virgin Islands\n* `VA` - Virginia\n* `WA` - Washington\n* `WV` - West Virginia\n* `WI` - Wisconsin\n* `WY` - Wyoming", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "payer_organization_name": { "type": "string", "nullable": true, "description": "Payer's organization/company name", "maxLength": 63 }, "payer_email": { "type": "string", "format": "email", "nullable": true, "description": "Payer's email address", "maxLength": 100 }, "payer_register_number": { "type": "string", "nullable": true, "description": "Payer's business register number", "maxLength": 63 }, "payer_vat_number": { "type": "string", "nullable": true, "description": "Payer's VAT/tax identification number", "maxLength": 31 }, "payer_street_address_2": { "type": "string", "nullable": true, "description": "Payer's second address line", "maxLength": 255 }, "payer_street_address_3": { "type": "string", "nullable": true, "description": "Payer's third address line", "maxLength": 255 }, "payer_country": { "type": "string", "readOnly": true, "description": "Payer country name (code is ISO 3166-1 alpha-2)." }, "payer_country_code": { "type": "string", "readOnly": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US)." }, "payer_country_region": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. CA-ON)", "maxLength": 100 }, "receiver_name": { "type": "string", "nullable": true, "description": "Receiving organization contact name", "maxLength": 255 }, "receiver_organization_name": { "type": "string", "nullable": true, "description": "Receiving organization/clinic name", "maxLength": 255 }, "receiver_street_address": { "type": "string", "nullable": true, "description": "Receiver's street address", "maxLength": 255 }, "receiver_street_address_2": { "type": "string", "nullable": true, "description": "Receiver's second address line", "maxLength": 255 }, "receiver_zip_code": { "type": "string", "nullable": true, "description": "Receiver's postal code", "maxLength": 12 }, "receiver_city": { "type": "string", "nullable": true, "description": "Receiver's city", "maxLength": 63 }, "receiver_iban": { "type": "string", "nullable": true, "description": "Receiver's IBAN (International Bank Account Number)", "maxLength": 255 }, "receiver_bic": { "type": "string", "nullable": true, "description": "Receiver's BIC/SWIFT code", "maxLength": 255 }, "receiver_national_bank_account": { "type": "string", "nullable": true, "description": "Receiver's national bank account number", "maxLength": 255 }, "receiver_national_bic": { "type": "string", "nullable": true, "description": "Receiver's national BIC code", "maxLength": 255 }, "receiver_vat_number": { "type": "string", "nullable": true, "description": "Receiver's VAT number", "maxLength": 255 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as a Money/string-style schema; actual API returns a numeric Decimal." }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as a Money/string-style schema; actual API returns a numeric Decimal." }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as a Money/string-style schema; actual API returns a numeric Decimal." }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Amount still due (unpaid)" }, "client_due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "description": "Amount due from client" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "invoice_row": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "invoice_payment": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to payment records for this invoice" }, "client": { "type": "string", "readOnly": true }, "consultation": { "type": "string", "format": "uri", "nullable": true, "description": "URL to consultation that generated this invoice" }, "original_consultation": { "type": "string", "format": "uri", "nullable": true, "description": "URL to original consultation if invoice was recreated" }, "department": { "type": "string", "format": "uri", "description": "URL to department that issued this invoice" }, "created": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when invoice was created" }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "description": "Timestamp when invoice was last modified" }, "date_paid": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when invoice was marked as paid" }, "agreed_to_pay_later": { "type": "boolean", "description": "True if client agreed to pay later (credit arrangement)" }, "without_vat": { "type": "boolean", "description": "True if invoice is without VAT (tax-exempt)" }, "countersale": { "type": "boolean", "description": "True if this is a counter sale (immediate payment)" }, "credit_note": { "type": "boolean", "description": "True if this is a credit note (negative invoice)" }, "credit_note_original_invoice": { "type": "string", "format": "uri", "nullable": true, "description": "URL to original invoice this credit note is for" }, "related_credit_note": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to credit notes related to this invoice" }, "related_credit_note_invoice": { "type": "string", "format": "uri", "nullable": true, "description": "URL to invoice related to this credit note" }, "first_original_invoice": { "type": "string", "format": "uri", "nullable": true, "description": "URL to first invoice in chain of credit notes/corrections" }, "consolidated_invoice": { "type": "boolean", "description": "True if this consolidates multiple invoices" }, "consolidated_invoices": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to invoices consolidated into this invoice" }, "related_consolidated_invoice": { "type": "string", "format": "uri", "nullable": true, "description": "URL to consolidated invoice this is part of" }, "remarks": { "type": "string", "nullable": true, "description": "Remarks printed on invoice (visible to client)" }, "internal_remarks": { "type": "string", "nullable": true, "description": "Internal remarks (not visible to client)" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "vat_calculation_method": { "type": "integer", "readOnly": true, "description": "VAT calculation method: 1=Single item, 2=Single invoice row, 3=Invoice total sum", "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "type documented as integer; API has always returned an int" }, "determining_price": { "type": "integer", "readOnly": true, "description": "Price determination: 1=Price including VAT, 2=Price excluding VAT", "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "type documented as integer; API has always returned an int" }, "send_date": { "type": "string", "readOnly": true }, "send_method": { "type": "string", "readOnly": true }, "invoice_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true, "description": "List of URLs to extra line items from appointments" }, "first_printed_pdf": { "type": "string", "format": "uri", "readOnly": true }, "pos_transactions": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to point of sale transaction records" }, "health_plan_payments": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to health plan payment records" } }, "required": [ "additional_reference", "client", "consolidated_invoices", "created", "department", "determining_price", "first_printed_pdf", "health_plan_payments", "id", "invoice_extras", "invoice_number", "invoice_payment", "invoice_prefix", "invoice_row", "modified", "payer_country", "payer_country_code", "pos_transactions", "related_credit_note", "send_date", "send_method", "status", "supervising_veterinarian_id", "total", "total_vat", "total_with_vat", "url", "vat_calculation_method" ] }, "InvoiceExtras": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "invoice": { "type": "string", "format": "uri", "readOnly": true }, "exported": { "type": "string", "format": "date-time", "nullable": true }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "efsta_fiscal_number": { "type": "string", "nullable": true, "maxLength": 64 } }, "required": [ "invoice", "url" ] }, "InvoiceExtrasRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "exported": { "type": "string", "format": "date-time", "nullable": true }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "efsta_fiscal_number": { "type": "string", "nullable": true, "maxLength": 64 } } }, "InvoiceFullRefund": { "type": "object", "properties": { "use_original_invoice_date": { "type": "boolean", "default": false }, "create_commission_rows": { "type": "boolean", "default": false }, "create_as_draft": { "type": "boolean", "default": false }, "eu_company_without_vat": { "type": "boolean", "default": false }, "override_client_vat_group": { "type": "boolean", "default": false, "description": "Overrides VAT based on special VAT group specified for the client" }, "payments": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "Payments to be credited along the refund" }, "payments_action": { "allOf": [ { "$ref": "#/components/schemas/PaymentsActionEnum" } ], "description": "Defines how to handle the payments on original invoice\n\n* `1` - Refund the selected payments\n* `2` - Move the selected to prepayments" } } }, "InvoiceFullRefundRequest": { "type": "object", "properties": { "use_original_invoice_date": { "type": "boolean", "default": false }, "create_commission_rows": { "type": "boolean", "default": false }, "create_as_draft": { "type": "boolean", "default": false }, "eu_company_without_vat": { "type": "boolean", "default": false }, "override_client_vat_group": { "type": "boolean", "default": false, "description": "Overrides VAT based on special VAT group specified for the client" }, "payments": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "Payments to be credited along the refund" }, "payments_action": { "allOf": [ { "$ref": "#/components/schemas/PaymentsActionEnum" } ], "description": "Defines how to handle the payments on original invoice\n\n* `1` - Refund the selected payments\n* `2` - Move the selected to prepayments" } } }, "InvoicePartialRefund": { "type": "object", "properties": { "use_original_invoice_date": { "type": "boolean", "default": false }, "create_commission_rows": { "type": "boolean", "default": false }, "create_as_draft": { "type": "boolean", "default": false }, "eu_company_without_vat": { "type": "boolean", "default": false }, "override_client_vat_group": { "type": "boolean", "default": false, "description": "Overrides VAT based on special VAT group specified for the client" }, "payments": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "Payments to be credited along the refund" }, "payments_action": { "allOf": [ { "$ref": "#/components/schemas/PaymentsActionEnum" } ], "description": "Defines how to handle the payments on original invoice\n\n* `1` - Refund the selected payments\n* `2` - Move the selected to prepayments" }, "invoice_rows": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRowPartialRefund" } } }, "required": [ "invoice_rows" ] }, "InvoicePartialRefundRequest": { "type": "object", "properties": { "use_original_invoice_date": { "type": "boolean", "default": false }, "create_commission_rows": { "type": "boolean", "default": false }, "create_as_draft": { "type": "boolean", "default": false }, "eu_company_without_vat": { "type": "boolean", "default": false }, "override_client_vat_group": { "type": "boolean", "default": false, "description": "Overrides VAT based on special VAT group specified for the client" }, "payments": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "Payments to be credited along the refund" }, "payments_action": { "allOf": [ { "$ref": "#/components/schemas/PaymentsActionEnum" } ], "description": "Defines how to handle the payments on original invoice\n\n* `1` - Refund the selected payments\n* `2` - Move the selected to prepayments" }, "invoice_rows": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRowPartialRefundRequest" } } }, "required": [ "invoice_rows" ] }, "InvoicePaymentCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "invoice": { "type": "string", "format": "uri" }, "payment_type": { "type": "integer" }, "paid": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "info": { "type": "string", "nullable": true, "maxLength": 255 }, "date_added": { "type": "string", "format": "date-time", "nullable": true }, "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status183Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "status_updated": { "type": "string", "format": "date-time", "nullable": true }, "receipt_data": { "type": "string", "nullable": true }, "invoice_payment_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "claim_number": { "type": "integer", "nullable": true } }, "required": [ "created_user", "id", "invoice", "invoice_payment_extras", "paid", "payment_type", "url" ] }, "InvoicePaymentCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "invoice": { "type": "string", "format": "uri" }, "payment_type": { "type": "integer" }, "paid": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "info": { "type": "string", "nullable": true, "maxLength": 255 }, "date_added": { "type": "string", "format": "date-time", "nullable": true }, "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status183Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "status_updated": { "type": "string", "format": "date-time", "nullable": true }, "receipt_data": { "type": "string", "nullable": true }, "claim_number": { "type": "integer", "nullable": true } }, "required": [ "created_user", "invoice", "paid", "payment_type" ] }, "InvoicePaymentDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "invoice": { "type": "string", "format": "uri" }, "invoice_number": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "nullable": true }, "invoice_prefix": { "type": "string", "readOnly": true }, "payment_type": { "type": "string", "readOnly": true }, "paid": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unallocated_payment": { "type": "string", "format": "uri", "nullable": true }, "cancels_payment": { "type": "string", "format": "uri", "nullable": true }, "date_added": { "type": "string", "format": "date-time" }, "info": { "type": "string", "nullable": true, "maxLength": 255 }, "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status183Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "status_updated": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri" }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri" }, "invoice_payment_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "payment_method": { "type": "string", "format": "uri", "nullable": true }, "fiscal_data": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "transaction_terminal": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "date_added", "fiscal_data", "id", "invoice", "invoice_payment_extras", "invoice_prefix", "modified", "paid", "payment_type", "url" ] }, "InvoicePaymentExtras": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "exported": { "type": "string", "format": "date-time", "nullable": true }, "external_id": { "type": "string", "maxLength": 80 }, "metadata": { "type": "string" } }, "required": [ "url" ] }, "InvoicePaymentExtrasRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "exported": { "type": "string", "format": "date-time", "nullable": true }, "external_id": { "type": "string", "maxLength": 80 }, "metadata": { "type": "string" } } }, "InvoicePaymentPartialDetail": { "type": "object", "description": "Updates partial data of an invoice payment.\n\nCurrently only the `status` and `status_updated` fields are supported.", "properties": { "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status183Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "status_updated": { "type": "string", "format": "date-time", "nullable": true } } }, "InvoiceRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "client_due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "payer_name": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "payer_id_number": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 63 }, "payer_street_address": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "payer_zip_code": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 12 }, "payer_city": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 63 }, "payer_state": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "payer_organization_name": { "type": "string", "nullable": true, "maxLength": 63 }, "payer_register_number": { "type": "string", "nullable": true, "maxLength": 63 }, "payer_vat_number": { "type": "string", "nullable": true, "maxLength": 31 }, "payer_street_address_2": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "payer_street_address_3": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "original_consultation": { "type": "string", "format": "uri", "nullable": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "date_paid": { "type": "string", "format": "date-time", "nullable": true }, "invoice_date": { "type": "string", "format": "date-time" }, "invoice_due_date": { "type": "string", "format": "date", "nullable": true }, "countersale": { "type": "boolean" }, "credit_note": { "type": "boolean" }, "credit_note_original_invoice": { "type": "string", "format": "uri", "nullable": true }, "invoice_row": { "type": "array", "items": { "type": "string", "format": "uri" } }, "remarks": { "type": "string", "nullable": true }, "internal_remarks": { "type": "string", "nullable": true }, "health_plan_payments": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "department", "health_plan_payments", "invoice_row" ] }, "InvoiceRowDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "invoice": { "type": "string", "format": "uri" }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "original_consultation": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_group": { "type": "string", "nullable": true, "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "invoicable_units": { "type": "string", "readOnly": true }, "invoiceable_amount": { "type": "number", "format": "double", "description": "Decimal: quantity or unit amount (depends on usage_size) actually used when calculating total sum.\n\nThis property also applies possible measurement loss.", "readOnly": true }, "display_price": { "type": "string", "readOnly": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "original_sum_total": { "type": "string", "readOnly": true }, "discount_amount": { "type": "string", "readOnly": true }, "percentage_change": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Price change (%)" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "prescription": { "type": "boolean" }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "remove_vat": { "type": "boolean" }, "account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "reporting_dimension_1": { "type": "string", "description": "Reporting dimension 1 id can be found on active Reporting dimension 1 list" }, "reporting_dimension_2": { "type": "string", "description": "Reporting dimension 2 id can be found on active Reporting dimension 2 list" }, "reporting_dimension_3": { "type": "string", "description": "Reporting dimension 3 id can be found on active Reporting dimension 3 list" }, "credited_invoicerow": { "type": "string", "format": "uri", "nullable": true }, "first_credited_invoicerow": { "type": "string", "format": "uri", "nullable": true }, "first_credit_invoicerows": { "type": "array", "items": { "type": "string", "format": "uri" } }, "patient": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "readOnly": true }, "linked_items": { "type": "string", "readOnly": true }, "panel": { "type": "string", "format": "uri", "nullable": true }, "order_in_panel": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "additional_tax_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "calculated_price": { "type": "string", "readOnly": true }, "calculated_price_with_vat": { "type": "string", "readOnly": true }, "invoicable_quantity": { "type": "string", "readOnly": true }, "invoicerow_vat_group": { "type": "string", "format": "uri" }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "invoice_row_extra": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "vila_reporting_required": { "type": "boolean", "description": "Cache the invoice-level vila check so only report_to_authorities\n(per-row) is evaluated repeatedly.", "readOnly": true }, "edit_reason": { "type": "string", "nullable": true } }, "required": [ "calculated_price", "calculated_price_with_vat", "created", "discount_amount", "display_price", "first_credit_invoicerows", "id", "invoicable_quantity", "invoicable_units", "invoice", "invoice_row_extra", "invoiceable_amount", "invoicerow_vat_group", "item", "linked_items", "modified", "name", "original_sum_total", "parent_linked_item", "url", "vila_reporting_required" ] }, "InvoiceRowDraftDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "invoice_row": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/InvoiceRowDraftDetailStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "is_cabinet_item": { "type": "boolean" }, "patient": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "packages": { "type": "string", "readOnly": true }, "unit_description": { "type": "string", "readOnly": true }, "package_description": { "type": "string", "readOnly": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "id", "is_cabinet_item", "item", "modified", "package_description", "packages", "unit_description", "url" ] }, "InvoiceRowDraftDetailStatusEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Finished\n* `2` - Draft\n* `3` - Hidden" }, "InvoiceRowExtra": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "invoicerow": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "internal_reporting_dimension_1": { "type": "string", "format": "uri", "nullable": true }, "internal_reporting_dimension_2": { "type": "string", "format": "uri", "nullable": true }, "internal_account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "laboratory_group": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "creator": { "type": "string", "format": "uri", "nullable": true }, "void": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "off_label_medicine": { "type": "boolean" } }, "required": [ "created", "invoicerow", "modified", "url" ] }, "InvoiceRowExtraRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "internal_reporting_dimension_1": { "type": "string", "format": "uri", "nullable": true }, "internal_reporting_dimension_2": { "type": "string", "format": "uri", "nullable": true }, "internal_account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "laboratory_group": { "type": "string", "format": "uri", "nullable": true }, "creator": { "type": "string", "format": "uri", "nullable": true }, "void": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "off_label_medicine": { "type": "boolean" } } }, "InvoiceRowFinalizeDraftDetail": { "type": "object", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "batch_number": { "type": "string" }, "tracking_number": { "type": "integer" }, "expiry_date": { "type": "string", "format": "date" }, "stock_location": { "type": "integer" }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } } }, "InvoiceRowFinalizeDraftDetailRequest": { "type": "object", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "batch_number": { "type": "string", "minLength": 1 }, "tracking_number": { "type": "integer" }, "expiry_date": { "type": "string", "format": "date" }, "stock_location": { "type": "integer" }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } } }, "InvoiceRowPartialRefund": { "type": "object", "properties": { "invoice_row": { "type": "string", "format": "uri", "description": "Invoice rows to refund on invoice" }, "quantity": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_size": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] } }, "required": [ "invoice_row" ] }, "InvoiceRowPartialRefundRequest": { "type": "object", "properties": { "invoice_row": { "type": "string", "format": "uri", "description": "Invoice rows to refund on invoice" }, "quantity": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_size": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] } }, "required": [ "invoice_row" ] }, "InvoiceRowVatGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "title": { "type": "string", "maxLength": 255 }, "percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "archived": { "type": "boolean" }, "account_number": { "type": "string" } }, "required": [ "url" ] }, "InvoiceTypeEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Normal invoice\n* `2` - Credit note\n* `3` - Consolidated invoice" }, "InvoiceUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "invoice_date": { "type": "string", "format": "date-time" }, "invoice_due_date": { "type": "string", "format": "date", "nullable": true }, "agreed_to_pay_later": { "type": "boolean" }, "remarks": { "type": "string", "nullable": true }, "internal_remarks": { "type": "string", "nullable": true } }, "required": [ "url" ] }, "InvoiceUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "invoice_date": { "type": "string", "format": "date-time" }, "invoice_due_date": { "type": "string", "format": "date", "nullable": true }, "agreed_to_pay_later": { "type": "boolean" }, "remarks": { "type": "string", "nullable": true }, "internal_remarks": { "type": "string", "nullable": true } } }, "Item": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "parent": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverride" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "created", "id", "item_list", "modified", "name", "parent", "polymorphic_ctype", "type_code", "url", "vat_group" ] }, "ItemConditionalPriceOverride": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "rule": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "value": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "no_effect": { "type": "boolean" } }, "required": [ "id", "item", "value" ] }, "ItemConditionalPriceOverrideRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "rule": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "value": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "no_effect": { "type": "boolean" } }, "required": [ "item", "value" ] }, "ItemDiagnosisGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "diagnoses": { "type": "string", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "diagnoses", "item", "modified", "url" ] }, "ItemEntry": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "batches": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "batch_numbers": { "type": "string", "readOnly": true }, "tracking_number": { "type": "integer" }, "date_of_entry": { "type": "string", "format": "date-time", "readOnly": true }, "description": { "type": "string", "maxLength": 255 }, "department_id": { "type": "integer" }, "invoicerow": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "inventory_level_packages": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "inventory_level_units": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true, "nullable": true }, "item_id": { "type": "integer" }, "order_item": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "quantity": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ItemEntryTypeEnum" } ], "title": "Usage type", "minimum": -32768, "maximum": 32767 }, "subtype": { "type": "string" }, "stock_item": { "type": "string", "format": "uri" }, "stock_locations": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "wholesale_value": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "created_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true } }, "required": [ "batch_numbers", "batches", "created_user", "date_of_entry", "id", "inventory_level_packages", "inventory_level_units", "invoicerow", "modified", "modified_user", "order_item", "stock_locations", "url", "wholesale_price", "wholesale_value" ] }, "ItemEntryRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "batch": { "type": "string", "format": "uri", "writeOnly": true }, "tracking_number": { "type": "integer" }, "description": { "type": "string", "minLength": 1, "maxLength": 255 }, "department_id": { "type": "integer" }, "item_id": { "type": "integer" }, "units": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "quantity": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ItemEntryTypeEnum" } ], "title": "Usage type", "minimum": -32768, "maximum": 32767 }, "subtype": { "type": "string" }, "stock_item": { "type": "string", "format": "uri" }, "stock_location": { "type": "string", "format": "uri", "writeOnly": true } } }, "ItemEntryTypeEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer", "description": "* `1` - Add\n* `2` - Use\n* `3` - Loss\n* `4` - Measurement loss\n* `5` - Other\n* `6` - Inventory check\n* `7` - Internal move\n* `8` - Expiration\n* `9` - Theft\n* `10` - Cycle count\n* `11` - Revert" }, "ItemList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "hide_on_consultation_search": { "type": "boolean" }, "hide_on_countersale_search": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri", "readOnly": true }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true }, "archived": { "type": "boolean" }, "item_list": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "main_item": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 }, "primary_wholesaler_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID of the primary wholesaler for this stock item. Null on non-stock items (procedures) or when unset." }, "primary_wholesaler_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Wholesaler-specific product code for the primary wholesaler. Null on non-stock items or when unset." } }, "required": [ "created", "id", "item_list", "main_item", "modified", "name", "polymorphic_ctype", "primary_wholesaler_code", "primary_wholesaler_id", "type_code", "url", "vat_group" ] }, "ItemListDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 100 }, "central": { "type": "boolean" } }, "required": [ "id", "name", "url" ] }, "ItemListDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "central": { "type": "boolean" } }, "required": [ "name" ] }, "ItemNavigationSearch": { "type": "object", "description": "A `Serializer` is a model-less serializer class with additional\nsupport for JSON:API spec features.\n\nAs in JSON:API specification a type is always required you need to\nmake sure that you define `resource_name` in your `Meta` class\nwhen deriving from this class.\n\nIncluded Mixins:\n\n* A mixin class to enable sparse fieldsets is included\n* A mixin class to enable validation of included resources is included", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "barcode": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000000, "minimum": -1000000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "code": { "type": "string", "nullable": true }, "print_name": { "type": "string", "nullable": true }, "type_code": { "type": "integer" }, "archived": { "type": "boolean" }, "hide_on_consultation": { "type": "boolean" }, "hide_on_consultation_search": { "type": "boolean" }, "hide_on_countersale_search": { "type": "boolean" }, "item_list_id": { "type": "integer" }, "vat_group_id": { "type": "integer" }, "invoice_group_id": { "type": "integer", "nullable": true }, "active_substance": { "type": "string", "nullable": true }, "species": { "type": "array", "items": { "type": "string" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "item_categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "linked_items": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "main_item_id": { "type": "integer", "nullable": true }, "is_main_item": { "type": "boolean" }, "is_sub_item": { "type": "boolean" }, "highlight": {} }, "required": [ "archived", "hide_on_consultation", "hide_on_consultation_search", "hide_on_countersale_search", "id", "is_main_item", "is_sub_item", "item_list_id", "name", "price", "type_code", "vat_group_id" ] }, "ItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverrideRequest" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "item_list", "name", "type_code", "vat_group" ] }, "ItemSubgroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "title": { "type": "string", "maxLength": 255 }, "type_code": { "type": "integer" }, "account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "account_number_link": { "type": "string", "format": "uri", "nullable": true }, "parent": { "type": "string", "format": "uri", "nullable": true }, "children": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true } }, "required": [ "children", "id", "title", "type_code", "url" ] }, "ItemSubgroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "type_code": { "type": "integer" }, "account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "account_number_link": { "type": "string", "format": "uri", "nullable": true }, "parent": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "title", "type_code" ] }, "ItemTemplate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "notes": { "type": "string", "nullable": true }, "subtotal": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "total": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "prices_up_to_date": { "type": "boolean" }, "use_fixed_price": { "type": "boolean" }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "archived": { "type": "boolean" }, "draft": { "type": "boolean" }, "price_change_org_item": { "type": "string", "format": "uri", "nullable": true }, "no_price_change_in_consultation": { "type": "boolean" }, "only_in_template": { "type": "boolean" }, "only_title_on_invoice": { "type": "boolean" }, "show_items_in_bundle_on_invoice": { "type": "boolean" } }, "required": [ "id", "item_list", "name", "url" ] }, "ItemTemplateDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "notes": { "type": "string", "nullable": true }, "subtotal": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "total": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "prices_up_to_date": { "type": "boolean" }, "template_items": { "type": "string", "readOnly": true }, "use_fixed_price": { "type": "boolean" }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "archived": { "type": "boolean" }, "child_templates": { "type": "string", "readOnly": true }, "draft": { "type": "boolean" }, "price_change_org_item": { "type": "string", "format": "uri", "nullable": true }, "no_price_change_in_consultation": { "type": "boolean" }, "only_in_template": { "type": "boolean" }, "only_title_on_invoice": { "type": "boolean" }, "show_items_in_bundle_on_invoice": { "type": "boolean" } }, "required": [ "child_templates", "id", "item_list", "name", "template_items", "url" ] }, "ItemTemplateItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "template": { "type": "string", "format": "uri" }, "item": { "type": "string", "format": "uri" }, "code": { "type": "string", "maxLength": 40 }, "name": { "type": "string", "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "archived": { "type": "boolean" }, "default_selected": { "allOf": [ { "$ref": "#/components/schemas/DefaultSelectedEnum" } ], "minimum": 0, "maximum": 65535 }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "id", "item", "name", "template", "type_code", "url" ] }, "ItemTemplateItemList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "code": { "type": "string", "maxLength": 40 }, "template": { "type": "string", "format": "uri" }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "id", "name", "template", "url" ] }, "ItemTemplateItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "template": { "type": "string", "format": "uri" }, "item": { "type": "string", "format": "uri" }, "code": { "type": "string", "maxLength": 40 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "archived": { "type": "boolean" }, "default_selected": { "allOf": [ { "$ref": "#/components/schemas/DefaultSelectedEnum" } ], "minimum": 0, "maximum": 65535 }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "item", "name", "template", "type_code" ] }, "ItemTemplateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "notes": { "type": "string", "nullable": true }, "subtotal": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "total": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "prices_up_to_date": { "type": "boolean" }, "use_fixed_price": { "type": "boolean" }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "archived": { "type": "boolean" }, "draft": { "type": "boolean" }, "price_change_org_item": { "type": "string", "format": "uri", "nullable": true }, "no_price_change_in_consultation": { "type": "boolean" }, "only_in_template": { "type": "boolean" }, "only_title_on_invoice": { "type": "boolean" }, "show_items_in_bundle_on_invoice": { "type": "boolean" } }, "required": [ "item_list", "name" ] }, "ItemTypeEnum": { "enum": [ "MEDICINE", "PROCEDURE", "SUPPLY", "FOOD", "LABORATORY_ANALYSIS", "LABORATORY_ANALYSIS_PANEL" ], "type": "string", "description": "* `MEDICINE` - Medicine\n* `PROCEDURE` - Procedure\n* `SUPPLY` - Supply\n* `FOOD` - Food\n* `LABORATORY_ANALYSIS` - Laboratory Analysis\n* `LABORATORY_ANALYSIS_PANEL` - Laboratory Analysis Panel" }, "ItemTypesEnum": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel" }, "JobTypeEnum": { "enum": [ "IMPORT", "ARCHIVE" ], "type": "string", "description": "* `IMPORT` - Legacy Import\n* `ARCHIVE` - Provet Archive" }, "JournalEntry": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "transaction_category": { "allOf": [ { "$ref": "#/components/schemas/TransactionCategoryEnum" } ], "minimum": 0, "maximum": 65535 }, "entry_number": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "department_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "has_problem": { "type": "string", "readOnly": true }, "journal_transactions": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransaction" } } }, "required": [ "department_id", "entry_number", "has_problem", "id", "journal_transactions", "transaction_category", "url" ] }, "JournalEntryProblem": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "transaction_category": { "allOf": [ { "$ref": "#/components/schemas/TransactionCategoryEnum" } ], "minimum": 0, "maximum": 65535 }, "entry_number": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "department_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "journal_transaction_problems": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransactionProblem" } } }, "required": [ "department_id", "entry_number", "id", "journal_transaction_problems", "transaction_category", "url" ] }, "JournalEntryProblemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "transaction_category": { "allOf": [ { "$ref": "#/components/schemas/TransactionCategoryEnum" } ], "minimum": 0, "maximum": 65535 }, "entry_number": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "department_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "journal_transaction_problems": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransactionProblemRequest" } } }, "required": [ "department_id", "entry_number", "journal_transaction_problems", "transaction_category" ] }, "JournalEntryRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "transaction_category": { "allOf": [ { "$ref": "#/components/schemas/TransactionCategoryEnum" } ], "minimum": 0, "maximum": 65535 }, "entry_number": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "department_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "journal_transactions": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransactionRequest" } } }, "required": [ "department_id", "entry_number", "journal_transactions", "transaction_category" ] }, "JournalReportLog": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "report_name": { "type": "string", "nullable": true, "maxLength": 255 }, "created_user": { "type": "string", "nullable": true, "maxLength": 255 }, "created_user_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "created_timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "metadata": { "type": "string" } }, "required": [ "created_timestamp", "id", "url" ] }, "JournalReportLogRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "report_name": { "type": "string", "nullable": true, "maxLength": 255 }, "created_user": { "type": "string", "nullable": true, "maxLength": 255 }, "created_user_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "metadata": { "type": "string" } } }, "JournalTransaction": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "date": { "type": "string", "format": "date" }, "account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "account_name": { "type": "string", "nullable": true, "maxLength": 255 }, "cost_center": { "type": "string", "format": "uri", "readOnly": true }, "cost_center_label": { "type": "string" }, "cost_center_code": { "type": "string", "nullable": true, "readOnly": true }, "project_code": { "type": "string", "format": "uri", "readOnly": true }, "project_code_label": { "type": "string" }, "debit": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "credit": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "discount": { "type": "boolean" }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_number": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_type": { "nullable": true, "minimum": 0, "maximum": 65535, "oneOf": [ { "$ref": "#/components/schemas/InvoiceTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "invoice_row_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "credited_invoice_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "payment_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "client_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "client_name": { "type": "string", "nullable": true, "description": "Paying client's name, from `JournalTransactionQueryset.with_client_names()`.\n\nThat method defines the format and builds the value in SQL. Returns None\nwhen the transaction has no client, the client was permanently deleted,\nor the queryset was not annotated.", "readOnly": true }, "account_type": { "allOf": [ { "$ref": "#/components/schemas/AccountTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "account_group": { "type": "string", "maxLength": 255 }, "created_user": { "type": "string", "nullable": true, "maxLength": 255 }, "created_user_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "created_timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "modification_logged": { "type": "boolean" }, "journal_entry": { "type": "string", "format": "uri" } }, "required": [ "account_group", "account_type", "client_name", "cost_center", "cost_center_code", "cost_center_label", "created_timestamp", "date", "id", "journal_entry", "project_code", "project_code_label", "url" ] }, "JournalTransactionProblem": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "date": { "type": "string", "format": "date" }, "account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "account_name": { "type": "string", "nullable": true, "maxLength": 255 }, "cost_center": { "type": "string", "format": "uri", "readOnly": true }, "project_code": { "type": "string", "format": "uri", "readOnly": true }, "debit": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "credit": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "discount": { "type": "boolean" }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_number": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_type": { "nullable": true, "minimum": 0, "maximum": 65535, "oneOf": [ { "$ref": "#/components/schemas/InvoiceTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "invoice_row_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "credited_invoice_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "payment_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "client_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "account_type": { "allOf": [ { "$ref": "#/components/schemas/AccountTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "account_group": { "type": "string", "maxLength": 255 }, "created_user": { "type": "string", "nullable": true, "maxLength": 255 }, "created_user_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "created_timestamp": { "type": "string", "format": "date-time", "readOnly": true }, "modification_logged": { "type": "boolean" }, "journal_entry_problem": { "type": "string", "format": "uri" } }, "required": [ "account_group", "account_type", "cost_center", "created_timestamp", "date", "id", "journal_entry_problem", "project_code", "url" ] }, "JournalTransactionProblemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "date": { "type": "string", "format": "date" }, "account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "account_name": { "type": "string", "nullable": true, "maxLength": 255 }, "debit": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "credit": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "discount": { "type": "boolean" }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_number": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_type": { "nullable": true, "minimum": 0, "maximum": 65535, "oneOf": [ { "$ref": "#/components/schemas/InvoiceTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "invoice_row_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "credited_invoice_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "payment_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "client_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "account_type": { "allOf": [ { "$ref": "#/components/schemas/AccountTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "account_group": { "type": "string", "minLength": 1, "maxLength": 255 }, "created_user": { "type": "string", "nullable": true, "maxLength": 255 }, "created_user_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "modification_logged": { "type": "boolean" }, "journal_entry_problem": { "type": "string", "format": "uri" } }, "required": [ "account_group", "account_type", "date", "journal_entry_problem" ] }, "JournalTransactionRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "date": { "type": "string", "format": "date" }, "account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "account_name": { "type": "string", "nullable": true, "maxLength": 255 }, "cost_center_label": { "type": "string", "minLength": 1 }, "project_code_label": { "type": "string", "minLength": 1 }, "debit": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "credit": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "discount": { "type": "boolean" }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_number": { "type": "string", "nullable": true, "maxLength": 255 }, "invoice_type": { "nullable": true, "minimum": 0, "maximum": 65535, "oneOf": [ { "$ref": "#/components/schemas/InvoiceTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "invoice_row_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "credited_invoice_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "payment_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "client_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "account_type": { "allOf": [ { "$ref": "#/components/schemas/AccountTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "account_group": { "type": "string", "minLength": 1, "maxLength": 255 }, "created_user": { "type": "string", "nullable": true, "maxLength": 255 }, "created_user_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "modification_logged": { "type": "boolean" }, "journal_entry": { "type": "string", "format": "uri" } }, "required": [ "account_group", "account_type", "cost_center_label", "date", "journal_entry", "project_code_label" ] }, "KnowledgeBaseFile": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "description": { "type": "string", "maxLength": 255 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "file": { "type": "string", "format": "uri" }, "original_name": { "type": "string", "readOnly": true }, "display_name": { "type": "string", "maxLength": 255 }, "size": { "type": "integer", "readOnly": true }, "folder": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "description", "display_name", "file", "modified", "original_name", "polymorphic_ctype", "size", "url" ] }, "KnowledgeBaseFileRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 255 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "file": { "type": "string", "format": "binary" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "folder": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "description", "display_name", "file" ] }, "KnowledgeBaseFolder": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "description": { "type": "string", "maxLength": 255 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "name": { "type": "string", "maxLength": 255 }, "parent": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "description", "modified", "name", "polymorphic_ctype", "url" ] }, "KnowledgeBaseFolderRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 255 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "parent": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "description", "name" ] }, "KnowledgeBaseObject": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "description": { "type": "string", "maxLength": 255 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true, "nullable": true } }, "required": [ "created", "description", "modified", "polymorphic_ctype", "url" ] }, "LaboratoryAnalysis": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "parent": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverride" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "measurement_unit": { "type": "string", "maxLength": 100 }, "sample_type": { "type": "string", "description": "This field will be deprecated" }, "coded_sample_type": { "type": "string", "description": "Primarily code is used, if not found ID is used" }, "panels": { "type": "array", "items": { "type": "string", "format": "uri" } }, "group": { "type": "string", "format": "uri", "nullable": true }, "analysis_method": { "type": "string", "nullable": true, "maxLength": 255 }, "internal_instructions": { "type": "string", "nullable": true }, "for_idexx": { "type": "boolean" }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "created", "id", "item_list", "modified", "name", "parent", "polymorphic_ctype", "type_code", "url", "vat_group" ] }, "LaboratoryAnalysisGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 } }, "required": [ "id", "name", "url" ] }, "LaboratoryAnalysisGroupDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "laboratory_analysis": { "type": "array", "items": { "type": "string", "format": "uri" } }, "laboratoryanalysispanel": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "id", "laboratory_analysis", "laboratoryanalysispanel", "name", "url" ] }, "LaboratoryAnalysisGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ] }, "LaboratoryAnalysisList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "name": { "type": "string", "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "hide_on_consultation_search": { "type": "boolean" }, "hide_on_countersale_search": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri", "readOnly": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true }, "archived": { "type": "boolean" }, "item_list": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "group": { "type": "string", "format": "uri", "nullable": true }, "main_item": { "type": "string", "format": "uri", "readOnly": true }, "for_idexx": { "type": "boolean" }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 }, "primary_wholesaler_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID of the primary wholesaler for this stock item. Null on non-stock items (procedures) or when unset." }, "primary_wholesaler_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Wholesaler-specific product code for the primary wholesaler. Null on non-stock items or when unset." } }, "required": [ "created", "id", "item_list", "main_item", "modified", "name", "polymorphic_ctype", "primary_wholesaler_code", "primary_wholesaler_id", "type_code", "url", "vat_group" ] }, "LaboratoryAnalysisPanel": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "parent": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverride" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "group": { "type": "string", "format": "uri" }, "notes": { "type": "string", "nullable": true }, "analysis_method": { "type": "string", "maxLength": 255 }, "internal_instructions": { "type": "string", "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "created", "group", "id", "item_list", "modified", "name", "parent", "polymorphic_ctype", "type_code", "url", "vat_group" ] }, "LaboratoryAnalysisPanelList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "hide_on_consultation_search": { "type": "boolean" }, "hide_on_countersale_search": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri", "readOnly": true }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true }, "archived": { "type": "boolean" }, "item_list": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "main_item": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 }, "primary_wholesaler_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID of the primary wholesaler for this stock item. Null on non-stock items (procedures) or when unset." }, "primary_wholesaler_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Wholesaler-specific product code for the primary wholesaler. Null on non-stock items or when unset." } }, "required": [ "created", "id", "item_list", "main_item", "modified", "name", "polymorphic_ctype", "primary_wholesaler_code", "primary_wholesaler_id", "type_code", "url", "vat_group" ] }, "LaboratoryAnalysisPanelRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverrideRequest" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "group": { "type": "string", "format": "uri" }, "notes": { "type": "string", "nullable": true }, "analysis_method": { "type": "string", "maxLength": 255 }, "internal_instructions": { "type": "string", "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "group", "item_list", "name", "type_code", "vat_group" ] }, "LaboratoryAnalysisRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverrideRequest" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "measurement_unit": { "type": "string", "maxLength": 100 }, "sample_type": { "type": "string", "minLength": 1, "description": "This field will be deprecated" }, "coded_sample_type": { "type": "string", "description": "Primarily code is used, if not found ID is used" }, "panels": { "type": "array", "items": { "type": "string", "format": "uri" } }, "group": { "type": "string", "format": "uri", "nullable": true }, "analysis_method": { "type": "string", "nullable": true, "maxLength": 255 }, "internal_instructions": { "type": "string", "nullable": true }, "for_idexx": { "type": "boolean" }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "item_list", "name", "type_code", "vat_group" ] }, "LaboratoryTypeEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Internal\n* `2` - External" }, "List": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code_system": { "type": "integer" }, "type": { "allOf": [ { "$ref": "#/components/schemas/TypeBdfEnum" } ], "minimum": -32768, "maximum": 32767 }, "parent_id": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "name": { "type": "string", "maxLength": 255 }, "is_active": { "type": "boolean", "nullable": true } }, "required": [ "code_system", "id", "name", "type", "url" ] }, "ListDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code_system": { "allOf": [ { "$ref": "#/components/schemas/CodeSystemEnum" } ], "minimum": -32768, "maximum": 32767 }, "type": { "allOf": [ { "$ref": "#/components/schemas/TypeBdfEnum" } ], "minimum": -32768, "maximum": 32767 }, "parent_id": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "name": { "type": "string", "maxLength": 255 }, "is_active": { "type": "boolean", "nullable": true }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "id", "items", "name", "type", "url" ] }, "ListFormatEnum": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "* `0` - ---------\n* `1` - Agfa\n* `2` - Dicom modality worklist" }, "ListItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code": { "type": "string", "nullable": true, "description": "Optional identifier for the item, up to 20 characters. If codes are used, they must be unique within a list.", "maxLength": 20 }, "label": { "type": "string", "maxLength": 255 }, "list": { "type": "string", "format": "uri" }, "archived": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "code", "id", "label", "list", "url" ] }, "ListItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "code": { "type": "string", "nullable": true, "description": "Optional identifier for the item, up to 20 characters. If codes are used, they must be unique within a list.", "maxLength": 20 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 }, "list": { "type": "string", "format": "uri" }, "archived": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 } }, "required": [ "code", "label", "list" ] }, "ListRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "code_system": { "type": "integer" }, "type": { "allOf": [ { "$ref": "#/components/schemas/TypeBdfEnum" } ], "minimum": -32768, "maximum": 32767 }, "parent_id": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "is_active": { "type": "boolean", "nullable": true } }, "required": [ "code_system", "name", "type" ] }, "LocationAlertLevel": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "item": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "stock_locations": { "type": "array", "items": { "type": "string", "format": "uri" } }, "alert_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "optimum_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true } }, "required": [ "alert_level", "department", "id", "item", "url" ] }, "LocationAlertLevelRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "item": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "stock_locations": { "type": "array", "items": { "type": "string", "format": "uri" } }, "alert_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "optimum_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true } }, "required": [ "alert_level", "department", "item" ] }, "MappedToEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Not started\n* `2` - In progress\n* `3` - Complete\n* `4` - Archived" }, "MappingEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "* `1` - Patient condition improved\n* `2` - Patient deceased\n* `3` - Patient seen by another clinic\n* `4` - Bad weather\n* `5` - Veterinarian sick/other internal reason\n* `6` - No show\n* `7` - Other" }, "MasterDataEntry": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "code": { "$ref": "#/components/schemas/CodeEnum" }, "object_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "content_type": { "type": "string", "format": "uri", "nullable": true }, "species": { "type": "string" } }, "required": [ "code", "content_type", "created", "modified", "object_id", "species", "url" ] }, "MatchedByEnum": { "enum": [ "product_code", "barcode" ], "type": "string", "description": "* `product_code` - product_code\n* `barcode` - barcode" }, "MedicineList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "hide_on_consultation_search": { "type": "boolean" }, "hide_on_countersale_search": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri", "readOnly": true }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true }, "archived": { "type": "boolean" }, "item_list": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "main_item": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "active_substance": { "type": "string", "nullable": true }, "alert_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "optimum_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "title": "Optimum level (packages)" }, "provider_medicine": { "type": "integer", "nullable": true }, "not_in_stock_management": { "type": "boolean" }, "discontinued_product": { "type": "boolean", "description": "These items can no longer be added into orders" }, "from_pharmacy": { "allOf": [ { "$ref": "#/components/schemas/FromPharmacyEnum" } ], "minimum": -32768, "maximum": 32767 }, "atc_code": { "type": "string", "nullable": true, "maxLength": 63 }, "special_medicine": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/SpecialMedicineEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "is_antibiotic": { "type": "boolean", "description": "Antibiotic flag (stored in MedicineExtras table).\n\nReturns False if MedicineExtras row doesn't exist, since False is the\ndefault value. This avoids creating unnecessary rows for medicines that\nare not antibiotics.\n\nPerformance note: When accessing this property on multiple Medicine objects,\nconsider using select_related('medicine_extras') on the queryset.", "readOnly": true }, "unit": { "type": "string", "nullable": true, "maxLength": 63 }, "default_order_amount": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "manufacturer": { "nullable": true }, "shelf_location": { "type": "string", "nullable": true, "maxLength": 63 }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "default_usage_size": { "allOf": [ { "$ref": "#/components/schemas/DefaultUsageSizeEnum" } ], "description": "USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2\n\n* `1` - Package\n* `2` - Units", "minimum": -32768, "maximum": 32767 }, "manufacturer_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "dispense_fee": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "title": "Handling fee" }, "dispense_fee_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "title": "Handling fee with VAT" }, "injection_fee": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "injection_fee_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "use_default_dispense_fee": { "type": "boolean", "title": "Use default handling fee" }, "use_default_injection_fee": { "type": "boolean" }, "dispense_fee_partial": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "title": "Partial handling fee" }, "dispense_fee_partial_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "title": "Partial handling fee with VAT" }, "use_default_partial_dispense_fee": { "type": "boolean", "title": "Use default partial handling fee" }, "allow_home_delivery": { "type": "boolean" }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 }, "primary_wholesaler_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID of the primary wholesaler for this stock item. Null on non-stock items (procedures) or when unset." }, "primary_wholesaler_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Wholesaler-specific product code for the primary wholesaler. Null on non-stock items or when unset." } }, "required": [ "created", "id", "is_antibiotic", "item_list", "main_item", "modified", "name", "polymorphic_ctype", "primary_wholesaler_code", "primary_wholesaler_id", "type_code", "url", "vat_group" ] }, "MedicineMetaData": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "active_substance": { "type": "string", "nullable": true, "maxLength": 100 }, "vaccination": { "type": "boolean" }, "contraindications": { "type": "string", "nullable": true }, "preparation": { "type": "string", "nullable": true, "maxLength": 255 }, "manufacturer_data": { "type": "string", "nullable": true }, "prescription_item": { "type": "string", "format": "uri" } }, "required": [ "prescription_item", "url" ] }, "MedicineMetaDataDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "active_substance": { "type": "string", "nullable": true, "maxLength": 100 }, "vaccination": { "type": "boolean" }, "contraindications": { "type": "string", "nullable": true }, "preparation": { "type": "string", "nullable": true, "maxLength": 255 }, "manufacturer_data": { "type": "string", "nullable": true }, "prescription_item": { "type": "string", "format": "uri" } }, "required": [ "prescription_item", "url" ] }, "MedicineTemplate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "item": { "type": "string", "format": "uri" }, "item_name": { "type": "string", "readOnly": true }, "species": { "type": "string", "nullable": true, "readOnly": true, "description": "species code can be found on active species List" }, "species_code": { "type": "integer", "readOnly": true, "nullable": true }, "text": { "type": "string" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "id", "item", "item_name", "modified", "species", "species_code", "text", "url" ] }, "MethodEnum": { "enum": [ 0, 1 ], "type": "integer", "description": "* `0` - GET\n* `1` - POST" }, "Modality": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "common_name": { "type": "string", "maxLength": 35 }, "modality_type": { "allOf": [ { "$ref": "#/components/schemas/ModalityTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "dicom_ae_title": { "type": "string", "maxLength": 50 }, "list_format": { "allOf": [ { "$ref": "#/components/schemas/ListFormatEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "department": { "type": "string", "format": "uri" }, "callsign": { "type": "string", "maxLength": 255 }, "procedure": { "type": "string", "format": "uri", "nullable": true }, "linked_resource": { "type": "string", "format": "uri", "nullable": true }, "is_active": { "type": "boolean" } }, "required": [ "callsign", "common_name", "department", "dicom_ae_title", "id", "url" ] }, "ModalityTypeEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63 ], "type": "integer", "description": "* `0` - ---------\n* `1` - Audio\n* `2` - Biomagnetic Imaging\n* `3` - Color flow Doppler\n* `4` - Computed radiography\n* `5` - Computed tomography\n* `6` - Duplex Doppler\n* `7` - Diaphanography\n* `8` - Digital Subtraction Angiography\n* `9` - Digital Radiography\n* `10` - Electrocardiography\n* `11` - Cardiac Electrophysiology\n* `12` - Endoscopy\n* `13` - General Microscopy\n* `14` - Hard Copy\n* `15` - Hemodynamic Waveform\n* `16` - Intra-Oral Radiography\n* `17` - Intravascular Ultrasound\n* `18` - Laser surface scan\n* `19` - Mammography\n* `20` - Magnetic Resonance\n* `21` - Nuclear Medicine\n* `22` - Optical Coherence Tomography\n* `23` - Ophthalmic Photography\n* `24` - Ophthalmic Mapping\n* `25` - Ophthalmic Refraction\n* `26` - Ophthalmic Visual Field\n* `27` - Other\n* `28` - Presentation State\n* `29` - Positron Emission Tomography - PET\n* `30` - Panoramic X-Ray\n* `31` - Registration\n* `32` - Radio Fluoroscopy\n* `33` - Radiographic imaging (conventional film/screen)\n* `34` - Radiotherapy Dose\n* `35` - Radiotherapy Image\n* `36` - Radiotherapy Plan\n* `37` - RT Treatment Record\n* `38` - Radiotherapy Structure Set\n* `39` - Segmentation\n* `40` - Slide Microscopy\n* `41` - Stereometric Relationship\n* `42` - SR Document\n* `43` - Single-photon emission computed tomography (SPECT)\n* `44` - Thermography\n* `45` - Ultrasound\n* `46` - X-Ray Angiography\n* `47` - External-camera photography\n* `48` - Autorefraction\n* `49` - Keratometry\n* `50` - Visual Acuity\n* `51` - Subjective Refraction\n* `52` - Lensometry\n* `53` - Ophthalmic Axial Measurements\n* `54` - Respiratory Waveform\n* `55` - Key Object Selection\n* `56` - Ophthalmic Tomography\n* `57` - Bone Densitometry (ultrasound)\n* `58` - Bone Bone Densitometry (X-Ray)\n* `59` - Document\n* `60` - Fiducials\n* `61` - Plan\n* `62` - Intraocular Lens Data\n* `63` - Intravascular Optical Coherence Tomography" }, "MovementTypeEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Deposit\n* `2` - Withdrawal\n* `3` - Discrepancy (surplus)\n* `4` - Discrepancy (shortage)" }, "NavigationSearchBundle": { "type": "object", "description": "A `Serializer` is a model-less serializer class with additional\nsupport for JSON:API spec features.\n\nAs in JSON:API specification a type is always required you need to\nmake sure that you define `resource_name` in your `Meta` class\nwhen deriving from this class.\n\nIncluded Mixins:\n\n* A mixin class to enable sparse fieldsets is included\n* A mixin class to enable validation of included resources is included", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BundleNavigationSearch" }, "readOnly": true }, "count": { "type": "integer", "readOnly": true } }, "required": [ "count", "data" ] }, "NavigationSearchClientWithPatient": { "type": "object", "description": "A `Serializer` is a model-less serializer class with additional\nsupport for JSON:API spec features.\n\nAs in JSON:API specification a type is always required you need to\nmake sure that you define `resource_name` in your `Meta` class\nwhen deriving from this class.\n\nIncluded Mixins:\n\n* A mixin class to enable sparse fieldsets is included\n* A mixin class to enable validation of included resources is included", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClientWithPatientNavigationSearch" }, "readOnly": true }, "count": { "type": "integer", "readOnly": true } }, "required": [ "count", "data" ] }, "NavigationSearchItem": { "type": "object", "description": "A `Serializer` is a model-less serializer class with additional\nsupport for JSON:API spec features.\n\nAs in JSON:API specification a type is always required you need to\nmake sure that you define `resource_name` in your `Meta` class\nwhen deriving from this class.\n\nIncluded Mixins:\n\n* A mixin class to enable sparse fieldsets is included\n* A mixin class to enable validation of included resources is included", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ItemNavigationSearch" }, "readOnly": true }, "count": { "type": "integer", "readOnly": true } }, "required": [ "count", "data" ] }, "NavigationSearchResult": { "type": "object", "required": [ "type", "id" ], "additionalProperties": false, "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/NavigationSearchResultTypeEnum" } ], "description": "The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships." }, "links": { "type": "object", "properties": { "self": { "$ref": "#/components/schemas/link" } } }, "id": { "type": "string" }, "attributes": { "type": "object", "properties": { "clients_with_patients": { "allOf": [ { "$ref": "#/components/schemas/NavigationSearchClientWithPatient" } ], "readOnly": true }, "items": { "allOf": [ { "$ref": "#/components/schemas/NavigationSearchItem" } ], "readOnly": true }, "bundles": { "allOf": [ { "$ref": "#/components/schemas/NavigationSearchBundle" } ], "readOnly": true } } } } }, "NavigationSearchResultTypeEnum": { "type": "string", "enum": [ "NavigationSearchResult" ] }, "Nested": { "type": "object", "description": "Nested serializer that uses pcloud namespace properly", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "exported": { "type": "string", "format": "date-time", "nullable": true }, "invoice": { "type": "string", "format": "uri" } }, "required": [ "invoice", "url" ] }, "NestedPatientNavigationSearch": { "type": "object", "description": "A `Serializer` is a model-less serializer class with additional\nsupport for JSON:API spec features.\n\nAs in JSON:API specification a type is always required you need to\nmake sure that you define `resource_name` in your `Meta` class\nwhen deriving from this class.\n\nIncluded Mixins:\n\n* A mixin class to enable sparse fieldsets is included\n* A mixin class to enable validation of included resources is included", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "official_name": { "type": "string" }, "species": { "type": "string", "nullable": true }, "breed": { "type": "string", "nullable": true }, "gender": { "type": "string", "nullable": true }, "gender_string": { "type": "string", "nullable": true }, "birth_date": { "type": "string", "format": "date", "nullable": true }, "deceased_date": { "type": "string", "format": "date", "nullable": true }, "microchip": { "type": "string", "nullable": true }, "passport_number": { "type": "string", "nullable": true }, "register_number": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "stable_name": { "type": "string", "nullable": true }, "stable_address": { "type": "string", "nullable": true }, "zip_code": { "type": "string", "nullable": true } }, "required": [ "id", "name", "official_name" ] }, "NestedRequest": { "type": "object", "description": "Nested serializer that uses pcloud namespace properly", "properties": { "invoice": { "type": "string", "format": "uri" } }, "required": [ "invoice" ] }, "NetPromoterScore": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "consultation": { "type": "string", "format": "uri" }, "rating": { "type": "integer", "maximum": 10, "minimum": 0 }, "comment": { "type": "string", "maxLength": 500 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "consultation", "created", "modified", "rating", "url" ] }, "NetPromoterScoreRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "rating": { "type": "integer", "maximum": 10, "minimum": 0 }, "comment": { "type": "string", "maxLength": 500 } }, "required": [ "consultation", "rating" ] }, "NominatorEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Purchase price\n* `2` - Net purchase price\n* `3` - Selling price" }, "Note": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "title": { "type": "string", "maxLength": 127 }, "note": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/NoteTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "custom_created": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "diagnostic_imaging_referral": { "type": "string", "format": "uri", "nullable": true }, "consultation_referral": { "type": "string", "format": "uri", "nullable": true }, "patient_referral": { "type": "string", "format": "uri", "nullable": true }, "attachments": { "type": "string" }, "created_department": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client", "created", "id", "modified", "patients", "title", "type", "url" ] }, "NoteRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 127 }, "note": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/NoteTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "string", "format": "date-time", "nullable": true }, "custom_created": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "diagnostic_imaging_referral": { "type": "string", "format": "uri", "nullable": true }, "consultation_referral": { "type": "string", "format": "uri", "nullable": true }, "patient_referral": { "type": "string", "format": "uri", "nullable": true }, "attachments": { "type": "string" }, "created_department": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client", "patients", "title", "type" ] }, "NoteTypeEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 ], "type": "integer", "description": "* `0` - SMS\n* `1` - Email\n* `2` - Phone discussion\n* `3` - Other note\n* `4` - Feedback\n* `5` - Laboratory\n* `6` - Diagnostic imaging\n* `7` - Financial\n* `8` - Patient referral\n* `9` - Photo\n* `10` - Past clinical history\n* `11` - Debt letter\n* `12` - Client app notes\n* `13` - Pharmacy request\n* `14` - Billing" }, "NoteUpload": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "file": { "type": "string", "format": "uri" }, "original_name": { "type": "string", "maxLength": 255 }, "thumbnail_url": { "type": "string", "format": "uri" }, "size": { "type": "integer", "readOnly": true } }, "required": [ "file", "id", "original_name", "size" ] }, "NoteUploadRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "file": { "type": "string", "format": "binary" }, "original_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "thumbnail_url": { "type": "string", "format": "uri", "minLength": 1 } }, "required": [ "file", "original_name" ] }, "NullEnum": { "enum": [ null ] }, "OnlineBookingClient": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "appointment": { "type": "string" }, "first_name": { "type": "string", "maxLength": 100 }, "last_name": { "type": "string", "maxLength": 100 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "phone_number": { "type": "string", "maxLength": 30 }, "street_address": { "type": "string", "maxLength": 100 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 100 }, "state": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, US-CA).", "maxLength": 100 }, "onlinebookingpatients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "id_number": { "type": "string", "maxLength": 63 }, "portal_account_id": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "appointment", "first_name", "id", "last_name", "phone_number", "url" ] }, "OnlineBookingClientRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "appointment": { "type": "string" }, "first_name": { "type": "string", "minLength": 1, "maxLength": 100 }, "last_name": { "type": "string", "minLength": 1, "maxLength": 100 }, "email": { "type": "string", "format": "email", "nullable": true, "minLength": 1, "maxLength": 254 }, "phone_number": { "type": "string", "minLength": 1, "maxLength": 30 }, "street_address": { "type": "string", "maxLength": 100 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 100 }, "state": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, US-CA).", "maxLength": 100 }, "onlinebookingpatients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "id_number": { "type": "string", "maxLength": 63 }, "dismissed_trigger_topics": { "type": "array", "items": { "type": "integer", "writeOnly": true }, "writeOnly": true, "description": "IDs of trigger topics the client dismissed while booking." }, "portal_account_id": { "type": "string", "format": "uuid", "nullable": true } }, "required": [ "appointment", "first_name", "last_name", "phone_number" ] }, "OnlineBookingPatient": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "onlinebookingclient": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 100 }, "species": { "type": "string" }, "breed": { "type": "string" }, "microchip": { "type": "string", "nullable": true, "maxLength": 20 }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 } }, "required": [ "id", "name", "onlinebookingclient", "species", "url" ] }, "OnlineBookingPatientRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "onlinebookingclient": { "type": "string", "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "species": { "type": "string" }, "breed": { "type": "string" }, "microchip": { "type": "string", "nullable": true, "maxLength": 20 }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 } }, "required": [ "name", "onlinebookingclient", "species" ] }, "OnlineBookingTriggerTopic": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "trigger_type": { "allOf": [ { "$ref": "#/components/schemas/TriggerTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "topic_text": { "type": "string" }, "message": { "type": "string" }, "ignore_action_label": { "type": "string", "maxLength": 100 }, "order": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "archived": { "type": "boolean", "readOnly": true } }, "required": [ "archived", "department", "id", "message", "topic_text", "trigger_type", "url" ] }, "OnlineBookingTriggerTopicRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "trigger_type": { "allOf": [ { "$ref": "#/components/schemas/TriggerTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "topic_text": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "ignore_action_label": { "type": "string", "maxLength": 100 }, "order": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" } }, "required": [ "department", "message", "topic_text", "trigger_type" ] }, "OrderItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "org_item": { "type": "string", "format": "uri" }, "order_quantity": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "delivery_quantity": { "type": "string", "readOnly": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "order": { "type": "string", "format": "uri" }, "sequence_order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "batches": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true, "x-sunset": "2026-10-02", "x-correction": true, "x-correction-reason": "Was emitted as a string fallback for an un-annotated method field; actual API returns an array of batch objects." }, "barcode": { "type": "string", "readOnly": true, "nullable": true }, "validated": { "type": "boolean", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "barcode", "batches", "created", "delivery_quantity", "id", "modified", "order", "order_quantity", "org_item", "url", "validated" ] }, "OrderItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "org_item": { "type": "string", "format": "uri" }, "order_quantity": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "order": { "type": "string", "format": "uri" }, "sequence_order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "order", "order_quantity", "org_item" ] }, "OrderMarkDeliveredResponse": { "type": "object", "properties": { "status": { "type": "string" }, "order_status": { "type": "integer" }, "all_delivered": { "type": "boolean" }, "delivery_date": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "all_delivered", "delivery_date", "order_status", "status" ] }, "OrderPlacedAvailableWholesaler": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of your registered `AvailableWholesaler`." }, "name": { "type": "string", "description": "Name of that `AvailableWholesaler`." } }, "required": [ "id", "name" ] }, "OrderPlacedCustomer": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "postal_address": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true } }, "required": [ "city", "country_code", "department", "name", "postal_address", "postal_code" ] }, "OrderPlacedEvent": { "type": "object", "description": "A clinic sent a purchase order to a `Wholesaler` created from one of your\n`AvailableWholesaler` registrations.", "properties": { "event": { "type": "string", "enum": [ "order.placed" ], "description": "Always `\"order.placed\"`." }, "event_id": { "type": "string", "format": "uuid", "description": "Identifies this event, unchanged across all delivery attempts of it. Use it to discard redundant deliveries." }, "available_wholesaler": { "$ref": "#/components/schemas/OrderPlacedAvailableWholesaler" }, "wholesaler": { "$ref": "#/components/schemas/OrderPlacedWholesaler" }, "order": { "$ref": "#/components/schemas/OrderPlacedOrder" } }, "required": [ "available_wholesaler", "event", "event_id", "order", "wholesaler" ] }, "OrderPlacedItem": { "type": "object", "properties": { "product_number": { "type": "string", "nullable": true, "description": "Your product code, `null` when the clinic's item carries none — match on `product_name` / `barcode` instead." }, "product_name": { "type": "string" }, "quantity": { "type": "string", "description": "Decimal amount, sent as a string." }, "unit": { "type": "string", "nullable": true }, "barcode": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "required": [ "barcode", "notes", "product_name", "product_number", "quantity", "unit" ] }, "OrderPlacedOrder": { "type": "object", "properties": { "id": { "type": "integer", "description": "Per-clinic `Order` ID. Identifies the order for `set_wholesaler_reference_number` and `mark_delivered`." }, "notes": { "type": "string", "nullable": true, "description": "Free-text note the clinic added to the order." }, "customer": { "allOf": [ { "$ref": "#/components/schemas/OrderPlacedCustomer" } ], "description": "The ordering clinic's billing / delivery identity." }, "purchaser": { "allOf": [ { "$ref": "#/components/schemas/OrderPlacedPurchaser" } ], "description": "The user who sent the order; phone and email fall back from the department contact to the user's own." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPlacedItem" }, "description": "Order lines." } }, "required": [ "customer", "id", "items", "notes", "purchaser" ] }, "OrderPlacedPurchaser": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "required": [ "email", "name", "phone" ] }, "OrderPlacedWholesaler": { "type": "object", "properties": { "id": { "type": "integer", "description": "Per-clinic `Wholesaler` ID — the same one returned by `wholesaler.created`." }, "customer_number": { "type": "string", "nullable": true, "description": "The clinic's customer number with you; department override if set, else the wholesaler-global value." } }, "required": [ "customer_number", "id" ] }, "OrderSetWholesalerReferenceNumberRequest": { "type": "object", "properties": { "wholesaler_reference_number": { "type": "string", "minLength": 1, "maxLength": 63 }, "wholesaler_confirmation_url": { "type": "string", "format": "uri", "nullable": true, "minLength": 1, "maxLength": 2000 } }, "required": [ "wholesaler_reference_number" ] }, "OrderSetWholesalerReferenceNumberResponse": { "type": "object", "properties": { "status": { "type": "string" }, "wholesaler_reference_number": { "type": "string" }, "wholesaler_confirmation_url": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "status", "wholesaler_reference_number" ] }, "Organism": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "archived": { "type": "boolean" } }, "required": [ "id", "name", "url" ] }, "OrganizationSettings": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyEnum" } ], "description": "Select the appropriate currency for your organization.\n\n* `ALL` - Albania Lek (ALL)\n* `AFN` - Afghanistan Afghani (AFN)\n* `ARS` - Argentina Peso (ARS)\n* `AWG` - Aruba Guilder (AWG)\n* `AUD` - Australia Dollar (AUD)\n* `AZN` - Azerbaijan New Manat (AZN)\n* `BSD` - Bahamas Dollar (BSD)\n* `BBD` - Barbados Dollar (BBD)\n* `BYR` - Belarus Ruble (BYR)\n* `BZD` - Belize Dollar (BZD)\n* `BMD` - Bermuda Dollar (BMD)\n* `BOB` - Bolivia Boliviano (BOB)\n* `BAM` - Bosnia and Herzegovina Convertible Marka (BAM)\n* `BWP` - Botswana Pula (BWP)\n* `BGN` - Bulgaria Lev (BGN)\n* `BRL` - Brazil Real (BRL)\n* `BND` - Brunei Darussalam Dollar (BND)\n* `KHR` - Cambodia Riel (KHR)\n* `CAD` - Canadian Dollar (CAD)\n* `KYD` - Cayman Islands Dollar (KYD)\n* `CLP` - Chile Peso (CLP)\n* `CNY` - China Yuan Renminbi (CNY)\n* `COP` - Colombia Peso (COP)\n* `CRC` - Costa Rica Colon (CRC)\n* `HRK` - Croatia Kuna (HRK)\n* `CUP` - Cuba Peso (CUP)\n* `CZK` - Czech Republic Koruna (CZK)\n* `DKK` - Denmark Krone (DKK)\n* `DOP` - Dominican Republic Peso (DOP)\n* `XCD` - East Caribbean Dollar (XCD)\n* `EGP` - Egypt Pound (EGP)\n* `SVC` - El Salvador Colon (SVC)\n* `EUR` - Euro (EUR)\n* `FKP` - Falkland Islands (Malvinas) Pound (FKP)\n* `FJD` - Fiji Dollar (FJD)\n* `GHC` - Ghana Cedi (GHC)\n* `GIP` - Gibraltar Pound (GIP)\n* `GTQ` - Guatemala Quetzal (GTQ)\n* `GGP` - Guernsey Pound (GGP)\n* `GYD` - Guyana Dollar (GYD)\n* `HNL` - Honduras Lempira (HNL)\n* `HKD` - Hong Kong Dollar (HKD)\n* `HUF` - Hungary Forint (HUF)\n* `ISK` - Iceland Krona (ISK)\n* `INR` - India Rupee (INR)\n* `IDR` - Indonesia Rupiah (IDR)\n* `IRR` - Iran Rial (IRR)\n* `IMP` - Isle of Man Pound (IMP)\n* `ILS` - Israel Shekel (ILS)\n* `JMD` - Jamaica Dollar (JMD)\n* `JPY` - Japan Yen (JPY)\n* `JEP` - Jersey Pound (JEP)\n* `KZT` - Kazakhstan Tenge (KZT)\n* `KES` - Kenyan shilling (KES)\n* `KPW` - Korea (North) Won (KPW)\n* `KRW` - Korea (South) Won (KRW)\n* `KGS` - Kyrgyzstan Som (KGS)\n* `LAK` - Laos Kip (LAK)\n* `LBP` - Lebanon Pound (LBP)\n* `LRD` - Liberia Dollar (LRD)\n* `MKD` - Macedonia Denar (MKD)\n* `MYR` - Malaysia Ringgit (MYR)\n* `MUR` - Mauritius Rupee (MUR)\n* `MXN` - Mexico Peso (MXN)\n* `MNT` - Mongolia Tughrik (MNT)\n* `MZN` - Mozambique Metical (MZN)\n* `NAD` - Namibia Dollar (NAD)\n* `NPR` - Nepal Rupee (NPR)\n* `ANG` - Netherlands Antilles Guilder (ANG)\n* `NZD` - New Zealand Dollar (NZD)\n* `NIO` - Nicaragua Cordoba (NIO)\n* `NGN` - Nigeria Naira (NGN)\n* `NOK` - Norway Krone (NOK)\n* `OMR` - Oman Rial (OMR)\n* `PKR` - Pakistan Rupee (PKR)\n* `PAB` - Panama Balboa (PAB)\n* `PYG` - Paraguay Guarani (PYG)\n* `PEN` - Peru Nuevo Sol (PEN)\n* `PHP` - Philippines Peso (PHP)\n* `PLN` - Poland Zloty (PLN)\n* `QAR` - Qatar Riyal (QAR)\n* `RON` - Romania New Leu (RON)\n* `RUB` - Russia Ruble (RUB)\n* `SHP` - Saint Helena Pound (SHP)\n* `SAR` - Saudi Arabia Riyal (SAR)\n* `RSD` - Serbia Dinar (RSD)\n* `SCR` - Seychelles Rupee (SCR)\n* `SGD` - Singapore Dollar (SGD)\n* `SBD` - Solomon Islands Dollar (SBD)\n* `SOS` - Somalia Shilling (SOS)\n* `ZAR` - South Africa Rand (ZAR)\n* `LKR` - Sri Lanka Rupee (LKR)\n* `SEK` - Sweden Krona (SEK)\n* `CHF` - Switzerland Franc (CHF)\n* `SRD` - Suriname Dollar (SRD)\n* `SYP` - Syria Pound (SYP)\n* `TWD` - Taiwan New Dollar (TWD)\n* `THB` - Thailand Baht (THB)\n* `TTD` - Trinidad and Tobago Dollar (TTD)\n* `TRY` - Turkey Lira (TRY)\n* `TRL` - Turkey Lira (TRL)\n* `TVD` - Tuvalu Dollar (TVD)\n* `UAH` - Ukraine Hryvnia (UAH)\n* `GBP` - United Kingdom Pound (GBP)\n* `USD` - United States Dollar (USD)\n* `UYU` - Uruguay Peso (UYU)\n* `UZS` - Uzbekistan Som (UZS)\n* `VEF` - Venezuela Bolivar (VEF)\n* `VND` - Viet Nam Dong (VND)\n* `YER` - Yemen Rial (YER)\n* `ZWD` - Zimbabwe Dollar (ZWD)\n* `AED` - United Arab Emirates Dirham (AED)\n* `MOP` - Macanese Pataca (MOP)\n* `KWD` - Kuwaiti Dinar (KWD)\n* `ZMW` - Zambian Kwacha (ZMW)\n* `WST` - Samoan Tala (WST)" }, "timezone": { "allOf": [ { "$ref": "#/components/schemas/TimezoneEnum" } ], "description": "Select the time zone that applies to your organization.\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Coyhaique` - America/Coyhaique\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GMT` - GMT\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC" } }, "required": [ "id" ] }, "OrganizationSettingsRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyEnum" } ], "description": "Select the appropriate currency for your organization.\n\n* `ALL` - Albania Lek (ALL)\n* `AFN` - Afghanistan Afghani (AFN)\n* `ARS` - Argentina Peso (ARS)\n* `AWG` - Aruba Guilder (AWG)\n* `AUD` - Australia Dollar (AUD)\n* `AZN` - Azerbaijan New Manat (AZN)\n* `BSD` - Bahamas Dollar (BSD)\n* `BBD` - Barbados Dollar (BBD)\n* `BYR` - Belarus Ruble (BYR)\n* `BZD` - Belize Dollar (BZD)\n* `BMD` - Bermuda Dollar (BMD)\n* `BOB` - Bolivia Boliviano (BOB)\n* `BAM` - Bosnia and Herzegovina Convertible Marka (BAM)\n* `BWP` - Botswana Pula (BWP)\n* `BGN` - Bulgaria Lev (BGN)\n* `BRL` - Brazil Real (BRL)\n* `BND` - Brunei Darussalam Dollar (BND)\n* `KHR` - Cambodia Riel (KHR)\n* `CAD` - Canadian Dollar (CAD)\n* `KYD` - Cayman Islands Dollar (KYD)\n* `CLP` - Chile Peso (CLP)\n* `CNY` - China Yuan Renminbi (CNY)\n* `COP` - Colombia Peso (COP)\n* `CRC` - Costa Rica Colon (CRC)\n* `HRK` - Croatia Kuna (HRK)\n* `CUP` - Cuba Peso (CUP)\n* `CZK` - Czech Republic Koruna (CZK)\n* `DKK` - Denmark Krone (DKK)\n* `DOP` - Dominican Republic Peso (DOP)\n* `XCD` - East Caribbean Dollar (XCD)\n* `EGP` - Egypt Pound (EGP)\n* `SVC` - El Salvador Colon (SVC)\n* `EUR` - Euro (EUR)\n* `FKP` - Falkland Islands (Malvinas) Pound (FKP)\n* `FJD` - Fiji Dollar (FJD)\n* `GHC` - Ghana Cedi (GHC)\n* `GIP` - Gibraltar Pound (GIP)\n* `GTQ` - Guatemala Quetzal (GTQ)\n* `GGP` - Guernsey Pound (GGP)\n* `GYD` - Guyana Dollar (GYD)\n* `HNL` - Honduras Lempira (HNL)\n* `HKD` - Hong Kong Dollar (HKD)\n* `HUF` - Hungary Forint (HUF)\n* `ISK` - Iceland Krona (ISK)\n* `INR` - India Rupee (INR)\n* `IDR` - Indonesia Rupiah (IDR)\n* `IRR` - Iran Rial (IRR)\n* `IMP` - Isle of Man Pound (IMP)\n* `ILS` - Israel Shekel (ILS)\n* `JMD` - Jamaica Dollar (JMD)\n* `JPY` - Japan Yen (JPY)\n* `JEP` - Jersey Pound (JEP)\n* `KZT` - Kazakhstan Tenge (KZT)\n* `KES` - Kenyan shilling (KES)\n* `KPW` - Korea (North) Won (KPW)\n* `KRW` - Korea (South) Won (KRW)\n* `KGS` - Kyrgyzstan Som (KGS)\n* `LAK` - Laos Kip (LAK)\n* `LBP` - Lebanon Pound (LBP)\n* `LRD` - Liberia Dollar (LRD)\n* `MKD` - Macedonia Denar (MKD)\n* `MYR` - Malaysia Ringgit (MYR)\n* `MUR` - Mauritius Rupee (MUR)\n* `MXN` - Mexico Peso (MXN)\n* `MNT` - Mongolia Tughrik (MNT)\n* `MZN` - Mozambique Metical (MZN)\n* `NAD` - Namibia Dollar (NAD)\n* `NPR` - Nepal Rupee (NPR)\n* `ANG` - Netherlands Antilles Guilder (ANG)\n* `NZD` - New Zealand Dollar (NZD)\n* `NIO` - Nicaragua Cordoba (NIO)\n* `NGN` - Nigeria Naira (NGN)\n* `NOK` - Norway Krone (NOK)\n* `OMR` - Oman Rial (OMR)\n* `PKR` - Pakistan Rupee (PKR)\n* `PAB` - Panama Balboa (PAB)\n* `PYG` - Paraguay Guarani (PYG)\n* `PEN` - Peru Nuevo Sol (PEN)\n* `PHP` - Philippines Peso (PHP)\n* `PLN` - Poland Zloty (PLN)\n* `QAR` - Qatar Riyal (QAR)\n* `RON` - Romania New Leu (RON)\n* `RUB` - Russia Ruble (RUB)\n* `SHP` - Saint Helena Pound (SHP)\n* `SAR` - Saudi Arabia Riyal (SAR)\n* `RSD` - Serbia Dinar (RSD)\n* `SCR` - Seychelles Rupee (SCR)\n* `SGD` - Singapore Dollar (SGD)\n* `SBD` - Solomon Islands Dollar (SBD)\n* `SOS` - Somalia Shilling (SOS)\n* `ZAR` - South Africa Rand (ZAR)\n* `LKR` - Sri Lanka Rupee (LKR)\n* `SEK` - Sweden Krona (SEK)\n* `CHF` - Switzerland Franc (CHF)\n* `SRD` - Suriname Dollar (SRD)\n* `SYP` - Syria Pound (SYP)\n* `TWD` - Taiwan New Dollar (TWD)\n* `THB` - Thailand Baht (THB)\n* `TTD` - Trinidad and Tobago Dollar (TTD)\n* `TRY` - Turkey Lira (TRY)\n* `TRL` - Turkey Lira (TRL)\n* `TVD` - Tuvalu Dollar (TVD)\n* `UAH` - Ukraine Hryvnia (UAH)\n* `GBP` - United Kingdom Pound (GBP)\n* `USD` - United States Dollar (USD)\n* `UYU` - Uruguay Peso (UYU)\n* `UZS` - Uzbekistan Som (UZS)\n* `VEF` - Venezuela Bolivar (VEF)\n* `VND` - Viet Nam Dong (VND)\n* `YER` - Yemen Rial (YER)\n* `ZWD` - Zimbabwe Dollar (ZWD)\n* `AED` - United Arab Emirates Dirham (AED)\n* `MOP` - Macanese Pataca (MOP)\n* `KWD` - Kuwaiti Dinar (KWD)\n* `ZMW` - Zambian Kwacha (ZMW)\n* `WST` - Samoan Tala (WST)" }, "timezone": { "allOf": [ { "$ref": "#/components/schemas/TimezoneEnum" } ], "description": "Select the time zone that applies to your organization.\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Coyhaique` - America/Coyhaique\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GMT` - GMT\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC" } } }, "OrphanItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "date": { "type": "string", "format": "date-time" }, "veterinarian": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "cubex_item_id": { "type": "string", "maxLength": 255 }, "cubex_item_name": { "type": "string", "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "consultation_item": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "invoice_row": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "treatment_plan_item": { "type": "string", "format": "uri", "nullable": true }, "invoice_row_draft": { "type": "string", "format": "uri", "nullable": true }, "archived": { "type": "boolean" }, "info": { "nullable": true } }, "required": [ "consultation_item", "cubex_item_id", "cubex_item_name", "date", "id", "invoice_row", "item", "quantity", "url" ] }, "OrphanItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "date": { "type": "string", "format": "date-time" }, "veterinarian": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "cubex_item_id": { "type": "string", "minLength": 1, "maxLength": 255 }, "cubex_item_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "treatment_plan_item": { "type": "string", "format": "uri", "nullable": true }, "invoice_row_draft": { "type": "string", "format": "uri", "nullable": true }, "archived": { "type": "boolean" }, "info": { "nullable": true } }, "required": [ "cubex_item_id", "cubex_item_name", "date", "item", "quantity" ] }, "OutcomeTypeEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Refund\n* `2` - Charge\n* `3` - No Settlement" }, "PaginatedAccountNumberList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AccountNumber" } } } }, "PaginatedAccountingReportList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingReport" } } } }, "PaginatedAlternativePayerList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AlternativePayer" } } } }, "PaginatedAlternativePricingList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AlternativePricing" } } } }, "PaginatedAntibioticList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Antibiotic" } } } }, "PaginatedAntibioticPanelList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AntibioticPanel" } } } }, "PaginatedAppointmentCheckConflictsQueryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AppointmentCheckConflictsQuery" } } } }, "PaginatedAppointmentDetailList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AppointmentDetail" } } } }, "PaginatedAppointmentReminderList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AppointmentReminder" } } } }, "PaginatedAppointmentUploadList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AppointmentUpload" } } } }, "PaginatedArchiveImportJobList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ArchiveImportJob" } } } }, "PaginatedArchivedInvoiceReadList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRead" } } } }, "PaginatedArchivedInvoiceRowReadList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRowRead" } } } }, "PaginatedArchivedPaymentReadList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedPaymentRead" } } } }, "PaginatedAvailableWholesalerList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableWholesaler" } } } }, "PaginatedBatchList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Batch" } } } }, "PaginatedBloodPressureList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BloodPressure" } } } }, "PaginatedBodyConditionScoreList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BodyConditionScore" } } } }, "PaginatedCancellationReasonList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CancellationReason" } } } }, "PaginatedCashBookEntryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CashBookEntry" } } } }, "PaginatedClientCommunicationPreferenceRowList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ClientCommunicationPreferenceRow" } } } }, "PaginatedClientCommunicationPreferencesList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ClientCommunicationPreferences" } } } }, "PaginatedClientHoldingPlaceList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ClientHoldingPlace" } } } }, "PaginatedClientList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Client" } } } }, "PaginatedClinicalSignList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ClinicalSign" } } } }, "PaginatedCloudPrinterList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CloudPrinter" } } } }, "PaginatedCommunicationPreferenceRowList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationPreferenceRow" } } } }, "PaginatedConsultationAntibioticList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationAntibiotic" } } } }, "PaginatedConsultationAntibioticPanelList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationAntibioticPanel" } } } }, "PaginatedConsultationExtrasList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationExtras" } } } }, "PaginatedConsultationFoodList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationFood" } } } }, "PaginatedConsultationItemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationItem" } } } }, "PaginatedConsultationItemTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationItemTemplate" } } } }, "PaginatedConsultationLaboratoryAnalysisList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationLaboratoryAnalysis" } } } }, "PaginatedConsultationLaboratoryReferralList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationLaboratoryReferral" } } } }, "PaginatedConsultationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Consultation" } } } }, "PaginatedConsultationMedicineList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationMedicine" } } } }, "PaginatedConsultationOrganismList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationOrganism" } } } }, "PaginatedConsultationProcedureList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationProcedure" } } } }, "PaginatedConsultationSampleList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationSample" } } } }, "PaginatedConsultationSubCategoryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationSubCategory" } } } }, "PaginatedConsultationSupplyList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationSupply" } } } }, "PaginatedConsultationTargetAreaList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationTargetArea" } } } }, "PaginatedContentTypeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ContentType" } } } }, "PaginatedCountersaleList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Countersale" } } } }, "PaginatedCustomFieldList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } } }, "PaginatedCustomFieldOptionValueList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOptionValue" } } } }, "PaginatedCustomFieldValueList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "PaginatedCustomIntegrationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomIntegration" } } } }, "PaginatedDepartmentGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentGroup" } } } }, "PaginatedDepartmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Department" } } } }, "PaginatedDepartmentSettingsApiList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentSettingsApi" } } } }, "PaginatedDiagnosisList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Diagnosis" } } } }, "PaginatedDiagnosticImagingReferralList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticImagingReferral" } } } }, "PaginatedDiagnosticImagingWorklistList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DiagnosticImagingWorklist" } } } }, "PaginatedDischargeInstructionsList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DischargeInstructions" } } } }, "PaginatedDiscountSchemeBulkDiscountDetailsList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeBulkDiscountDetails" } } } }, "PaginatedDiscountSchemeItemDetailsList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeItemDetails" } } } }, "PaginatedDiscountSchemeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountScheme" } } } }, "PaginatedDiscountSchemeTargetDetailsList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeTargetDetails" } } } }, "PaginatedDiscountSchemeTimeDetailsList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountSchemeTimeDetails" } } } }, "PaginatedElectronicPrescriptionItemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ElectronicPrescriptionItem" } } } }, "PaginatedElectronicPrescriptionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ElectronicPrescription" } } } }, "PaginatedEmailLogList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EmailLog" } } } }, "PaginatedEndOfDayReportList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EndOfDayReport" } } } }, "PaginatedEstimateItemListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EstimateItemList" } } } }, "PaginatedEstimateItemTemplateUseList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EstimateItemTemplateUse" } } } }, "PaginatedEstimateListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/EstimateList" } } } }, "PaginatedExternalVaccinationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalVaccination" } } } }, "PaginatedFiscalDataList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/FiscalData" } } } }, "PaginatedFoodListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/FoodList" } } } }, "PaginatedGeneralPrescriptionItemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralPrescriptionItem" } } } }, "PaginatedGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } } } }, "PaginatedHealthPlanItemGroupListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HealthPlanItemGroupList" } } } }, "PaginatedHealthPlanItemListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HealthPlanItemList" } } } }, "PaginatedHealthPlanListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HealthPlanList" } } } }, "PaginatedHeartRateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HeartRate" } } } }, "PaginatedHomeDeliveryClientDataList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HomeDeliveryClientData" } } } }, "PaginatedHomeDeliveryDepartmentDataList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HomeDeliveryDepartmentData" } } } }, "PaginatedHomeDeliveryItemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HomeDeliveryItem" } } } }, "PaginatedHomeDeliveryOrderList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HomeDeliveryOrder" } } } }, "PaginatedHomeDeliveryPatientDataList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HomeDeliveryPatientData" } } } }, "PaginatedHookNotificationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/HookNotification" } } } }, "PaginatedImagingCategoryListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImagingCategoryList" } } } }, "PaginatedImagingSubCategoryListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImagingSubCategoryList" } } } }, "PaginatedImportedHistoryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ImportedHistory" } } } }, "PaginatedInsuranceClaimClientList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InsuranceClaimClient" } } } }, "PaginatedInsuranceClaimList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InsuranceClaim" } } } }, "PaginatedInsuranceClaimPatientList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InsuranceClaimPatient" } } } }, "PaginatedInvoiceExtrasList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceExtras" } } } }, "PaginatedInvoiceList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } } } }, "PaginatedInvoicePaymentDetailList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePaymentDetail" } } } }, "PaginatedInvoicePaymentExtrasList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePaymentExtras" } } } }, "PaginatedInvoiceRowDetailList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRowDetail" } } } }, "PaginatedInvoiceRowDraftDetailList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRowDraftDetail" } } } }, "PaginatedInvoiceRowExtraList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRowExtra" } } } }, "PaginatedInvoiceRowVatGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRowVatGroup" } } } }, "PaginatedItemConditionalPriceOverrideList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemConditionalPriceOverride" } } } }, "PaginatedItemDiagnosisGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDiagnosisGroup" } } } }, "PaginatedItemEntryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemEntry" } } } }, "PaginatedItemListDetailList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemListDetail" } } } }, "PaginatedItemListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemList" } } } }, "PaginatedItemSubgroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemSubgroup" } } } }, "PaginatedItemTemplateItemListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTemplateItemList" } } } }, "PaginatedItemTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTemplate" } } } }, "PaginatedJournalEntryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntry" } } } }, "PaginatedJournalEntryProblemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JournalEntryProblem" } } } }, "PaginatedJournalReportLogList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JournalReportLog" } } } }, "PaginatedJournalTransactionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransaction" } } } }, "PaginatedJournalTransactionProblemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransactionProblem" } } } }, "PaginatedKnowledgeBaseFileList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseFile" } } } }, "PaginatedKnowledgeBaseFolderList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseFolder" } } } }, "PaginatedKnowledgeBaseObjectList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseObject" } } } }, "PaginatedLaboratoryAnalysisGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/LaboratoryAnalysisGroup" } } } }, "PaginatedLaboratoryAnalysisListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/LaboratoryAnalysisList" } } } }, "PaginatedLaboratoryAnalysisPanelListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/LaboratoryAnalysisPanelList" } } } }, "PaginatedListItemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ListItem" } } } }, "PaginatedListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/List" } } } }, "PaginatedLocationAlertLevelList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/LocationAlertLevel" } } } }, "PaginatedMasterDataEntryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MasterDataEntry" } } } }, "PaginatedMedicineListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MedicineList" } } } }, "PaginatedMedicineMetaDataList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MedicineMetaData" } } } }, "PaginatedMedicineTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MedicineTemplate" } } } }, "PaginatedModalityList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Modality" } } } }, "PaginatedNetPromoterScoreList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NetPromoterScore" } } } }, "PaginatedNoteList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } } } }, "PaginatedNoteUploadList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/NoteUpload" } } } }, "PaginatedOnlineBookingClientList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OnlineBookingClient" } } } }, "PaginatedOnlineBookingPatientList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OnlineBookingPatient" } } } }, "PaginatedOnlineBookingTriggerTopicList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OnlineBookingTriggerTopic" } } } }, "PaginatedOrderItemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" } } } }, "PaginatedOrganismList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Organism" } } } }, "PaginatedOrganizationSettingsList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationSettings" } } } }, "PaginatedOrphanItemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/OrphanItem" } } } }, "PaginatedPatientConsultationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientConsultation" } } } }, "PaginatedPatientExtrasList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientExtras" } } } }, "PaginatedPatientGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientGroup" } } } }, "PaginatedPatientHealthPlanItemGroupListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientHealthPlanItemGroupList" } } } }, "PaginatedPatientHealthPlanItemListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientHealthPlanItemList" } } } }, "PaginatedPatientHealthPlanListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientHealthPlanList" } } } }, "PaginatedPatientHealthPlanPaymentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientHealthPlanPayment" } } } }, "PaginatedPatientList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Patient" } } } }, "PaginatedPatientLocationAttributeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientLocationAttribute" } } } }, "PaginatedPatientLocationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientLocation" } } } }, "PaginatedPatientReferralList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientReferral" } } } }, "PaginatedPatientStatusList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PatientStatus" } } } }, "PaginatedPaymentMethodList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethod" } } } }, "PaginatedPeripheralOxygenSaturationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PeripheralOxygenSaturation" } } } }, "PaginatedPersonnelGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PersonnelGroup" } } } }, "PaginatedPetmedchainDocumentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PetmedchainDocument" } } } }, "PaginatedPetmedchainPetList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PetmedchainPet" } } } }, "PaginatedPhoneList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Phone" } } } }, "PaginatedPortalClientLinkList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PortalClientLink" } } } }, "PaginatedPosTransactionResultList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PosTransactionResult" } } } }, "PaginatedPreliminaryBookingList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PreliminaryBooking" } } } }, "PaginatedPrescriptionBillingErrorList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PrescriptionBillingError" } } } }, "PaginatedPrescriptionBillingList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PrescriptionBilling" } } } }, "PaginatedPrescriptionRepeatList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PrescriptionRepeat" } } } }, "PaginatedProcedureListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ProcedureList" } } } }, "PaginatedProductOrderList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ProductOrder" } } } }, "PaginatedReasonGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReasonGroup" } } } }, "PaginatedReasonList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Reason" } } } }, "PaginatedReceivablesFileList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivablesFile" } } } }, "PaginatedReceivablesPaymentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivablesPayment" } } } }, "PaginatedReferralFeedbackAttachmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReferralFeedbackAttachment" } } } }, "PaginatedReferralFeedbackList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReferralFeedback" } } } }, "PaginatedReferralInternalStatusList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReferralInternalStatus" } } } }, "PaginatedReferrerList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Referrer" } } } }, "PaginatedRefillItemList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RefillItem" } } } }, "PaginatedReminderList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Reminder" } } } }, "PaginatedReminderTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ReminderTemplate" } } } }, "PaginatedResourceDetailList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceDetail" } } } }, "PaginatedResourcesAvailabilityList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ResourcesAvailability" } } } }, "PaginatedRespiratoryRateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/RespiratoryRate" } } } }, "PaginatedShiftTemplateBlockFragmentList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTemplateBlockFragment" } } } }, "PaginatedShiftTemplateBlockList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTemplateBlock" } } } }, "PaginatedShiftTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftTemplate" } } } }, "PaginatedShiftTypeList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/ShiftType" } } } }, "PaginatedSmsLogList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SmsLog" } } } }, "PaginatedStockItemListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/StockItemList" } } } }, "PaginatedStockLocationList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/StockLocation" } } } }, "PaginatedSupplyListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SupplyList" } } } }, "PaginatedTagTextList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TagText" } } } }, "PaginatedTargetAreaList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TargetArea" } } } }, "PaginatedTaskList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } } }, "PaginatedTeamList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } } } }, "PaginatedTemperatureList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Temperature" } } } }, "PaginatedTemplateInTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateInTemplate" } } } }, "PaginatedTextTemplateList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TextTemplate" } } } }, "PaginatedTransactionTerminalList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionTerminal" } } } }, "PaginatedTreatmentPlanFoodList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TreatmentPlanFood" } } } }, "PaginatedTreatmentPlanListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TreatmentPlanList" } } } }, "PaginatedTreatmentPlanMedicineList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TreatmentPlanMedicine" } } } }, "PaginatedTreatmentPlanProcedureList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TreatmentPlanProcedure" } } } }, "PaginatedTreatmentPlanSupplyList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TreatmentPlanSupply" } } } }, "PaginatedTriageCategoryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TriageCategory" } } } }, "PaginatedTriageEntryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/TriageEntry" } } } }, "PaginatedTriageList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Triage" } } } }, "PaginatedUnallocatedPaymentExternalInfoList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UnallocatedPaymentExternalInfo" } } } }, "PaginatedUnallocatedPaymentListList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UnallocatedPaymentList" } } } }, "PaginatedUploadList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Upload" } } } }, "PaginatedUserDepartmentPermissionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserDepartmentPermission" } } } }, "PaginatedUserDetailsList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserDetails" } } } }, "PaginatedUserList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } }, "PaginatedUserSchedulingList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserScheduling" } } } }, "PaginatedUserViewHistoryList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/UserViewHistory" } } } }, "PaginatedVatGroupList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/VatGroup" } } } }, "PaginatedVetsAvailabilityList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/VetsAvailability" } } } }, "PaginatedWardList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Ward" } } } }, "PaginatedWebhookList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } } }, "PaginatedWeightList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Weight" } } } }, "PaginatedWholesalerResponseList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WholesalerResponse" } } } }, "PaginatedWrittenPrescriptionExtrasList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WrittenPrescriptionExtras" } } } }, "PaginatedWrittenPrescriptionList": { "type": "object", "required": [ "count", "results" ], "properties": { "count": { "type": "integer", "example": 123 }, "next": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=4" }, "previous": { "type": "string", "nullable": true, "format": "uri", "example": "http://api.example.org/accounts/?page=2" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/WrittenPrescription" } } } }, "PatchedAccountNumberRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "number": { "type": "string", "minLength": 1, "maxLength": 30 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "department": { "type": "string", "format": "uri", "nullable": true }, "archived": { "type": "boolean" } } }, "PatchedAdmitConsultationRequest": { "type": "object", "description": "Serializer for admitting consultations. This is only used to make sure that the\ninput is valid with accordance to the model. The rest of the checks are handled\nin SaveConsultation as the POST data is passed to the form used in Provet.\nOther errors will be returned from there.", "properties": { "admitted_time": { "type": "string", "format": "date-time" }, "complaint": { "type": "string", "minLength": 1 }, "custom_fields": {}, "type": { "type": "integer" }, "department": { "type": "string", "format": "uri" }, "complaint_type": { "type": "string", "format": "uri" }, "go_after": { "allOf": [ { "$ref": "#/components/schemas/GoAfterEnum" } ], "default": "dashboard" }, "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "supervising_veterinarian": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri" }, "started": { "type": "string", "format": "date-time" }, "holding_place_number": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } } } }, "PatchedAlternativePayerRequest": { "type": "object", "properties": { "name": { "type": "string", "title": "Invoicing name", "maxLength": 127 }, "id_number": { "type": "string", "title": "Invoicing ID number", "maxLength": 63 }, "organization_name": { "type": "string", "nullable": true, "title": "Invoicing organization name", "maxLength": 127 }, "register_number": { "type": "string", "nullable": true, "title": "Invoicing register number", "maxLength": 31 }, "street_address": { "type": "string", "nullable": true, "title": "Invoicing street address", "maxLength": 127 }, "street_address_2": { "type": "string", "nullable": true, "title": "Invoicing street address 2", "maxLength": 127 }, "street_address_3": { "type": "string", "nullable": true, "title": "Invoicing street address 3", "maxLength": 127 }, "zip_code": { "type": "string", "title": "Invoicing zip code", "maxLength": 12 }, "city": { "type": "string", "title": "Invoicing city", "maxLength": 63 }, "state": { "nullable": true, "title": "Invoicing state", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "maxLength": 100 }, "einvoice_address": { "type": "string", "nullable": true, "title": "E-invoice electronic address", "maxLength": 100 }, "einvoice_operator": { "type": "string", "nullable": true, "title": "E-invoice operator identifier", "maxLength": 100 } } }, "PatchedAlternativePricingRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "item": { "type": "string", "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "nominator": { "allOf": [ { "$ref": "#/components/schemas/NominatorEnum" } ], "minimum": -32768, "maximum": 32767 }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_extra_fees": { "type": "boolean" } } }, "PatchedAppointmentCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "complaint": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "reason": { "type": "string", "format": "uri", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "additional_users": { "type": "array", "items": { "type": "string", "format": "uri" } }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "parent_appointment": { "type": "string", "format": "uri", "nullable": true }, "notes": { "type": "string", "nullable": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "department": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/TypeAe4Enum" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "active": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "telemedicine_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "telemedicine_url_master": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "cancellation_reason_text": { "type": "string", "nullable": true, "maxLength": 255 }, "cancellation_reason": { "type": "string", "format": "uri", "nullable": true }, "no_show": { "type": "boolean" }, "telemedicine_room": { "type": "string", "nullable": true, "maxLength": 60 }, "ward": { "type": "string", "format": "uri", "nullable": true }, "client_notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "related_shifts": { "type": "array", "items": { "type": "string", "format": "uri" } }, "allow_double_booking": { "type": "boolean", "default": false }, "confirmed": { "type": "boolean" }, "holding_place_numbers": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Holding place number" }, "title": "Holding place number" } } }, "PatchedAppointmentReminderDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode095Enum" } ], "minimum": -32768, "maximum": 32767 }, "send_date": { "type": "string", "format": "date", "nullable": true }, "send_datetime": { "type": "string", "format": "date-time" }, "send_externally": { "type": "boolean" }, "sent_datetime": { "type": "string", "format": "date-time", "nullable": true }, "phone_number": { "type": "string", "minLength": 1, "maxLength": 31 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "sms_text": { "type": "string", "minLength": 1 }, "sms_text_sent": { "type": "string", "nullable": true, "minLength": 1 } } }, "PatchedArchivedInvoiceUpdateRequest": { "type": "object", "description": "Serializer for updating an existing archived invoice (PATCH/PUT).\n\nAll fields are optional; only provided fields are updated.\nIf rows or payments are provided, existing rows/payments are replaced.", "properties": { "source": { "type": "string", "description": "Source system name (e.g. VETERA, or custom).", "maxLength": 50 }, "source_invoice_number": { "type": "string", "minLength": 1, "maxLength": 100 }, "client_id": { "type": "integer" }, "patient_ids": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "supervising_veterinarian_id": { "type": "integer", "nullable": true }, "department_id": { "type": "integer" }, "invoice_date": { "type": "string", "format": "date" }, "finalized_at": { "type": "string", "format": "date-time", "nullable": true }, "currency_code": { "type": "string", "minLength": 1, "maxLength": 3 }, "total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "total_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "total_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "due_sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "status": { "$ref": "#/components/schemas/StatusC54Enum" }, "is_credit_note": { "type": "boolean" }, "is_countersale": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "payer_snapshot": { "allOf": [ { "$ref": "#/components/schemas/PayerSnapshotRequest" } ], "nullable": true }, "receiver_snapshot": { "allOf": [ { "$ref": "#/components/schemas/ReceiverSnapshotRequest" } ], "nullable": true }, "invoice_details_snapshot": { "nullable": true }, "patients_snapshot": { "type": "array", "items": { "$ref": "#/components/schemas/PatientSnapshotItemRequest" }, "nullable": true }, "vat_breakdown": { "nullable": true }, "meta_json": { "nullable": true }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedInvoiceRowWriteRequest" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivedPaymentWriteRequest" } } } }, "PatchedAvailableWholesalerRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 63 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 }, "webhook_callback_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 200 }, "verification_salt": { "type": "string", "writeOnly": true, "minLength": 16, "description": "Shared secret used to HMAC-sign webhook deliveries. Required on create; send a new value to rotate it.", "maxLength": 128 } } }, "PatchedBatchRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "batch_number": { "type": "string", "minLength": 1, "maxLength": 63 }, "department_id": { "type": "integer" }, "expiry_date": { "type": "string", "format": "date" }, "item_id": { "type": "integer" }, "stock_item": { "type": "string", "format": "uri" } } }, "PatchedBloodPressureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "blood_pressure_max": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "blood_pressure_min": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "body_position": { "allOf": [ { "$ref": "#/components/schemas/BodyPositionEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedBodyConditionScoreRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "body_condition_score": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedCancellationReasonRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "department": { "type": "string", "format": "uri" }, "archived": { "type": "boolean" }, "mapping": { "allOf": [ { "$ref": "#/components/schemas/MappingEnum" } ], "minimum": 0, "maximum": 65535 }, "external": { "type": "boolean" } } }, "PatchedClientCommunicationPreferenceRowRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "sms": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "post": { "type": "boolean" }, "client_preferences": { "type": "string", "format": "uri" }, "organization_preference_row": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedClientCommunicationPreferencesRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri", "nullable": true }, "valid_from": { "type": "string", "format": "date" }, "valid_to": { "type": "string", "format": "date" }, "privacy_policy_version": { "type": "string", "nullable": true }, "consent_given": { "allOf": [ { "$ref": "#/components/schemas/ConsentGivenEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "preference_rows": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedClientHoldingPlaceRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "holding_place_number": { "type": "string", "minLength": 1, "maxLength": 31 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedClientRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer" }, "title": { "type": "string", "nullable": true, "description": "Title or honorific (e.g., Dr., Mr., Mrs.)", "maxLength": 32 }, "firstname": { "type": "string", "title": "First name", "description": "Client's first name", "maxLength": 127 }, "lastname": { "type": "string", "title": "Last name", "description": "Client's last name", "maxLength": 127 }, "organization_name": { "type": "string", "nullable": true, "description": "Name of organization (for company clients)", "maxLength": 127 }, "customer_type": { "allOf": [ { "$ref": "#/components/schemas/CustomerTypeEnum" } ], "description": "Customer type: 0=Private person, 1=Company, 2=EU Company, 3=Charitable organization, 4=UK charity\n\n* `0` - Private person\n* `1` - Company\n* `2` - EU Company\n* `3` - Charitable organization\n* `4` - UK charity", "minimum": -2147483648, "maximum": 2147483647 }, "vat_number": { "type": "string", "description": "VAT/Tax identification number", "maxLength": 31 }, "register_number": { "type": "string", "nullable": true, "description": "Business register number", "maxLength": 31 }, "home_department": { "type": "string", "format": "uri", "nullable": true, "description": "URL to primary department this client belongs to" }, "due_date_delay": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "Number of days to delay invoice due date (can be negative)" }, "street_address": { "type": "string", "description": "Primary street address line", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "title": "Second address line", "description": "Second street address line (optional)", "maxLength": 255 }, "street_address_3": { "type": "string", "nullable": true, "title": "Third address line", "description": "Third street address line (optional)", "maxLength": 255 }, "zip_code": { "type": "string", "title": "Post code", "description": "Postal code", "maxLength": 12 }, "city": { "type": "string", "description": "City name", "maxLength": 63 }, "state": { "nullable": true, "description": "US state (for US addresses)\n\n* `AL` - Alabama\n* `AK` - Alaska\n* `AS` - American Samoa\n* `AZ` - Arizona\n* `AR` - Arkansas\n* `AA` - Armed Forces Americas\n* `AE` - Armed Forces Europe\n* `AP` - Armed Forces Pacific\n* `CA` - California\n* `CO` - Colorado\n* `CT` - Connecticut\n* `DE` - Delaware\n* `DC` - District of Columbia\n* `FL` - Florida\n* `GA` - Georgia\n* `GU` - Guam\n* `HI` - Hawaii\n* `ID` - Idaho\n* `IL` - Illinois\n* `IN` - Indiana\n* `IA` - Iowa\n* `KS` - Kansas\n* `KY` - Kentucky\n* `LA` - Louisiana\n* `ME` - Maine\n* `MD` - Maryland\n* `MA` - Massachusetts\n* `MI` - Michigan\n* `MN` - Minnesota\n* `MS` - Mississippi\n* `MO` - Missouri\n* `MT` - Montana\n* `NE` - Nebraska\n* `NV` - Nevada\n* `NH` - New Hampshire\n* `NJ` - New Jersey\n* `NM` - New Mexico\n* `NY` - New York\n* `NC` - North Carolina\n* `ND` - North Dakota\n* `MP` - Northern Mariana Islands\n* `OH` - Ohio\n* `OK` - Oklahoma\n* `OR` - Oregon\n* `PA` - Pennsylvania\n* `PR` - Puerto Rico\n* `RI` - Rhode Island\n* `SC` - South Carolina\n* `SD` - South Dakota\n* `TN` - Tennessee\n* `TX` - Texas\n* `UT` - Utah\n* `VT` - Vermont\n* `VI` - Virgin Islands\n* `VA` - Virginia\n* `WA` - Washington\n* `WV` - West Virginia\n* `WI` - Wisconsin\n* `WY` - Wyoming", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "country_region": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, US-CA)", "maxLength": 100 }, "email": { "type": "string", "format": "email", "nullable": true, "description": "Primary email address", "maxLength": 254 }, "alt_emails": { "type": "string", "nullable": true, "title": "Additional emails", "description": "Additional email addresses (comma-separated)", "maxLength": 127 }, "id_number": { "type": "string", "description": "Client ID/customer number", "maxLength": 63 }, "old_client_id": { "type": "string", "nullable": true, "description": "Legacy client ID from previous system", "maxLength": 32 }, "critical_notes": { "type": "string", "nullable": true, "description": "Critical notes displayed prominently (max 255 chars)", "maxLength": 255 }, "critical_accounting_notes": { "type": "string", "nullable": true, "description": "Critical accounting notes (max 255 chars)", "maxLength": 255 }, "remarks": { "type": "string", "nullable": true, "description": "General remarks and notes (no length limit)" }, "archived": { "type": "boolean", "description": "True if client is archived/inactive" }, "country": { "nullable": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US).\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe", "oneOf": [ { "$ref": "#/components/schemas/CountryEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "no_sms": { "type": "boolean", "title": "Disable SMS sending", "description": "True if SMS sending is disabled for this client" }, "no_email": { "type": "boolean", "title": "Disable email sending", "description": "True if email sending is disabled for this client" }, "external": { "type": "boolean", "description": "True if client is external (not a regular customer)" }, "referring_organization": { "type": "boolean", "description": "True if this client is a referring organization" }, "parent_referring_organization": { "type": "string", "format": "uri", "nullable": true, "description": "URL to parent organization this referring vet belongs to" }, "breeder": { "type": "boolean" }, "referring_vet": { "type": "boolean", "title": "Referring veterinarian", "description": "True if this client is a referring veterinarian" }, "imported": { "type": "boolean", "description": "True if client was imported from another system" }, "date_imported": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when client was imported" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to patients owned by this client" }, "invoicing_client": { "type": "string", "format": "uri", "nullable": true, "description": "URL to another client who receives invoices for this client" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to user who created this client" }, "modified_user": { "type": "string", "format": "uri", "nullable": true, "description": "URL to user who last modified this client" }, "status_type": { "allOf": [ { "$ref": "#/components/schemas/StatusTypeEnum" } ], "title": "Client status", "description": "Client status: 0=Internal, 1=Research, 2=External\n\n* `0` - Internal\n* `1` - Research\n* `2` - External", "minimum": -2147483648, "maximum": 2147483647 }, "fields_rel": { "type": "array", "items": {} }, "farm_code": { "type": "string", "nullable": true, "title": "Unique farm code", "description": "Unique farm identification code", "maxLength": 31 }, "production_animal_client": { "type": "boolean", "description": "True if client owns production animals (farm animals)" }, "einvoice_address": { "type": "string", "nullable": true, "title": "E-invoice electronic address", "description": "Electronic invoice address (e-invoicing)", "maxLength": 100 }, "einvoice_operator": { "type": "string", "nullable": true, "title": "E-invoice operator identifier", "description": "Electronic invoice operator identifier", "maxLength": 100 }, "alternative_payer": { "type": "string", "format": "uri", "nullable": true, "description": "URL to alternative payer for invoices (e.g., insurance company)" }, "secondary_owner_first_name": { "type": "string", "description": "First name of secondary owner/contact person", "maxLength": 127 }, "secondary_owner_last_name": { "type": "string", "description": "Last name of secondary owner/contact person", "maxLength": 127 }, "on_stop": { "type": "boolean", "description": "True if client is on stop (blocked from receiving services)" }, "has_alive_patients": { "type": "boolean", "description": "True if client has at least one non-deceased patient" }, "gender": { "nullable": true, "description": "Client gender: 1=Male, 2=Female, 3=Other\n\n* `1` - Male\n* `2` - Female\n* `3` - Other", "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/ClientGenderEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Client's date of birth (YYYY-MM-DD)" }, "drivers_licence_number": { "type": "string", "title": "Driver's license number", "description": "Driver's license number", "maxLength": 31 } } }, "PatchedCommunicationPreferenceRowRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "active": { "type": "boolean" }, "editable": { "type": "boolean" }, "sms": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "post": { "type": "boolean" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedConsultationAntibioticPanelRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "antibiotic_panel": { "type": "string", "format": "uri" }, "consultation_organism": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedConsultationAntibioticRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "antibiotic": { "type": "string", "format": "uri" }, "consultation_organism": { "type": "string", "format": "uri" }, "panel": { "type": "string", "format": "uri", "nullable": true }, "resistant": { "type": "boolean" }, "intermediate": { "type": "boolean" }, "sensitive": { "type": "boolean" }, "mic": { "type": "string", "nullable": true } } }, "PatchedConsultationExternalSentRequest": { "type": "object", "description": "Serializer that will only allow modifying the external_sent field", "properties": { "external_sent": { "type": "string", "format": "date-time", "nullable": true } } }, "PatchedConsultationExtrasRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "exported": { "type": "string", "format": "date-time", "nullable": true }, "export_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "imported": { "type": "string", "format": "date-time", "nullable": true }, "import_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "discharge_time": { "type": "string", "format": "date-time", "nullable": true } } }, "PatchedConsultationFoodRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "minLength": 1, "maxLength": 63 }, "package_description": { "type": "string", "minLength": 1, "maxLength": 63 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedConsultationIntegrationStatusRequest": { "type": "object", "description": "Serializer that will only allow modifying the integration_status field", "properties": { "integration_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true } } }, "PatchedConsultationItemTemplateCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "main_consultation_template": { "type": "string", "format": "uri", "nullable": true }, "base_template": { "type": "string", "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "price_change_item": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedConsultationLaboratoryAnalysisUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "reference_low": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "reference_high": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "result_numeric": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "result": { "type": "string", "nullable": true }, "result_entered": { "type": "string", "format": "date-time", "nullable": true }, "approved": { "type": "boolean" }, "approved_date": { "type": "string", "format": "date-time", "nullable": true }, "measurement_unit": { "type": "string", "maxLength": 100 }, "device": { "type": "string", "maxLength": 255 }, "remarks": { "type": "string", "nullable": true }, "order_in_panel": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "description": { "type": "string", "nullable": true, "maxLength": 60 }, "calculate_additional_tax": { "type": "boolean" }, "result_code": { "type": "string", "maxLength": 40 }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "referral": { "type": "string", "format": "uri" }, "panel": { "type": "string", "format": "uri", "nullable": true }, "approved_by": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedConsultationLaboratoryReferralRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "nullable": true }, "laboratory_type": { "allOf": [ { "$ref": "#/components/schemas/LaboratoryTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "type": { "allOf": [ { "$ref": "#/components/schemas/ConsultationLaboratoryReferralTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status7c4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "inhouse_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks": { "type": "string", "nullable": true }, "laboratory_remarks": { "type": "string", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "referral_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "laboratory_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "laboratory_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "internal_notes_user": { "type": "string", "format": "uri", "nullable": true }, "internal_notes_modified": { "type": "string", "format": "date-time", "nullable": true }, "sample_location": { "nullable": true }, "locked": { "type": "string", "format": "date-time", "nullable": true }, "locked_user": { "type": "string", "format": "uri", "nullable": true }, "never_require_results": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "external_status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalStatusEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "external_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "internal_id": { "type": "string", "nullable": true, "maxLength": 31 }, "internal_status": { "type": "string", "format": "uri", "nullable": true }, "sampler": { "type": "string", "format": "uri", "nullable": true }, "sample_taken": { "type": "string", "format": "date-time", "nullable": true }, "referring_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "create_task_for": { "type": "array", "items": { "type": "string", "format": "uri" } }, "urgent": { "type": "boolean" }, "analyses": { "type": "array", "items": { "type": "string", "format": "uri" } }, "panels": { "type": "array", "items": { "type": "string", "format": "uri" } }, "samples": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedConsultationMedicineRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "numeric_withdrawal_periods": { "type": "array", "items": { "$ref": "#/components/schemas/ConsultationMedicineWithdrawalPeriodRequest" } }, "use_reason": { "type": "string", "format": "uri" }, "vaccination_disease": { "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "administration_method": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/AdministrationMethodEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "administration_speed": { "type": "number", "format": "double", "maximum": 100000, "minimum": -100000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "administration_hours": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "active_substance": { "type": "string", "nullable": true }, "controlled_substance": { "type": "boolean" }, "vaccination": { "type": "boolean" }, "vaccination_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/VaccinationTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "contraindications": { "type": "string", "nullable": true }, "preparation": { "type": "string", "nullable": true, "maxLength": 255 }, "manufacturer_data": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "minLength": 1, "maxLength": 63 }, "package_description": { "type": "string", "minLength": 1, "maxLength": 63 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "withdrawal_periods": { "type": "string", "nullable": true }, "measurement_loss_quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "measurement_loss_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "dispense_fee": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Handling fee" }, "injection_fee": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "dispense_fee_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Handling fee with VAT" }, "injection_fee_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_default_dispense_fee": { "type": "boolean", "title": "Use default handling fee" }, "not_for_food": { "type": "boolean" }, "use_dispense_fee": { "type": "boolean", "title": "Use handling fee" }, "effect_time": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "medication_duration_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "medication_diagnosis": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedConsultationOrganismRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "description": { "type": "string", "nullable": true }, "organism": { "type": "string", "format": "uri" }, "consultation_analysis": { "type": "string", "format": "uri" } } }, "PatchedConsultationProcedureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "description": { "type": "string", "nullable": true }, "calculate_additional_tax": { "type": "boolean" }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "sub_category": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedConsultationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri", "description": "URL to client associated with this consultation" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to patients being treated in this consultation" }, "complaint": { "type": "string", "nullable": true, "description": "Chief complaint or reason for consultation", "maxLength": 255 }, "complaint_type": { "type": "string", "format": "uri", "nullable": true, "description": "URL to structured complaint type classification" }, "admitted_time": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when patient was admitted" }, "first_entry": { "type": "string", "format": "date-time", "nullable": true, "description": "Time of first clinical entry" }, "started": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation officially started" }, "finished": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation was finished" }, "ended": { "type": "string", "format": "date-time", "nullable": true, "description": "Time when consultation was ended/closed" }, "status": { "nullable": true, "description": "Consultation status (open, in progress, completed, etc.)\n\n* `0` - Checked in\n* `8` - In progress\n* `5` - Ready for discharge\n* `7` - Invoicing\n* `6` - Discharged\n* `9` - Invoice paid\n* `10` - Finalized\n* `11` - Draft", "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status9c9Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type2a8Enum" } ], "description": "Type of consultation (standard, emergency, follow-up, etc.)\n\n* `1` - Outpatient\n* `0` - Inpatient\n* `2` - Home call\n* `3` - Farm visit\n* `4` - Boarding\n* `5` - Pet service", "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "string", "format": "uri" }, "supervising_veterinarian": { "type": "string", "format": "uri", "description": "URL to veterinarian supervising/performing consultation" }, "department": { "type": "string", "format": "uri", "description": "URL to department where consultation took place" }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "List of URLs to items used/administered (medications, procedures, etc.)" }, "reporting_dimension_1": { "type": "string", "minLength": 1, "description": "Reporting dimension 1 id can be found on active Reporting dimension 1 list" }, "reporting_dimension_2": { "type": "string", "minLength": 1, "description": "Reporting dimension 2 id can be found on active Reporting dimension 2 list" }, "reporting_dimension_3": { "type": "string", "minLength": 1, "description": "Reporting dimension 3 id can be found on active Reporting dimension 3 list" }, "consultation_notes": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_diagnosis": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_dischargeinstructions": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_patient_status": { "type": "array", "items": { "type": "string", "format": "uri" } }, "triage": { "type": "string", "format": "uri", "description": "URL to triage assessment and priority level" }, "external_sent": { "type": "string", "format": "date-time", "nullable": true, "description": "True if consultation was sent to external system" }, "ward": { "type": "string", "format": "uri" }, "patient_location": { "type": "string", "format": "uri" }, "integration_status": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "Status of integration with external systems" }, "holding_place_number": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "URL to holding place number for production animal consultation" }, "report_to_authorities": { "type": "boolean", "description": "True if consultation should be reported to authorities" }, "custom_fields": { "type": "string" }, "referring_organization": { "type": "string", "format": "uri", "nullable": true, "description": "URL to organization that referred this consultation" }, "referring_vet": { "type": "string", "format": "uri", "nullable": true, "description": "URL to veterinarian who referred this consultation" } } }, "PatchedConsultationSampleUpdateRequest": { "type": "object", "properties": { "referral": { "type": "integer" }, "coded_sample_type": { "type": "integer", "nullable": true, "minimum": -9223372036854775808, "maximum": 9223372036854775807 }, "quantity": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "site": { "type": "string", "nullable": true, "maxLength": 255 }, "comment": { "type": "string", "nullable": true }, "received_date": { "type": "string", "format": "date-time", "nullable": true }, "received_user": { "type": "integer", "nullable": true }, "items": { "type": "array", "items": { "type": "integer" } } } }, "PatchedConsultationSupplyRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "used": { "type": "string", "format": "date-time", "nullable": true }, "department_rate_override": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "is_dispense_fee_item": { "type": "boolean" }, "is_injection_fee_item": { "type": "boolean" }, "is_prescription_fee_item": { "type": "boolean" }, "herd_size_multiplier": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "instructions": { "type": "string", "nullable": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unit": { "type": "string", "minLength": 1, "maxLength": 63 }, "package_description": { "type": "string", "minLength": 1, "maxLength": 63 }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "dosage_units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "item": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "performed_by": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "template": { "type": "string", "format": "uri", "nullable": true }, "template_item": { "type": "string", "format": "uri", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "sibling_items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedConsultationTargetAreaRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "target_area": { "type": "string", "format": "uri" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "code": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 16 }, "procedure": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "category_id": { "type": "integer", "nullable": true }, "sub_category_id": { "type": "integer", "nullable": true } } }, "PatchedCountersaleRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri", "title": "Countersale department" }, "client": { "type": "string", "format": "uri", "nullable": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "invoice_row": { "type": "array", "items": { "type": "string", "format": "uri" } }, "remarks": { "type": "string", "nullable": true } } }, "PatchedCustomFieldValueRequest": { "type": "object", "properties": { "field": { "type": "integer" }, "value": { "type": "string" }, "object_id": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "compound_values": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedCustomFieldValueUpdateRequest": { "type": "object", "properties": { "value": { "type": "string", "nullable": true } } }, "PatchedCustomIntegrationRequest": { "type": "object", "description": "Opt-in mixin to reject unknown input fields for POST/PATCH.", "properties": { "url": { "type": "string", "minLength": 1, "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "enabled": { "type": "boolean" }, "type": { "allOf": [ { "$ref": "#/components/schemas/CustomIntegrationTypeEnum" } ], "minimum": -32768, "maximum": 32767 }, "action": { "allOf": [ { "$ref": "#/components/schemas/ActionEnum" } ], "minimum": -32768, "maximum": 32767 }, "action_parameters": { "type": "string", "maxLength": 255 }, "method": { "allOf": [ { "$ref": "#/components/schemas/MethodEnum" } ], "minimum": -32768, "maximum": 32767 }, "parameter_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "headers": { "nullable": true }, "verification": { "type": "boolean" }, "verification_payload": { "type": "boolean", "default": false }, "verification_salt": { "type": "string", "maxLength": 255 }, "expose_organization_info": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedDepartmentSettingsApiRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "phone": { "type": "string" }, "email": { "type": "string" }, "alternative_emails": { "type": "string", "description": "Define alternative email addresses that can be used when sending emails from the system. Separate with commas." }, "invoice_street_address": { "type": "string", "description": "Street address to be shown in an invoice." }, "invoice_street_address_2": { "type": "string", "description": "The second line of the street address." }, "invoice_zip_code": { "type": "string" }, "invoice_city": { "type": "string" }, "invoice_country": { "nullable": true, "description": "ISO 3166-1 alpha-2 country code (e.g. FI, US).\n\n* `AF` - Afghanistan\n* `AX` - Åland Islands\n* `AL` - Albania\n* `DZ` - Algeria\n* `AS` - American Samoa\n* `AD` - Andorra\n* `AO` - Angola\n* `AI` - Anguilla\n* `AQ` - Antarctica\n* `AG` - Antigua and Barbuda\n* `AR` - Argentina\n* `AM` - Armenia\n* `AW` - Aruba\n* `AU` - Australia\n* `AT` - Austria\n* `AZ` - Azerbaijan\n* `BS` - Bahamas\n* `BH` - Bahrain\n* `BD` - Bangladesh\n* `BB` - Barbados\n* `BY` - Belarus\n* `BE` - Belgium\n* `BZ` - Belize\n* `BJ` - Benin\n* `BM` - Bermuda\n* `BT` - Bhutan\n* `BO` - Bolivia\n* `BQ` - Bonaire, Sint Eustatius and Saba\n* `BA` - Bosnia and Herzegovina\n* `BW` - Botswana\n* `BV` - Bouvet Island\n* `BR` - Brazil\n* `IO` - British Indian Ocean Territory\n* `BN` - Brunei\n* `BG` - Bulgaria\n* `BF` - Burkina Faso\n* `BI` - Burundi\n* `CV` - Cabo Verde\n* `KH` - Cambodia\n* `CM` - Cameroon\n* `CA` - Canada\n* `KY` - Cayman Islands\n* `CF` - Central African Republic\n* `TD` - Chad\n* `CL` - Chile\n* `CN` - China\n* `CX` - Christmas Island\n* `CC` - Cocos (Keeling) Islands\n* `CO` - Colombia\n* `KM` - Comoros\n* `CG` - Congo\n* `CD` - Congo (the Democratic Republic of the)\n* `CK` - Cook Islands\n* `CR` - Costa Rica\n* `CI` - Côte d'Ivoire\n* `HR` - Croatia\n* `CU` - Cuba\n* `CW` - Curaçao\n* `CY` - Cyprus\n* `CZ` - Czechia\n* `DK` - Denmark\n* `DJ` - Djibouti\n* `DM` - Dominica\n* `DO` - Dominican Republic\n* `EC` - Ecuador\n* `EG` - Egypt\n* `SV` - El Salvador\n* `GQ` - Equatorial Guinea\n* `ER` - Eritrea\n* `EE` - Estonia\n* `SZ` - Eswatini\n* `ET` - Ethiopia\n* `FK` - Falkland Islands (Malvinas)\n* `FO` - Faroe Islands\n* `FJ` - Fiji\n* `FI` - Finland\n* `FR` - France\n* `GF` - French Guiana\n* `PF` - French Polynesia\n* `TF` - French Southern Territories\n* `GA` - Gabon\n* `GM` - Gambia\n* `GE` - Georgia\n* `DE` - Germany\n* `GH` - Ghana\n* `GI` - Gibraltar\n* `GR` - Greece\n* `GL` - Greenland\n* `GD` - Grenada\n* `GP` - Guadeloupe\n* `GU` - Guam\n* `GT` - Guatemala\n* `GG` - Guernsey\n* `GN` - Guinea\n* `GW` - Guinea-Bissau\n* `GY` - Guyana\n* `HT` - Haiti\n* `HM` - Heard Island and McDonald Islands\n* `VA` - Holy See\n* `HN` - Honduras\n* `HK` - Hong Kong\n* `HU` - Hungary\n* `IS` - Iceland\n* `IN` - India\n* `ID` - Indonesia\n* `IR` - Iran\n* `IQ` - Iraq\n* `IE` - Ireland\n* `IM` - Isle of Man\n* `IL` - Israel\n* `IT` - Italy\n* `JM` - Jamaica\n* `JP` - Japan\n* `JE` - Jersey\n* `JO` - Jordan\n* `KZ` - Kazakhstan\n* `KE` - Kenya\n* `KI` - Kiribati\n* `KW` - Kuwait\n* `KG` - Kyrgyzstan\n* `LA` - Laos\n* `LV` - Latvia\n* `LB` - Lebanon\n* `LS` - Lesotho\n* `LR` - Liberia\n* `LY` - Libya\n* `LI` - Liechtenstein\n* `LT` - Lithuania\n* `LU` - Luxembourg\n* `MO` - Macao\n* `MG` - Madagascar\n* `MW` - Malawi\n* `MY` - Malaysia\n* `MV` - Maldives\n* `ML` - Mali\n* `MT` - Malta\n* `MH` - Marshall Islands\n* `MQ` - Martinique\n* `MR` - Mauritania\n* `MU` - Mauritius\n* `YT` - Mayotte\n* `MX` - Mexico\n* `FM` - Micronesia\n* `MD` - Moldova\n* `MC` - Monaco\n* `MN` - Mongolia\n* `ME` - Montenegro\n* `MS` - Montserrat\n* `MA` - Morocco\n* `MZ` - Mozambique\n* `MM` - Myanmar\n* `NA` - Namibia\n* `NR` - Nauru\n* `NP` - Nepal\n* `NL` - Netherlands\n* `NC` - New Caledonia\n* `NZ` - New Zealand\n* `NI` - Nicaragua\n* `NE` - Niger\n* `NG` - Nigeria\n* `NU` - Niue\n* `NF` - Norfolk Island\n* `KP` - North Korea\n* `MK` - North Macedonia\n* `MP` - Northern Mariana Islands\n* `NO` - Norway\n* `OM` - Oman\n* `PK` - Pakistan\n* `PW` - Palau\n* `PS` - Palestine, State of\n* `PA` - Panama\n* `PG` - Papua New Guinea\n* `PY` - Paraguay\n* `PE` - Peru\n* `PH` - Philippines\n* `PN` - Pitcairn\n* `PL` - Poland\n* `PT` - Portugal\n* `PR` - Puerto Rico\n* `QA` - Qatar\n* `RE` - Réunion\n* `RO` - Romania\n* `RU` - Russia\n* `RW` - Rwanda\n* `BL` - Saint Barthélemy\n* `SH` - Saint Helena, Ascension and Tristan da Cunha\n* `KN` - Saint Kitts and Nevis\n* `LC` - Saint Lucia\n* `MF` - Saint Martin (French part)\n* `PM` - Saint Pierre and Miquelon\n* `VC` - Saint Vincent and the Grenadines\n* `WS` - Samoa\n* `SM` - San Marino\n* `ST` - Sao Tome and Principe\n* `SA` - Saudi Arabia\n* `SN` - Senegal\n* `RS` - Serbia\n* `SC` - Seychelles\n* `SL` - Sierra Leone\n* `SG` - Singapore\n* `SX` - Sint Maarten (Dutch part)\n* `SK` - Slovakia\n* `SI` - Slovenia\n* `SB` - Solomon Islands\n* `SO` - Somalia\n* `ZA` - South Africa\n* `GS` - South Georgia and the South Sandwich Islands\n* `KR` - South Korea\n* `SS` - South Sudan\n* `ES` - Spain\n* `LK` - Sri Lanka\n* `SD` - Sudan\n* `SR` - Suriname\n* `SJ` - Svalbard and Jan Mayen\n* `SE` - Sweden\n* `CH` - Switzerland\n* `SY` - Syria\n* `TW` - Taiwan\n* `TJ` - Tajikistan\n* `TZ` - Tanzania\n* `TH` - Thailand\n* `TL` - Timor-Leste\n* `TG` - Togo\n* `TK` - Tokelau\n* `TO` - Tonga\n* `TT` - Trinidad and Tobago\n* `TN` - Tunisia\n* `TR` - Türkiye\n* `TM` - Turkmenistan\n* `TC` - Turks and Caicos Islands\n* `TV` - Tuvalu\n* `UG` - Uganda\n* `UA` - Ukraine\n* `AE` - United Arab Emirates\n* `GB` - United Kingdom\n* `UM` - United States Minor Outlying Islands\n* `US` - United States of America\n* `UY` - Uruguay\n* `UZ` - Uzbekistan\n* `VU` - Vanuatu\n* `VE` - Venezuela\n* `VN` - Vietnam\n* `VG` - Virgin Islands (British)\n* `VI` - Virgin Islands (U.S.)\n* `WF` - Wallis and Futuna\n* `EH` - Western Sahara\n* `YE` - Yemen\n* `ZM` - Zambia\n* `ZW` - Zimbabwe", "oneOf": [ { "$ref": "#/components/schemas/InvoiceCountryEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_state": { "nullable": true, "description": "US state\n\n* `AL` - Alabama\n* `AK` - Alaska\n* `AS` - American Samoa\n* `AZ` - Arizona\n* `AR` - Arkansas\n* `AA` - Armed Forces Americas\n* `AE` - Armed Forces Europe\n* `AP` - Armed Forces Pacific\n* `CA` - California\n* `CO` - Colorado\n* `CT` - Connecticut\n* `DE` - Delaware\n* `DC` - District of Columbia\n* `FL` - Florida\n* `GA` - Georgia\n* `GU` - Guam\n* `HI` - Hawaii\n* `ID` - Idaho\n* `IL` - Illinois\n* `IN` - Indiana\n* `IA` - Iowa\n* `KS` - Kansas\n* `KY` - Kentucky\n* `LA` - Louisiana\n* `ME` - Maine\n* `MD` - Maryland\n* `MA` - Massachusetts\n* `MI` - Michigan\n* `MN` - Minnesota\n* `MS` - Mississippi\n* `MO` - Missouri\n* `MT` - Montana\n* `NE` - Nebraska\n* `NV` - Nevada\n* `NH` - New Hampshire\n* `NJ` - New Jersey\n* `NM` - New Mexico\n* `NY` - New York\n* `NC` - North Carolina\n* `ND` - North Dakota\n* `MP` - Northern Mariana Islands\n* `OH` - Ohio\n* `OK` - Oklahoma\n* `OR` - Oregon\n* `PA` - Pennsylvania\n* `PR` - Puerto Rico\n* `RI` - Rhode Island\n* `SC` - South Carolina\n* `SD` - South Dakota\n* `TN` - Tennessee\n* `TX` - Texas\n* `UT` - Utah\n* `VT` - Vermont\n* `VI` - Virgin Islands\n* `VA` - Virginia\n* `WA` - Washington\n* `WV` - West Virginia\n* `WI` - Wisconsin\n* `WY` - Wyoming", "oneOf": [ { "$ref": "#/components/schemas/PayerStateEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "invoice_country_region": { "type": "string", "description": "ISO 3166-2 country subdivision code (e.g. CA-ON, FI-18)." }, "navbar_color": { "type": "string", "minLength": 1 }, "timezone": { "nullable": true, "description": "Select the time zone that applies to your clinic location/department.\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Coyhaique` - America/Coyhaique\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GMT` - GMT\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC", "oneOf": [ { "$ref": "#/components/schemas/TimezoneEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "financial_period_lock_date": { "type": "string", "format": "date", "nullable": true, "description": "Earliest possible date for financial events (invoices, payments, credit notes)." } } }, "PatchedDiagnosisRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "diagnosis": { "type": "string", "format": "uri" }, "category": { "allOf": [ { "$ref": "#/components/schemas/Category8beEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "type": { "allOf": [ { "$ref": "#/components/schemas/DiagnosisTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "code": { "type": "string", "minLength": 1, "maxLength": 20 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedDiagnosticImagingReferralRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "external_id": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "department": { "type": "string", "format": "uri" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "ward": { "type": "string", "format": "uri", "nullable": true }, "worklist": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status315Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "referral_remarks": { "type": "string", "nullable": true }, "answer_remarks": { "type": "string", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "internal_notes_user": { "type": "string", "format": "uri", "nullable": true }, "internal_notes_modified": { "type": "string", "format": "date-time", "nullable": true }, "referral_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "referral_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "answer_remarks_modified": { "type": "string", "format": "date-time", "nullable": true }, "answer_remarks_user": { "type": "string", "format": "uri", "nullable": true }, "diagnosis": { "type": "string", "nullable": true }, "diagnosis_user": { "type": "string", "format": "uri", "nullable": true }, "diagnosis_modified": { "type": "string", "format": "date-time", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "responsible_radiologist": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedDiagnosticImagingWorklistCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "date": { "type": "string", "format": "date", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status315Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "supervising_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "modality": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "target_areas": { "type": "array", "items": { "type": "string", "format": "uri" } }, "time": { "type": "string", "format": "time", "nullable": true } } }, "PatchedDischargeInstructionsRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "nullable": true }, "text": { "type": "string", "minLength": 1, "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "modified_session": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 63 }, "printed_at": { "type": "string", "format": "date-time", "nullable": true } } }, "PatchedDiscountSchemePartialUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 127 }, "default_discount": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 }, "minimum_sum": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "internal_notes": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true } } }, "PatchedElectronicPrescriptionRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri", "nullable": true }, "prescriber": { "type": "string", "format": "uri", "nullable": true }, "department": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status5c4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "client": { "type": "string", "format": "uri", "nullable": true }, "pharmacy_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "archived": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedExternalVaccinationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "vaccination_disease": { "type": "string", "default": [] }, "given_date": { "type": "string", "format": "date-time" }, "expiry_date": { "type": "string", "format": "date", "nullable": true } } }, "PatchedFiscalDataRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "invoice": { "type": "string", "format": "uri" }, "invoice_payment": { "type": "string", "format": "uri" }, "unallocated_payment": { "type": "string", "format": "uri" }, "fiscal_data_content": {} } }, "PatchedHealthPlanItemGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "health_plans": { "type": "array", "items": { "type": "string", "format": "uri" } }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status36bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "item_list": { "type": "string", "format": "uri" }, "usable_items_quantity": { "type": "integer", "maximum": 65535, "minimum": 0 }, "total_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "unlimited_use": { "type": "boolean" } } }, "PatchedHealthPlanItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "health_plan": { "type": "string", "format": "uri", "nullable": true }, "health_plan_item_group": { "type": "string", "format": "uri", "nullable": true }, "item": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 100000000, "minimum": -100000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat_percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "unit": { "type": "string", "minLength": 1, "maxLength": 63 }, "package_description": { "type": "string", "minLength": 1, "maxLength": 63 }, "per_consultation": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "unlimited_use": { "type": "boolean" }, "use_after_expiry": { "type": "boolean" }, "days_after_expiry": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedHealthPlanRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "display_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "department": { "type": "string", "format": "uri", "nullable": true }, "additional_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "species": { "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status36bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "monthly_fee": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "transferable": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "internal_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "nullable": true }, "weight_min": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "weight_max": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "age_min": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "age_max": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "ongoing": { "type": "boolean" }, "validity_start": { "type": "string", "format": "date", "nullable": true }, "validity_end": { "type": "string", "format": "date", "nullable": true }, "internal_notes": { "type": "string", "nullable": true }, "invoicing_item": { "type": "string", "format": "uri", "nullable": true }, "compensation_item": { "type": "string", "format": "uri", "nullable": true }, "cancellation_fee_item": { "type": "string", "format": "uri", "nullable": true }, "default_renewal": { "allOf": [ { "$ref": "#/components/schemas/DefaultRenewalEnum" } ], "minimum": 0, "maximum": 65535 }, "default_renewal_plan": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedHeartRateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "heart_rate": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedHomeDeliveryItemStatusUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/Status0ddEnum" } ], "minimum": 0, "maximum": 65535 } } }, "PatchedImportedHistoryRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "patient": { "type": "string", "format": "uri" }, "document": { "type": "string" } } }, "PatchedInsuranceClaimRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/InsuranceClaimStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "compensation": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "case_number": { "type": "string", "nullable": true, "maxLength": 255 } } }, "PatchedInvoiceExtrasRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "exported": { "type": "string", "format": "date-time", "nullable": true }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "efsta_fiscal_number": { "type": "string", "nullable": true, "maxLength": 64 } } }, "PatchedInvoicePaymentExtrasRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "exported": { "type": "string", "format": "date-time", "nullable": true }, "external_id": { "type": "string", "maxLength": 80 }, "metadata": { "type": "string" } } }, "PatchedInvoicePaymentPartialDetailRequest": { "type": "object", "description": "Updates partial data of an invoice payment.\n\nCurrently only the `status` and `status_updated` fields are supported.", "properties": { "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status183Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "status_updated": { "type": "string", "format": "date-time", "nullable": true } } }, "PatchedInvoiceRowExtraRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "internal_reporting_dimension_1": { "type": "string", "format": "uri", "nullable": true }, "internal_reporting_dimension_2": { "type": "string", "format": "uri", "nullable": true }, "internal_account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "laboratory_group": { "type": "string", "format": "uri", "nullable": true }, "creator": { "type": "string", "format": "uri", "nullable": true }, "void": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "off_label_medicine": { "type": "boolean" } } }, "PatchedInvoiceUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "invoice_date": { "type": "string", "format": "date-time" }, "invoice_due_date": { "type": "string", "format": "date", "nullable": true }, "agreed_to_pay_later": { "type": "boolean" }, "remarks": { "type": "string", "nullable": true }, "internal_remarks": { "type": "string", "nullable": true } } }, "PatchedItemListDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "central": { "type": "boolean" } } }, "PatchedItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverrideRequest" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } } }, "PatchedItemSubgroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "type_code": { "type": "integer" }, "account_number": { "type": "string", "nullable": true, "maxLength": 30 }, "account_number_link": { "type": "string", "format": "uri", "nullable": true }, "parent": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedItemTemplateItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "template": { "type": "string", "format": "uri" }, "item": { "type": "string", "format": "uri" }, "code": { "type": "string", "maxLength": 40 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "sum_total": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "archived": { "type": "boolean" }, "default_selected": { "allOf": [ { "$ref": "#/components/schemas/DefaultSelectedEnum" } ], "minimum": 0, "maximum": 65535 }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedItemTemplateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "notes": { "type": "string", "nullable": true }, "subtotal": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "vat": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "total": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "prices_up_to_date": { "type": "boolean" }, "use_fixed_price": { "type": "boolean" }, "fixed_price": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "archived": { "type": "boolean" }, "draft": { "type": "boolean" }, "price_change_org_item": { "type": "string", "format": "uri", "nullable": true }, "no_price_change_in_consultation": { "type": "boolean" }, "only_in_template": { "type": "boolean" }, "only_title_on_invoice": { "type": "boolean" }, "show_items_in_bundle_on_invoice": { "type": "boolean" } } }, "PatchedKnowledgeBaseFileRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 255 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "file": { "type": "string", "format": "binary" }, "display_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "folder": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedKnowledgeBaseFolderRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "description": { "type": "string", "minLength": 1, "maxLength": 255 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "parent": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedLaboratoryAnalysisGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "PatchedLaboratoryAnalysisPanelRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverrideRequest" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "group": { "type": "string", "format": "uri" }, "notes": { "type": "string", "nullable": true }, "analysis_method": { "type": "string", "maxLength": 255 }, "internal_instructions": { "type": "string", "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } } }, "PatchedLaboratoryAnalysisRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverrideRequest" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_id": { "type": "string", "nullable": true, "maxLength": 255 }, "measurement_unit": { "type": "string", "maxLength": 100 }, "sample_type": { "type": "string", "minLength": 1, "description": "This field will be deprecated" }, "coded_sample_type": { "type": "string", "description": "Primarily code is used, if not found ID is used" }, "panels": { "type": "array", "items": { "type": "string", "format": "uri" } }, "group": { "type": "string", "format": "uri", "nullable": true }, "analysis_method": { "type": "string", "nullable": true, "maxLength": 255 }, "internal_instructions": { "type": "string", "nullable": true }, "for_idexx": { "type": "boolean" }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } } }, "PatchedListItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "code": { "type": "string", "nullable": true, "description": "Optional identifier for the item, up to 20 characters. If codes are used, they must be unique within a list.", "maxLength": 20 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 }, "list": { "type": "string", "format": "uri" }, "archived": { "type": "boolean" }, "external_id": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 } } }, "PatchedListRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "code_system": { "type": "integer" }, "type": { "allOf": [ { "$ref": "#/components/schemas/TypeBdfEnum" } ], "minimum": -32768, "maximum": 32767 }, "parent_id": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "is_active": { "type": "boolean", "nullable": true } } }, "PatchedLocationAlertLevelRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "item": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "stock_locations": { "type": "array", "items": { "type": "string", "format": "uri" } }, "alert_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "optimum_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true } } }, "PatchedNoteRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 127 }, "note": { "type": "string", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/NoteTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "string", "format": "date-time", "nullable": true }, "custom_created": { "type": "string", "format": "date-time" }, "locked": { "type": "boolean" }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "diagnostic_imaging_referral": { "type": "string", "format": "uri", "nullable": true }, "consultation_referral": { "type": "string", "format": "uri", "nullable": true }, "patient_referral": { "type": "string", "format": "uri", "nullable": true }, "attachments": { "type": "string" }, "created_department": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedOnlineBookingTriggerTopicRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "trigger_type": { "allOf": [ { "$ref": "#/components/schemas/TriggerTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "topic_text": { "type": "string", "minLength": 1 }, "message": { "type": "string", "minLength": 1 }, "ignore_action_label": { "type": "string", "maxLength": 100 }, "order": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" } } }, "PatchedOrderItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "org_item": { "type": "string", "format": "uri" }, "order_quantity": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "order": { "type": "string", "format": "uri" }, "sequence_order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedOrganizationSettingsRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyEnum" } ], "description": "Select the appropriate currency for your organization.\n\n* `ALL` - Albania Lek (ALL)\n* `AFN` - Afghanistan Afghani (AFN)\n* `ARS` - Argentina Peso (ARS)\n* `AWG` - Aruba Guilder (AWG)\n* `AUD` - Australia Dollar (AUD)\n* `AZN` - Azerbaijan New Manat (AZN)\n* `BSD` - Bahamas Dollar (BSD)\n* `BBD` - Barbados Dollar (BBD)\n* `BYR` - Belarus Ruble (BYR)\n* `BZD` - Belize Dollar (BZD)\n* `BMD` - Bermuda Dollar (BMD)\n* `BOB` - Bolivia Boliviano (BOB)\n* `BAM` - Bosnia and Herzegovina Convertible Marka (BAM)\n* `BWP` - Botswana Pula (BWP)\n* `BGN` - Bulgaria Lev (BGN)\n* `BRL` - Brazil Real (BRL)\n* `BND` - Brunei Darussalam Dollar (BND)\n* `KHR` - Cambodia Riel (KHR)\n* `CAD` - Canadian Dollar (CAD)\n* `KYD` - Cayman Islands Dollar (KYD)\n* `CLP` - Chile Peso (CLP)\n* `CNY` - China Yuan Renminbi (CNY)\n* `COP` - Colombia Peso (COP)\n* `CRC` - Costa Rica Colon (CRC)\n* `HRK` - Croatia Kuna (HRK)\n* `CUP` - Cuba Peso (CUP)\n* `CZK` - Czech Republic Koruna (CZK)\n* `DKK` - Denmark Krone (DKK)\n* `DOP` - Dominican Republic Peso (DOP)\n* `XCD` - East Caribbean Dollar (XCD)\n* `EGP` - Egypt Pound (EGP)\n* `SVC` - El Salvador Colon (SVC)\n* `EUR` - Euro (EUR)\n* `FKP` - Falkland Islands (Malvinas) Pound (FKP)\n* `FJD` - Fiji Dollar (FJD)\n* `GHC` - Ghana Cedi (GHC)\n* `GIP` - Gibraltar Pound (GIP)\n* `GTQ` - Guatemala Quetzal (GTQ)\n* `GGP` - Guernsey Pound (GGP)\n* `GYD` - Guyana Dollar (GYD)\n* `HNL` - Honduras Lempira (HNL)\n* `HKD` - Hong Kong Dollar (HKD)\n* `HUF` - Hungary Forint (HUF)\n* `ISK` - Iceland Krona (ISK)\n* `INR` - India Rupee (INR)\n* `IDR` - Indonesia Rupiah (IDR)\n* `IRR` - Iran Rial (IRR)\n* `IMP` - Isle of Man Pound (IMP)\n* `ILS` - Israel Shekel (ILS)\n* `JMD` - Jamaica Dollar (JMD)\n* `JPY` - Japan Yen (JPY)\n* `JEP` - Jersey Pound (JEP)\n* `KZT` - Kazakhstan Tenge (KZT)\n* `KES` - Kenyan shilling (KES)\n* `KPW` - Korea (North) Won (KPW)\n* `KRW` - Korea (South) Won (KRW)\n* `KGS` - Kyrgyzstan Som (KGS)\n* `LAK` - Laos Kip (LAK)\n* `LBP` - Lebanon Pound (LBP)\n* `LRD` - Liberia Dollar (LRD)\n* `MKD` - Macedonia Denar (MKD)\n* `MYR` - Malaysia Ringgit (MYR)\n* `MUR` - Mauritius Rupee (MUR)\n* `MXN` - Mexico Peso (MXN)\n* `MNT` - Mongolia Tughrik (MNT)\n* `MZN` - Mozambique Metical (MZN)\n* `NAD` - Namibia Dollar (NAD)\n* `NPR` - Nepal Rupee (NPR)\n* `ANG` - Netherlands Antilles Guilder (ANG)\n* `NZD` - New Zealand Dollar (NZD)\n* `NIO` - Nicaragua Cordoba (NIO)\n* `NGN` - Nigeria Naira (NGN)\n* `NOK` - Norway Krone (NOK)\n* `OMR` - Oman Rial (OMR)\n* `PKR` - Pakistan Rupee (PKR)\n* `PAB` - Panama Balboa (PAB)\n* `PYG` - Paraguay Guarani (PYG)\n* `PEN` - Peru Nuevo Sol (PEN)\n* `PHP` - Philippines Peso (PHP)\n* `PLN` - Poland Zloty (PLN)\n* `QAR` - Qatar Riyal (QAR)\n* `RON` - Romania New Leu (RON)\n* `RUB` - Russia Ruble (RUB)\n* `SHP` - Saint Helena Pound (SHP)\n* `SAR` - Saudi Arabia Riyal (SAR)\n* `RSD` - Serbia Dinar (RSD)\n* `SCR` - Seychelles Rupee (SCR)\n* `SGD` - Singapore Dollar (SGD)\n* `SBD` - Solomon Islands Dollar (SBD)\n* `SOS` - Somalia Shilling (SOS)\n* `ZAR` - South Africa Rand (ZAR)\n* `LKR` - Sri Lanka Rupee (LKR)\n* `SEK` - Sweden Krona (SEK)\n* `CHF` - Switzerland Franc (CHF)\n* `SRD` - Suriname Dollar (SRD)\n* `SYP` - Syria Pound (SYP)\n* `TWD` - Taiwan New Dollar (TWD)\n* `THB` - Thailand Baht (THB)\n* `TTD` - Trinidad and Tobago Dollar (TTD)\n* `TRY` - Turkey Lira (TRY)\n* `TRL` - Turkey Lira (TRL)\n* `TVD` - Tuvalu Dollar (TVD)\n* `UAH` - Ukraine Hryvnia (UAH)\n* `GBP` - United Kingdom Pound (GBP)\n* `USD` - United States Dollar (USD)\n* `UYU` - Uruguay Peso (UYU)\n* `UZS` - Uzbekistan Som (UZS)\n* `VEF` - Venezuela Bolivar (VEF)\n* `VND` - Viet Nam Dong (VND)\n* `YER` - Yemen Rial (YER)\n* `ZWD` - Zimbabwe Dollar (ZWD)\n* `AED` - United Arab Emirates Dirham (AED)\n* `MOP` - Macanese Pataca (MOP)\n* `KWD` - Kuwaiti Dinar (KWD)\n* `ZMW` - Zambian Kwacha (ZMW)\n* `WST` - Samoan Tala (WST)" }, "timezone": { "allOf": [ { "$ref": "#/components/schemas/TimezoneEnum" } ], "description": "Select the time zone that applies to your organization.\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Coyhaique` - America/Coyhaique\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GMT` - GMT\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC" } } }, "PatchedPatientConsultationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "complaint": { "type": "string", "nullable": true, "maxLength": 255 }, "admitted_time": { "type": "string", "format": "date-time", "nullable": true }, "first_entry": { "type": "string", "format": "date-time", "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "finished": { "type": "string", "format": "date-time", "nullable": true }, "ended": { "type": "string", "format": "date-time", "nullable": true }, "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status9c9Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type2a8Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "array", "items": { "type": "string", "format": "uri" } }, "supervising_veterinarian": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedPatientExtrasRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "report_as_group": { "type": "boolean" } } }, "PatchedPatientHealthPlanPaymentUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "subscription": { "type": "string", "format": "uri" }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "create_date": { "type": "string", "format": "date" }, "payment_status": { "allOf": [ { "$ref": "#/components/schemas/PaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "initial_payment": { "type": "boolean" }, "prepayment": { "type": "boolean" }, "cancellation_invoice": { "type": "boolean" } } }, "PatchedPatientHealthPlanRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "display_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "health_plan": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "canceled": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/CanceledEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "cancel_date": { "type": "string", "format": "date", "nullable": true }, "months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "discount": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "transferable": { "type": "boolean" }, "external_subscription_id": { "type": "string", "nullable": true, "maxLength": 255 }, "renew": { "allOf": [ { "$ref": "#/components/schemas/RenewEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "payment_method": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "internal_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "internal_notes": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "invoicing_item": { "type": "string", "format": "uri", "nullable": true }, "compensation_item": { "type": "string", "format": "uri", "nullable": true }, "cancellation_fee_item": { "type": "string", "format": "uri", "nullable": true }, "next_plan": { "type": "string", "format": "uri", "nullable": true }, "invoicing_partner": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "pet_health_plan_item": { "type": "array", "items": { "type": "string", "format": "uri" } }, "pet_health_plan_itemgroup": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedPatientLocationAttributeRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } } }, "PatchedPatientLocationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "is_active": { "type": "boolean" }, "capacity": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "boarding": { "type": "boolean" } } }, "PatchedPatientPartialDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer" }, "name": { "type": "string", "minLength": 1, "maxLength": 127 }, "color": { "type": "string", "nullable": true, "maxLength": 31 }, "archived": { "type": "boolean" }, "species": { "type": "string", "minLength": 1, "description": "species code can be found on active species List" }, "breed": { "type": "string", "nullable": true, "minLength": 1, "description": "Breed code can be found on active breed List" }, "remarks": { "type": "string", "nullable": true }, "microchip": { "type": "string", "nullable": true, "maxLength": 20 }, "microchip_date": { "type": "string", "format": "date", "nullable": true }, "additional_identification": { "type": "string", "nullable": true, "maxLength": 63 }, "animal_code": { "type": "string", "nullable": true, "title": "Unique farm code", "maxLength": 31 }, "insurance": { "type": "string", "nullable": true, "title": "Insurance number", "maxLength": 255 }, "insurance_company": { "type": "string", "format": "uri", "nullable": true }, "home_department": { "type": "string", "format": "uri", "nullable": true }, "old_patient_id": { "type": "string", "nullable": true, "maxLength": 32 }, "official_name": { "type": "string", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "register_number": { "type": "string", "maxLength": 50 }, "picture": { "type": "string", "format": "binary", "nullable": true }, "deceased": { "type": "string", "format": "date", "nullable": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "gender": { "type": "string", "minLength": 1, "description": "{\"display_name\": \"Male\",\"value\": 1},{\"display_name\": \"Female\",\"value\": 2},{\"display_name\": \"Male, neutered\",\"value\": 3},{\"display_name\": \"Female, neutered\",\"value\": 4},{\"display_name\": \"Unknown\",\"value\": 0}" }, "passport_number": { "type": "string", "maxLength": 50 }, "critical_notes": { "type": "string", "nullable": true, "maxLength": 255 }, "passport_given": { "type": "string", "format": "date", "nullable": true }, "blood_group": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/BloodGroupEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "cpr_agreement": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CprAgreementEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "holding_place_number": { "type": "string", "format": "uri", "nullable": true }, "stable_name": { "type": "string", "maxLength": 63 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "private": { "type": "boolean", "title": "Private patient" }, "visible_departments": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department" }, "title": "Visible department" }, "visible_department_groups": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department group" }, "title": "Visible department group" } } }, "PatchedPatientReferralRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "referral_date": { "type": "string", "format": "date-time" }, "client": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status094Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "referral_notes": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri", "nullable": true }, "veterinarian": { "type": "string", "format": "uri", "nullable": true }, "external_system": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalSystemEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "has_dicom_files": { "type": "boolean" } } }, "PatchedPatientStatusRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "date_added": { "type": "string", "format": "date-time" }, "text": { "type": "string", "nullable": true, "maxLength": 1000 }, "weight": { "type": "string", "format": "uri" }, "temperature": { "type": "string", "format": "uri" }, "heart_rate": { "type": "string", "format": "uri" }, "respiratory_rate": { "type": "string", "format": "uri" }, "blood_glucose": { "type": "number", "format": "double", "maximum": 10000, "minimum": -10000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "body_condition_score": { "type": "string", "format": "uri" }, "central_venous_pressure": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "blood_pressure": { "type": "string", "format": "uri" }, "peripheral_oxygen_saturation": { "type": "string", "format": "uri" }, "status_1": { "type": "string", "format": "uri" }, "status_2": { "type": "string", "format": "uri" }, "status_3": { "type": "string", "format": "uri" }, "status_4": { "type": "string", "format": "uri" }, "status_5": { "type": "string", "format": "uri" }, "status_6": { "type": "string", "format": "uri" }, "status_7": { "type": "string", "format": "uri" }, "status_8": { "type": "string", "format": "uri" }, "status_9": { "type": "string", "format": "uri" }, "status_10": { "type": "string", "format": "uri" }, "status_11": { "type": "string", "format": "uri" }, "status_12": { "type": "string", "format": "uri" }, "status_1_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_2_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_3_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_4_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_5_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_6_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_7_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_8_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_9_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_10_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_11_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_12_value": { "type": "string", "nullable": true, "minLength": 1 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedPeripheralOxygenSaturationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "peripheral_oxygen_saturation": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedPersonnelGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "users": { "type": "array", "items": { "type": "string", "format": "uri" } }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedPetmedchainDocumentRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "pet": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "imported_history": { "type": "string", "format": "uri", "nullable": true }, "event": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/EventEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "pmc_id": { "type": "string", "minLength": 1, "maxLength": 255 }, "pmc_uri": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "PatchedPetmedchainPetRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "pmc_id": { "type": "string", "minLength": 1, "maxLength": 255 }, "patient": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "microchip": { "type": "string", "maxLength": 255 }, "species": { "type": "string", "minLength": 1, "maxLength": 255 }, "breed": { "type": "string", "minLength": 1, "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "verified_at": { "type": "string", "format": "date-time", "nullable": true } } }, "PatchedPhoneRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/PhoneTypeCodeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "phone_number": { "type": "string", "minLength": 1, "maxLength": 31 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "preferred_reminders": { "type": "boolean", "title": "Preferred for reminders" }, "is_secondary_owners_phone_number": { "type": "boolean", "title": "Secondary owner's phone" } } }, "PatchedProcedureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverrideRequest" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "internal_instructions": { "type": "string", "nullable": true }, "special_procedure": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/SpecialProcedureEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryFd9Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } } }, "PatchedProductOrderRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status17bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "order_date": { "type": "string", "format": "date-time", "nullable": true }, "delivery_date": { "type": "string", "format": "date-time", "nullable": true }, "added_to_stock_date": { "type": "string", "format": "date-time", "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "email_sent_to": { "type": "string", "nullable": true, "maxLength": 254 }, "email_sent_at": { "type": "string", "format": "date-time", "nullable": true }, "wholesaler_reference_number": { "type": "string", "nullable": true, "title": "Wholesaler invoice number", "maxLength": 63 }, "wholesaler_confirmation_url": { "type": "string", "format": "uri", "nullable": true, "title": "Wholesaler order confirmation URL", "maxLength": 2000 }, "wholesaler": { "type": "string", "format": "uri", "nullable": true }, "invoice_date": { "type": "string", "format": "date", "nullable": true }, "due_date": { "type": "string", "format": "date", "nullable": true }, "internal_information": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "delivery_number": { "type": "string", "nullable": true, "maxLength": 63 } } }, "PatchedReasonGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "PatchedReasonRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "group": { "type": "string", "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "online_booking_name": { "type": "string", "maxLength": 255 }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "proficient_staff": { "type": "array", "items": { "type": "string", "format": "uri" } }, "online_booking_resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "without_vet": { "type": "boolean" }, "available_online": { "type": "boolean" }, "instructions": { "type": "string" }, "available_from": { "type": "string", "format": "time", "nullable": true }, "available_to": { "type": "string", "format": "time", "nullable": true }, "prevent_reminders": { "allOf": [ { "$ref": "#/components/schemas/PreventRemindersEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "prevent_confirmations": { "allOf": [ { "$ref": "#/components/schemas/PreventConfirmationsEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "email_message": { "allOf": [ { "$ref": "#/components/schemas/EmailMessageEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "email_confirmation_text": { "type": "string", "nullable": true }, "email_reminder_text": { "type": "string", "nullable": true }, "sms_message": { "allOf": [ { "$ref": "#/components/schemas/SmsMessageEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "sms_reminder_text": { "type": "string", "nullable": true }, "sms_confirmation_text": { "type": "string", "nullable": true }, "default_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "default_clinical_note": { "type": "string", "format": "uri", "nullable": true }, "color": { "type": "string" }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "archived": { "type": "boolean" }, "telemedicine": { "type": "boolean" }, "advance_payment_item": { "type": "string", "format": "uri", "nullable": true }, "shift_types": { "type": "array", "items": { "type": "string", "format": "uri" } }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryFd9Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "default_resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "data_excluded_from_communication": { "type": "string" }, "price": { "type": "number", "format": "double", "maximum": 100000000, "minimum": 0.0, "exclusiveMaximum": true, "nullable": true }, "starting_from": { "type": "boolean" }, "prepayment_amount": { "type": "number", "format": "double", "maximum": 100000000, "minimum": 0.0, "exclusiveMaximum": true, "title": "Prepayment" } } }, "PatchedReceivablesFileRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "original_name": { "type": "string", "nullable": true, "maxLength": 255 }, "file": { "type": "string", "minLength": 1 }, "created_user": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReceivablesFileStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "processing_status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ProcessingStatusEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] } } }, "PatchedReceivablesPaymentRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "payer": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "bank_payment_file": { "type": "string", "format": "uri" }, "reference_number": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "reference_text": { "type": "string", "nullable": true, "minLength": 1 }, "invoice_number": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "nullable": true }, "currency": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "date": { "type": "string", "format": "date" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReceivablesPaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "raw": { "type": "string", "minLength": 1 }, "raw_hash": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 50 }, "payment_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/PaymentTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "bank_reference": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 40 } } }, "PatchedReferrerRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "referring_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "referring_organization": { "type": "string", "format": "uri", "nullable": true }, "patient_referral": { "type": "string", "format": "uri" } } }, "PatchedReminderRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "reminder_template": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "email_address": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "email_subject": { "type": "string", "nullable": true, "maxLength": 255 }, "email_text": { "type": "string", "minLength": 1, "nullable": true }, "sms_text": { "type": "string", "nullable": true }, "post_text": { "type": "string", "nullable": true }, "text_manually": { "type": "boolean" }, "send_before": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "send_method": { "allOf": [ { "$ref": "#/components/schemas/SendMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "expiry_date": { "type": "string", "format": "date" }, "planned_sending_date": { "type": "string", "format": "date", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReminderStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "recurring_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/RecurringTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "recurring_times": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "recurring_interval": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "external_url": { "type": "string", "format": "uri", "nullable": true, "maxLength": 200 }, "replaced_by": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedReminderTemplateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "email_text": { "type": "string", "minLength": 1, "nullable": true }, "sms_text": { "type": "string", "nullable": true }, "post_text": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "update_existing": { "type": "boolean", "writeOnly": true } } }, "PatchedResourceDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "initials": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 4 }, "is_active": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "web": { "type": "boolean" }, "sharing_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "sharing_department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedRespiratoryRateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "respiratory_rate": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedShiftTemplateBlockFragmentRequest": { "type": "object", "properties": { "start_time": { "type": "string", "format": "time" }, "end_time": { "type": "string", "format": "time" }, "shift_type": { "type": "integer" }, "web": { "type": "boolean" }, "note": { "type": "string", "nullable": true }, "ward": { "type": "integer", "nullable": true }, "team": { "type": "integer", "nullable": true } } }, "PatchedShiftTemplateBlockRequest": { "type": "object", "properties": { "block_index": { "type": "integer", "maximum": 65535, "minimum": 0 }, "start_time": { "type": "string", "format": "time" }, "end_time": { "type": "string", "format": "time" } } }, "PatchedShiftTemplateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "active": { "type": "boolean" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "code": { "type": "string", "nullable": true, "maxLength": 32 }, "two_day_template": { "type": "boolean" }, "department": { "type": "string", "format": "uri" } } }, "PatchedShiftTypeRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "code": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "department": { "type": "string", "format": "uri" }, "background_color": { "type": "string", "pattern": "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "example": "#3780b9", "minLength": 1, "description": "Background colour of the shift, as a hex value. Defaults to #3780b9. Any 24-bit colour is accepted, not only the options offered in the UI. This is the colour that is stored; the calendar may render a variation of it, so do not rely on it to reproduce how a shift looks in the calendar." }, "text_color": { "type": "string", "pattern": "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "example": "#3780b9", "minLength": 1, "description": "Colour of the shift text, as a hex value. Defaults to #000000. Any 24-bit colour is accepted, not only the options offered in the UI. This is the colour that is stored; some clinics take the text colour from the background colour instead, in which case this value is stored but not shown." }, "in_appointments": { "type": "boolean" }, "in_online_booking": { "type": "boolean" }, "in_all_day": { "type": "boolean" }, "is_custom": { "type": "boolean" }, "is_active": { "type": "boolean" }, "complaint_types": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedTagTextRequest": { "type": "object", "properties": { "department_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "default": -1 }, "text": { "type": "string", "minLength": 1, "maxLength": 50 }, "background": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "title": "Background color" }, "foreground": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "title": "Text color" }, "readonly": { "type": "boolean" }, "in_client": { "type": "boolean", "title": "Client" }, "in_invoice": { "type": "boolean", "title": "Invoice" }, "in_patient": { "type": "boolean", "title": "Patient" }, "in_item": { "type": "boolean", "title": "Item" }, "in_health_plan": { "type": "boolean", "title": "Health plan" }, "in_custom_field": { "type": "boolean", "title": "Custom field" }, "in_permission_group": { "type": "boolean", "title": "Permission groups" }, "permission_groups": { "type": "array", "items": { "type": "integer" } } } }, "PatchedTaskRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "text": { "type": "string", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/TaskStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "task_type": { "allOf": [ { "$ref": "#/components/schemas/TaskTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "favourite": { "type": "boolean" }, "due": { "type": "string", "format": "date-time", "nullable": true }, "remind": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RemindEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "user": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "created_user": { "type": "string", "format": "uri" }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "ward": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedTeamRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "code": { "type": "string", "minLength": 1, "maxLength": 31 }, "ward": { "type": "string", "format": "uri", "nullable": true }, "is_active": { "type": "boolean" } } }, "PatchedTemperatureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "temperature": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedTextTemplateDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "text": { "type": "string", "minLength": 1 }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type89eEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "specific_user": { "type": "string", "format": "uri", "nullable": true }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "boolean" }, "draft": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedTreatmentPlanFoodUpdatePartialRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } } }, "PatchedTreatmentPlanMedicineUpdatePartialRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } } }, "PatchedTreatmentPlanProcedureUpdatePartialRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true } } }, "PatchedTreatmentPlanSupplyUpdatePartialRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } } }, "PatchedUnallocatedPaymentExternalInfoRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 80 }, "metadata": { "type": "string" } } }, "PatchedUserDepartmentPermissionRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "permission_group": { "type": "string", "format": "uri" } } }, "PatchedUserDetailsRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "user": { "type": "string", "format": "uri" }, "title": { "type": "string", "nullable": true, "maxLength": 255 }, "phone": { "type": "string", "maxLength": 30 }, "id_number": { "type": "string", "nullable": true, "maxLength": 63 }, "veterinarian_id": { "type": "string", "nullable": true, "maxLength": 13 }, "active_department": { "type": "string", "format": "uri" }, "initials": { "type": "string", "minLength": 1, "maxLength": 10 }, "language": { "type": "string", "nullable": true, "maxLength": 20 }, "user_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UserTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "areas_of_expertise": { "type": "string", "minLength": 1, "maxLength": 511 }, "qualifications": { "type": "string", "minLength": 1, "maxLength": 255 }, "picture": { "type": "string", "format": "binary", "nullable": true }, "prescriber_id": { "type": "string", "nullable": true, "maxLength": 13 }, "employee_number": { "type": "string", "nullable": true, "maxLength": 63 }, "vds_number": { "type": "string", "nullable": true, "maxLength": 15 }, "all_departments_active": { "type": "boolean" }, "active_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "active_department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "home_department": { "type": "string", "format": "uri", "nullable": true }, "is_cabinet_user": { "type": "boolean" }, "verification": { "type": "string", "format": "binary", "nullable": true }, "virtual_user": { "type": "boolean" }, "is_locum": { "type": "boolean" }, "province": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. ES-B, ES-M).", "maxLength": 100 }, "no_scheduling_outside_shifts": { "type": "boolean" } } }, "PatchedUserSchedulingRequest": { "type": "object", "description": "Serializer for the UserScheduling model (more commonly known as shift).", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "employee_number": { "type": "string", "writeOnly": true, "minLength": 1 }, "department": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri", "nullable": true }, "team": { "type": "string", "format": "uri", "nullable": true }, "shift_type": { "type": "string", "format": "uri" }, "web": { "type": "boolean" }, "note": { "type": "string", "nullable": true }, "is_slot": { "type": "boolean" }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } } } }, "PatchedUserUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "email": { "type": "string", "format": "email", "minLength": 1, "description": "The email address is used to log in to Provet. This address may also be used in communication features of the system such as emailing and insurance claims. It is recommended to use a company-provided email instead of a personal email.", "maxLength": 100 }, "first_name": { "type": "string", "minLength": 1 }, "last_name": { "type": "string", "minLength": 1 }, "is_active": { "type": "boolean", "description": "User can log in and is billable." }, "last_login": { "type": "string", "format": "date-time", "nullable": true }, "user_details": { "$ref": "#/components/schemas/UserDetailsUpdateRequest" }, "groups": { "type": "string", "format": "uri" } } }, "PatchedWardRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "code": { "type": "string", "minLength": 1, "maxLength": 31 }, "is_active": { "type": "boolean" } } }, "PatchedWebhookRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "trigger": { "allOf": [ { "$ref": "#/components/schemas/TriggerEnum" } ], "minimum": 0, "maximum": 65535 }, "name": { "type": "string", "nullable": true, "maxLength": 255 }, "url": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean" }, "department": { "type": "string", "format": "uri", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ContentTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "filters": { "type": "object", "nullable": true, "description": "Optional per-webhook delivery filters ({key: true}). The event is delivered only if every enabled filter passes. Each key is only valid for specific triggers. Switching on a key this organization cannot use is rejected; a key the webhook already stores but cannot switch on is the exception, so a response can be sent back unchanged, and such a key is dropped rather than stored when the new trigger does not accept it.", "example": { "client_has_active_health_plan": true }, "properties": { "client_has_active_health_plan": { "type": "boolean", "description": "Only clients with an active health plan" }, "invoice_payment_on_health_plan_invoice": { "type": "boolean", "description": "Only payments on health plan invoices" }, "invoice_payment_without_external_id": { "type": "boolean", "description": "Only payments without an external ID (usually taken in the clinic)" }, "patient_has_active_health_plan": { "type": "boolean", "description": "Only patients with an active health plan" } }, "additionalProperties": { "type": "boolean" } } } }, "PatchedWeightRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "weight": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } } }, "PatchedWholesalerRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "wholesaler_type": { "type": "integer" }, "name": { "type": "string", "minLength": 1, "maxLength": 63 }, "name_postfix": { "type": "string", "nullable": true }, "customer_number": { "type": "string", "nullable": true, "maxLength": 63 }, "department_info": { "allOf": [ { "$ref": "#/components/schemas/WholesalerDepartmentInfoWriteRequest" } ], "nullable": true }, "vat_number": { "type": "string", "maxLength": 31 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "title": "Secondary street address", "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "order_gateway_supplier_id": { "type": "integer", "nullable": true }, "order_gateway_name": { "type": "string", "nullable": true, "maxLength": 255 }, "order_gateway_password": { "type": "string", "writeOnly": true, "nullable": true, "maxLength": 255 }, "make_department_specific": { "type": "boolean" }, "has_same_credentials_with_unique_customer_number": { "type": "boolean", "nullable": true }, "archived": { "type": "boolean", "default": false }, "available_wholesaler_id": { "type": "integer", "writeOnly": true, "nullable": true } } }, "PatchedWrittenPrescriptionExtrasCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "written_prescription": { "type": "string", "format": "uri" }, "external_system": { "type": "string", "minLength": 1 }, "external_sent_data": { "type": "string" }, "external_sent_label": { "type": "string", "nullable": true, "maxLength": 255 }, "readonly": { "type": "boolean" } } }, "Patient": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri", "readOnly": true, "description": "URL to this patient resource" }, "client": { "type": "string", "format": "uri", "description": "URL to owner/client of this patient" }, "name": { "type": "string", "description": "Patient's common name", "maxLength": 127 }, "official_name": { "type": "string", "description": "Patient's official registered name", "maxLength": 255 }, "species": { "type": "string", "description": "species code can be found on active species List" }, "breed": { "type": "string", "nullable": true, "description": "Breed code can be found on active breed List" }, "gender": { "type": "string", "description": "{\"display_name\": \"Male\",\"value\": 1},{\"display_name\": \"Female\",\"value\": 2},{\"display_name\": \"Male, neutered\",\"value\": 3},{\"display_name\": \"Female, neutered\",\"value\": 4},{\"display_name\": \"Unknown\",\"value\": 0}" }, "weight": { "type": "string", "readOnly": true, "description": "Patient's weight in kilograms" }, "old_patient_id": { "type": "string", "nullable": true, "description": "Legacy patient ID from previous system", "maxLength": 32 }, "remarks": { "type": "string", "nullable": true, "description": "General remarks and notes about patient" }, "date_of_registration": { "type": "string", "format": "date", "nullable": true, "description": "Date when patient was registered in system" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Patient's date of birth (YYYY-MM-DD)" }, "deceased": { "type": "string", "format": "date", "nullable": true, "description": "Date when patient deceased (null if alive)" }, "insurance": { "type": "string", "nullable": true, "title": "Insurance number", "description": "Insurance policy number or details", "maxLength": 255 }, "insurance_company": { "type": "string", "format": "uri", "nullable": true }, "color": { "type": "string", "nullable": true, "description": "Patient's color or coat description", "maxLength": 31 }, "critical_notes": { "type": "string", "nullable": true, "description": "Critical clinical notes displayed prominently", "maxLength": 255 }, "microchip": { "type": "string", "nullable": true, "description": "Microchip identification number", "maxLength": 20 }, "additional_identification": { "type": "string", "nullable": true, "description": "Additional identification marks or tattoos", "maxLength": 63 }, "archived": { "type": "boolean", "description": "True if patient is archived/inactive" }, "reason_of_death": { "type": "string", "nullable": true, "description": "Cause of death description", "maxLength": 255 }, "stable_name": { "type": "string", "description": "Name of stable where animal is housed", "maxLength": 63 }, "street_address": { "type": "string", "description": "Street address where animal is located (if different from owner)", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "description": "Second address line", "maxLength": 255 }, "zip_code": { "type": "string", "description": "Postal code for animal's location", "maxLength": 12 }, "city": { "type": "string", "description": "City where animal is located", "maxLength": 63 }, "not_for_food": { "type": "boolean", "title": "Not for food production", "description": "True if production animal is not for food chain" }, "passport_number": { "type": "string", "description": "Passport number (required for equines in EU)", "maxLength": 50 }, "register_number": { "type": "string", "description": "Registration number in official registry", "maxLength": 50 }, "home_department": { "type": "string", "format": "uri", "nullable": true, "description": "URL to primary department for this patient" }, "date_imported": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when patient was imported" }, "imported": { "type": "boolean", "description": "True if patient was imported from another system" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "fields_rel": { "type": "array", "items": {}, "nullable": true }, "holding_place_number": { "type": "string", "format": "uri", "nullable": true, "description": "URL to holding place identifier for production animals" }, "animal_code": { "type": "string", "nullable": true, "title": "Unique farm code", "description": "Unique animal identification code", "maxLength": 31 }, "herd_size": { "type": "integer", "nullable": true }, "private": { "type": "boolean", "title": "Private patient", "description": "True if patient is private (not visible to all departments)" }, "visible_departments": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department" }, "title": "Visible department", "description": "List of URLs to departments that can see this private patient" }, "visible_department_groups": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department group" }, "title": "Visible department group", "description": "List of URLs to department groups that can see this private patient" }, "microchip_date": { "type": "string", "format": "date", "nullable": true, "description": "Date when microchip was implanted" }, "cpr_agreement": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CprAgreementEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "blood_group": { "nullable": true, "description": "Patient's blood group (if tested)\n\n* `1` - DEA 1.1 NEG\n* `2` - DEA 1.1 POS\n* `3` - A\n* `4` - B\n* `5` - AB\n* `6` - C\n* `7` - D\n* `8` - K\n* `9` - P\n* `10` - Q\n* `11` - U\n* `12` - T", "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/BloodGroupEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "last_consultation": { "type": "string", "format": "uri", "nullable": true, "description": "URL to patient's most recent consultation" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "species_master_code": { "type": "string", "readOnly": true, "description": "Master species code for grouping" }, "species_master_icon_name": { "type": "string", "nullable": true, "readOnly": true, "description": "Icon name for species display" }, "species_code": { "type": "integer", "readOnly": true }, "breed_code": { "type": "integer", "readOnly": true }, "gender_code": { "type": "integer", "readOnly": true }, "picture": { "type": "string", "format": "uri", "nullable": true }, "picture_thumb": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "picture_medium": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "patient_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true, "description": "URL to additional patient-specific data" }, "passport_given": { "type": "string", "format": "date", "nullable": true, "description": "True if passport has been issued to owner" } }, "required": [ "breed_code", "client", "created", "gender", "gender_code", "modified", "name", "patient_extras", "picture_medium", "picture_thumb", "species", "species_code", "species_master_code", "species_master_icon_name", "url", "weight" ] }, "PatientBulk": { "type": "object", "description": "Serializer for the dedicated /patient/bulk endpoint.\nAlways uses PatientBulkListSerializer for efficient bulk_create().", "properties": { "id": { "type": "integer" }, "url": { "type": "string", "format": "uri", "readOnly": true, "description": "URL to this patient resource" }, "client": { "type": "string", "format": "uri", "description": "URL to owner/client of this patient" }, "name": { "type": "string", "description": "Patient's common name", "maxLength": 127 }, "official_name": { "type": "string", "description": "Patient's official registered name", "maxLength": 255 }, "species": { "type": "string", "description": "species code can be found on active species List" }, "breed": { "type": "string", "nullable": true, "description": "Breed code can be found on active breed List" }, "gender": { "type": "string", "description": "{\"display_name\": \"Male\",\"value\": 1},{\"display_name\": \"Female\",\"value\": 2},{\"display_name\": \"Male, neutered\",\"value\": 3},{\"display_name\": \"Female, neutered\",\"value\": 4},{\"display_name\": \"Unknown\",\"value\": 0}" }, "weight": { "type": "string", "readOnly": true, "description": "Patient's weight in kilograms" }, "old_patient_id": { "type": "string", "nullable": true, "description": "Legacy patient ID from previous system", "maxLength": 32 }, "remarks": { "type": "string", "nullable": true, "description": "General remarks and notes about patient" }, "date_of_registration": { "type": "string", "format": "date", "nullable": true, "description": "Date when patient was registered in system" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Patient's date of birth (YYYY-MM-DD)" }, "deceased": { "type": "string", "format": "date", "nullable": true, "description": "Date when patient deceased (null if alive)" }, "insurance": { "type": "string", "nullable": true, "title": "Insurance number", "description": "Insurance policy number or details", "maxLength": 255 }, "insurance_company": { "type": "string", "format": "uri", "nullable": true }, "color": { "type": "string", "nullable": true, "description": "Patient's color or coat description", "maxLength": 31 }, "critical_notes": { "type": "string", "nullable": true, "description": "Critical clinical notes displayed prominently", "maxLength": 255 }, "microchip": { "type": "string", "nullable": true, "description": "Microchip identification number", "maxLength": 20 }, "additional_identification": { "type": "string", "nullable": true, "description": "Additional identification marks or tattoos", "maxLength": 63 }, "archived": { "type": "boolean", "description": "True if patient is archived/inactive" }, "reason_of_death": { "type": "string", "nullable": true, "description": "Cause of death description", "maxLength": 255 }, "stable_name": { "type": "string", "description": "Name of stable where animal is housed", "maxLength": 63 }, "street_address": { "type": "string", "description": "Street address where animal is located (if different from owner)", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "description": "Second address line", "maxLength": 255 }, "zip_code": { "type": "string", "description": "Postal code for animal's location", "maxLength": 12 }, "city": { "type": "string", "description": "City where animal is located", "maxLength": 63 }, "not_for_food": { "type": "boolean", "title": "Not for food production", "description": "True if production animal is not for food chain" }, "passport_number": { "type": "string", "description": "Passport number (required for equines in EU)", "maxLength": 50 }, "register_number": { "type": "string", "description": "Registration number in official registry", "maxLength": 50 }, "home_department": { "type": "string", "format": "uri", "nullable": true, "description": "URL to primary department for this patient" }, "date_imported": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when patient was imported" }, "imported": { "type": "boolean", "description": "True if patient was imported from another system" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "fields_rel": { "type": "array", "items": {}, "nullable": true }, "holding_place_number": { "type": "string", "format": "uri", "nullable": true, "description": "URL to holding place identifier for production animals" }, "animal_code": { "type": "string", "nullable": true, "title": "Unique farm code", "description": "Unique animal identification code", "maxLength": 31 }, "herd_size": { "type": "integer", "nullable": true }, "private": { "type": "boolean", "title": "Private patient", "description": "True if patient is private (not visible to all departments)" }, "visible_departments": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department" }, "title": "Visible department", "description": "List of URLs to departments that can see this private patient" }, "visible_department_groups": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department group" }, "title": "Visible department group", "description": "List of URLs to department groups that can see this private patient" }, "microchip_date": { "type": "string", "format": "date", "nullable": true, "description": "Date when microchip was implanted" }, "cpr_agreement": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CprAgreementEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "blood_group": { "nullable": true, "description": "Patient's blood group (if tested)\n\n* `1` - DEA 1.1 NEG\n* `2` - DEA 1.1 POS\n* `3` - A\n* `4` - B\n* `5` - AB\n* `6` - C\n* `7` - D\n* `8` - K\n* `9` - P\n* `10` - Q\n* `11` - U\n* `12` - T", "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/BloodGroupEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "last_consultation": { "type": "string", "format": "uri", "nullable": true, "description": "URL to patient's most recent consultation" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "species_master_code": { "type": "string", "readOnly": true, "description": "Master species code for grouping" }, "species_master_icon_name": { "type": "string", "nullable": true, "readOnly": true, "description": "Icon name for species display" }, "species_code": { "type": "integer", "readOnly": true }, "breed_code": { "type": "integer", "readOnly": true }, "gender_code": { "type": "integer", "readOnly": true }, "picture": { "type": "string", "format": "uri", "nullable": true }, "picture_thumb": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "picture_medium": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "patient_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true, "description": "URL to additional patient-specific data" }, "passport_given": { "type": "string", "format": "date", "nullable": true, "description": "True if passport has been issued to owner" } }, "required": [ "breed_code", "client", "created", "gender", "gender_code", "modified", "name", "patient_extras", "picture_medium", "picture_thumb", "species", "species_code", "species_master_code", "species_master_icon_name", "url", "weight" ] }, "PatientBulkRequest": { "type": "object", "description": "Serializer for the dedicated /patient/bulk endpoint.\nAlways uses PatientBulkListSerializer for efficient bulk_create().", "properties": { "id": { "type": "integer" }, "client": { "type": "string", "format": "uri", "description": "URL to owner/client of this patient" }, "name": { "type": "string", "minLength": 1, "description": "Patient's common name", "maxLength": 127 }, "official_name": { "type": "string", "description": "Patient's official registered name", "maxLength": 255 }, "species": { "type": "string", "minLength": 1, "description": "species code can be found on active species List" }, "breed": { "type": "string", "nullable": true, "minLength": 1, "description": "Breed code can be found on active breed List" }, "gender": { "type": "string", "minLength": 1, "description": "{\"display_name\": \"Male\",\"value\": 1},{\"display_name\": \"Female\",\"value\": 2},{\"display_name\": \"Male, neutered\",\"value\": 3},{\"display_name\": \"Female, neutered\",\"value\": 4},{\"display_name\": \"Unknown\",\"value\": 0}" }, "old_patient_id": { "type": "string", "nullable": true, "description": "Legacy patient ID from previous system", "maxLength": 32 }, "remarks": { "type": "string", "nullable": true, "description": "General remarks and notes about patient" }, "date_of_registration": { "type": "string", "format": "date", "nullable": true, "description": "Date when patient was registered in system" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Patient's date of birth (YYYY-MM-DD)" }, "deceased": { "type": "string", "format": "date", "nullable": true, "description": "Date when patient deceased (null if alive)" }, "insurance": { "type": "string", "nullable": true, "title": "Insurance number", "description": "Insurance policy number or details", "maxLength": 255 }, "insurance_company": { "type": "string", "format": "uri", "nullable": true }, "color": { "type": "string", "nullable": true, "description": "Patient's color or coat description", "maxLength": 31 }, "critical_notes": { "type": "string", "nullable": true, "description": "Critical clinical notes displayed prominently", "maxLength": 255 }, "microchip": { "type": "string", "nullable": true, "description": "Microchip identification number", "maxLength": 20 }, "additional_identification": { "type": "string", "nullable": true, "description": "Additional identification marks or tattoos", "maxLength": 63 }, "archived": { "type": "boolean", "description": "True if patient is archived/inactive" }, "reason_of_death": { "type": "string", "nullable": true, "description": "Cause of death description", "maxLength": 255 }, "stable_name": { "type": "string", "description": "Name of stable where animal is housed", "maxLength": 63 }, "street_address": { "type": "string", "description": "Street address where animal is located (if different from owner)", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "description": "Second address line", "maxLength": 255 }, "zip_code": { "type": "string", "description": "Postal code for animal's location", "maxLength": 12 }, "city": { "type": "string", "description": "City where animal is located", "maxLength": 63 }, "not_for_food": { "type": "boolean", "title": "Not for food production", "description": "True if production animal is not for food chain" }, "passport_number": { "type": "string", "description": "Passport number (required for equines in EU)", "maxLength": 50 }, "register_number": { "type": "string", "description": "Registration number in official registry", "maxLength": 50 }, "home_department": { "type": "string", "format": "uri", "nullable": true, "description": "URL to primary department for this patient" }, "date_imported": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when patient was imported" }, "imported": { "type": "boolean", "description": "True if patient was imported from another system" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "fields_rel": { "type": "array", "items": {}, "nullable": true }, "holding_place_number": { "type": "string", "format": "uri", "nullable": true, "description": "URL to holding place identifier for production animals" }, "animal_code": { "type": "string", "nullable": true, "title": "Unique farm code", "description": "Unique animal identification code", "maxLength": 31 }, "herd_size": { "type": "integer", "nullable": true }, "private": { "type": "boolean", "title": "Private patient", "description": "True if patient is private (not visible to all departments)" }, "visible_departments": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department" }, "title": "Visible department", "description": "List of URLs to departments that can see this private patient" }, "visible_department_groups": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department group" }, "title": "Visible department group", "description": "List of URLs to department groups that can see this private patient" }, "microchip_date": { "type": "string", "format": "date", "nullable": true, "description": "Date when microchip was implanted" }, "cpr_agreement": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CprAgreementEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "blood_group": { "nullable": true, "description": "Patient's blood group (if tested)\n\n* `1` - DEA 1.1 NEG\n* `2` - DEA 1.1 POS\n* `3` - A\n* `4` - B\n* `5` - AB\n* `6` - C\n* `7` - D\n* `8` - K\n* `9` - P\n* `10` - Q\n* `11` - U\n* `12` - T", "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/BloodGroupEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "last_consultation": { "type": "string", "format": "uri", "nullable": true, "description": "URL to patient's most recent consultation" }, "save_patient_with_duplicates": { "type": "boolean", "writeOnly": true, "default": false }, "picture": { "type": "string", "format": "binary", "nullable": true }, "passport_given": { "type": "string", "format": "date", "nullable": true, "description": "True if passport has been issued to owner" } }, "required": [ "client", "gender", "name", "species" ] }, "PatientConsultation": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "complaint": { "type": "string", "nullable": true, "maxLength": 255 }, "admitted_time": { "type": "string", "format": "date-time", "nullable": true }, "first_entry": { "type": "string", "format": "date-time", "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "finished": { "type": "string", "format": "date-time", "nullable": true }, "ended": { "type": "string", "format": "date-time", "nullable": true }, "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status9c9Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type2a8Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "array", "items": { "type": "string", "format": "uri" } }, "supervising_veterinarian": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "format": "uri", "readOnly": true }, "reporting_dimension_2": { "type": "string", "format": "uri", "readOnly": true }, "reporting_dimension_3": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "client", "consultation_items", "created", "department", "invoice", "modified", "patients", "reporting_dimension_1", "reporting_dimension_2", "reporting_dimension_3", "supervising_veterinarian", "type", "url" ] }, "PatientConsultationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "complaint": { "type": "string", "nullable": true, "maxLength": 255 }, "admitted_time": { "type": "string", "format": "date-time", "nullable": true }, "first_entry": { "type": "string", "format": "date-time", "nullable": true }, "started": { "type": "string", "format": "date-time", "nullable": true }, "finished": { "type": "string", "format": "date-time", "nullable": true }, "ended": { "type": "string", "format": "date-time", "nullable": true }, "status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/Status9c9Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type2a8Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "array", "items": { "type": "string", "format": "uri" } }, "supervising_veterinarian": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "client", "consultation_items", "department", "invoice", "patients", "supervising_veterinarian", "type" ] }, "PatientDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "client": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 127 }, "official_name": { "type": "string", "maxLength": 255 }, "species": { "type": "string", "description": "species code can be found on active species List" }, "breed": { "type": "string", "nullable": true, "description": "Breed code can be found on actice breed List" }, "gender": { "type": "string" }, "weight": { "type": "string", "readOnly": true }, "old_patient_id": { "type": "string", "nullable": true, "maxLength": 32 }, "remarks": { "type": "string", "nullable": true }, "date_of_registration": { "type": "string", "format": "date", "nullable": true }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "deceased": { "type": "string", "format": "date", "nullable": true }, "insurance": { "type": "string", "nullable": true, "title": "Insurance number", "maxLength": 255 }, "insurance_company": { "type": "string", "format": "uri", "readOnly": true }, "color": { "type": "string", "nullable": true, "maxLength": 31 }, "critical_notes": { "type": "string", "nullable": true, "maxLength": 255 }, "microchip": { "type": "string", "nullable": true, "maxLength": 20 }, "additional_identification": { "type": "string", "nullable": true, "maxLength": 63 }, "archived": { "type": "boolean" }, "reason_of_death": { "type": "string", "nullable": true, "maxLength": 255 }, "stable_name": { "type": "string", "maxLength": 63 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "not_for_food": { "type": "boolean", "title": "Not for food production" }, "passport_number": { "type": "string", "maxLength": 50 }, "register_number": { "type": "string", "maxLength": 50 }, "home_department": { "type": "string", "format": "uri", "nullable": true }, "date_imported": { "type": "string", "format": "date-time", "nullable": true }, "imported": { "type": "boolean" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "fields_rel": { "type": "array", "items": {}, "nullable": true }, "holding_place_number": { "type": "string", "format": "uri", "nullable": true }, "animal_code": { "type": "string", "nullable": true, "title": "Unique farm code", "maxLength": 31 }, "herd_size": { "type": "integer", "maximum": 2147483647, "minimum": 1, "nullable": true }, "private": { "type": "boolean", "title": "Private patient" }, "visible_departments": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department" }, "title": "Visible department" }, "visible_department_groups": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department group" }, "title": "Visible department group" }, "microchip_date": { "type": "string", "format": "date", "nullable": true }, "cpr_agreement": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CprAgreementEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "blood_group": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/BloodGroupEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "last_consultation": { "type": "string", "format": "uri", "nullable": true }, "notes": { "type": "array", "items": { "type": "string", "format": "uri" } }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "species_master_code": { "type": "string", "readOnly": true }, "species_master_icon_name": { "type": "string", "nullable": true, "readOnly": true }, "species_code": { "type": "integer", "readOnly": true }, "breed_code": { "type": "integer", "readOnly": true }, "gender_code": { "type": "integer", "readOnly": true }, "merged_patient": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "merge_patient": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "picture": { "type": "string", "format": "uri", "nullable": true }, "picture_medium": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "picture_thumb": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "patient_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true } }, "required": [ "breed_code", "client", "created", "gender", "gender_code", "id", "insurance_company", "merge_patient", "merged_patient", "modified", "name", "notes", "patient_extras", "picture_medium", "picture_thumb", "species", "species_code", "species_master_code", "species_master_icon_name", "url", "weight" ] }, "PatientExtras": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "report_as_group": { "type": "boolean" } }, "required": [ "url" ] }, "PatientExtrasRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "report_as_group": { "type": "boolean" } } }, "PatientGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 50 }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "report_as_herd": { "type": "boolean" } }, "required": [ "consultation_items", "id", "name", "patients" ] }, "PatientHealthPlan": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "display_name": { "type": "string", "maxLength": 255 }, "health_plan": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusF35Enum" } ], "readOnly": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "canceled": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/CanceledEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "cancel_date": { "type": "string", "format": "date", "nullable": true }, "months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "monthly_fee": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "discount": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "renewed_from": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "renewed_to": { "type": "string", "format": "uri", "readOnly": true }, "transferable": { "type": "boolean" }, "billing_day": { "type": "integer", "readOnly": true }, "external_subscription_id": { "type": "string", "nullable": true, "maxLength": 255 }, "can_cancel": { "type": "boolean", "readOnly": true }, "can_cancel_reason": { "nullable": true, "readOnly": true, "oneOf": [ { "$ref": "#/components/schemas/CanCancelReasonEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "renew": { "allOf": [ { "$ref": "#/components/schemas/RenewEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "payment_method": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "payment_frequency": { "allOf": [ { "$ref": "#/components/schemas/PaymentFrequencyEnum" } ], "readOnly": true, "description": "Monthly, or upfront when the whole term is paid in one payment (clinic prepayment or an upfront signup).\n\n* `1` - Monthly\n* `2` - Upfront" }, "next_payment_date": { "type": "string", "format": "date", "readOnly": true, "nullable": true, "description": "Date of the next scheduled payment, or null when none is left. A failed payment waiting for its retry is not included." }, "channel": { "allOf": [ { "$ref": "#/components/schemas/ChannelEnum" } ], "readOnly": true }, "internal_name": { "type": "string", "maxLength": 255 }, "internal_notes": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "invoicing_item": { "type": "string", "format": "uri", "nullable": true }, "compensation_item": { "type": "string", "format": "uri", "nullable": true }, "cancellation_fee_item": { "type": "string", "format": "uri", "nullable": true }, "next_plan": { "type": "string", "format": "uri", "nullable": true }, "invoicing_partner": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "pet_health_plan_item": { "type": "array", "items": { "type": "string", "format": "uri" } }, "pet_health_plan_itemgroup": { "type": "array", "items": { "type": "string", "format": "uri" } }, "json_storage": { "type": "string", "readOnly": true } }, "required": [ "billing_day", "can_cancel", "can_cancel_reason", "channel", "client", "created", "display_name", "health_plan", "id", "internal_name", "json_storage", "modified", "monthly_fee", "months", "next_payment_date", "patient", "payment_frequency", "pet_health_plan_item", "pet_health_plan_itemgroup", "renewed_from", "renewed_to", "status", "url" ] }, "PatientHealthPlanCancelRequestRequest": { "type": "object", "description": "The self-service cancel request: the accepted quote and who is asking.", "properties": { "quote": { "type": "integer" }, "client": { "type": "integer" } }, "required": [ "client", "quote" ] }, "PatientHealthPlanCancelResult": { "type": "object", "description": "Read from the quote row, so a replay returns the same body.", "properties": { "cancelled_at": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "required": [ "cancelled_at" ] }, "PatientHealthPlanCancellationQuote": { "type": "object", "description": "What the shopper sees before confirming: the stored quote row itself,\nso the response and the comparison target cannot drift apart.", "properties": { "quote": { "type": "integer", "readOnly": true }, "days_active": { "type": "integer", "readOnly": true }, "pro_rata_amount": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "paid_amount": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "cancellation_fee": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "unpaid_current_month_fee": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "outcome_type": { "allOf": [ { "$ref": "#/components/schemas/OutcomeTypeEnum" } ], "readOnly": true }, "outcome_amount": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "explanation_code": { "allOf": [ { "$ref": "#/components/schemas/ExplanationCodeEnum" } ], "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "cancellation_fee", "days_active", "expires_at", "explanation_code", "outcome_amount", "outcome_type", "paid_amount", "pro_rata_amount", "quote", "unpaid_current_month_fee" ] }, "PatientHealthPlanCancellationQuoteRequestRequest": { "type": "object", "description": "The self-service cancellation quote request: which client is asking.\n\nSame body shape as ``cancel``'s own ``client`` field, and the same plain\nid convention ``signup`` already uses.", "properties": { "client": { "type": "integer" } }, "required": [ "client" ] }, "PatientHealthPlanCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "health_plan": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "payment_method": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "renew": { "allOf": [ { "$ref": "#/components/schemas/RenewEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "next_plan": { "type": "string", "format": "uri", "nullable": true }, "use_discount": { "type": "boolean", "default": false }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "department": { "type": "string", "format": "uri", "description": "Clinic location the subscription belongs to, which decides whose dashboard and figures it counts towards. Honoured for any clinic location the health plan is sold at: its own, one of its additional clinic locations, or any location when the plan is central. Any other location is ignored rather than refused. Left out, the subscription goes to the health plan's own clinic location, or to the acting user's where the organization is configured that way." }, "renewed_from": { "type": "string", "format": "uri", "nullable": true }, "renewed_to": { "type": "string", "format": "uri", "readOnly": true }, "json_storage": { "type": "string", "readOnly": true }, "status": { "$ref": "#/components/schemas/PatientHealthPlanCreateStatusEnum" }, "external_subscription_id": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "client", "health_plan", "id", "json_storage", "patient", "renewed_to", "url" ] }, "PatientHealthPlanCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "health_plan": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "payment_method": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "renew": { "allOf": [ { "$ref": "#/components/schemas/RenewEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "next_plan": { "type": "string", "format": "uri", "nullable": true }, "use_discount": { "type": "boolean", "default": false }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "department": { "type": "string", "format": "uri", "description": "Clinic location the subscription belongs to, which decides whose dashboard and figures it counts towards. Honoured for any clinic location the health plan is sold at: its own, one of its additional clinic locations, or any location when the plan is central. Any other location is ignored rather than refused. Left out, the subscription goes to the health plan's own clinic location, or to the acting user's where the organization is configured that way." }, "renewed_from": { "type": "string", "format": "uri", "nullable": true }, "status": { "$ref": "#/components/schemas/PatientHealthPlanCreateStatusEnum" }, "external_subscription_id": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "client", "health_plan", "patient" ] }, "PatientHealthPlanCreateStatusEnum": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "* `1` - 1\n* `2` - 2\n* `3` - 3\n* `4` - 4\n* `5` - 5\n* `6` - 6" }, "PatientHealthPlanItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "health_plan": { "type": "string", "format": "uri" }, "health_plan_item_group": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "readOnly": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "price": { "type": "string", "readOnly": true }, "price_with_vat": { "type": "string", "readOnly": true }, "quantity": { "type": "string", "readOnly": true }, "units": { "type": "string", "readOnly": true }, "dosage_units": { "type": "string", "readOnly": true }, "usage_size": { "type": "string", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "unit": { "type": "string", "readOnly": true }, "item": { "type": "string", "readOnly": true }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "compensation_item": { "type": "string", "format": "uri", "nullable": true }, "invoice_row": { "type": "string", "format": "uri", "nullable": true }, "compensation_row": { "type": "string", "format": "uri", "nullable": true }, "used": { "type": "boolean" }, "used_time": { "type": "string", "format": "date-time", "nullable": true }, "original_quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "parent_item": { "type": "string", "format": "uri", "nullable": true }, "replacement_for": { "type": "string", "format": "uri", "nullable": true }, "per_consultation": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_after_expiry": { "type": "boolean" }, "days_after_expiry": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "dosage_units", "health_plan", "id", "item", "modified", "name", "price", "price_with_vat", "quantity", "type_code", "unit", "units", "url", "usage_size" ] }, "PatientHealthPlanItemGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "health_plan": { "type": "string", "format": "uri" }, "health_plan_item_group": { "type": "string", "format": "uri" }, "used_items_quantity": { "type": "integer", "maximum": 65535, "minimum": 0 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "usable_items_quantity": { "type": "string", "readOnly": true }, "unlimited_use": { "type": "string", "readOnly": true }, "pet_health_plan_item": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "created", "health_plan", "health_plan_item_group", "id", "modified", "pet_health_plan_item", "unlimited_use", "url", "usable_items_quantity" ] }, "PatientHealthPlanItemGroupList": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "health_plan": { "type": "string", "format": "uri" }, "health_plan_item_group": { "type": "string", "format": "uri" }, "used_items_quantity": { "type": "integer", "maximum": 65535, "minimum": 0 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "health_plan", "health_plan_item_group", "id", "modified", "url" ] }, "PatientHealthPlanItemGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "health_plan": { "type": "string", "format": "uri" }, "health_plan_item_group": { "type": "string", "format": "uri" }, "used_items_quantity": { "type": "integer", "maximum": 65535, "minimum": 0 }, "pet_health_plan_item": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "health_plan", "health_plan_item_group", "pet_health_plan_item" ] }, "PatientHealthPlanItemList": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "health_plan": { "type": "string", "format": "uri" }, "health_plan_item_group": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "readOnly": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "price": { "type": "string", "readOnly": true }, "price_with_vat": { "type": "string", "readOnly": true }, "quantity": { "type": "string", "readOnly": true }, "units": { "type": "string", "readOnly": true }, "dosage_units": { "type": "string", "readOnly": true }, "usage_size": { "type": "string", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "dosage_units", "health_plan", "id", "modified", "name", "price", "price_with_vat", "quantity", "type_code", "units", "url", "usage_size" ] }, "PatientHealthPlanItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "health_plan": { "type": "string", "format": "uri" }, "health_plan_item_group": { "type": "string", "format": "uri", "nullable": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "compensation_item": { "type": "string", "format": "uri", "nullable": true }, "invoice_row": { "type": "string", "format": "uri", "nullable": true }, "compensation_row": { "type": "string", "format": "uri", "nullable": true }, "used": { "type": "boolean" }, "used_time": { "type": "string", "format": "date-time", "nullable": true }, "original_quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "parent_item": { "type": "string", "format": "uri", "nullable": true }, "replacement_for": { "type": "string", "format": "uri", "nullable": true }, "per_consultation": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_after_expiry": { "type": "boolean" }, "days_after_expiry": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "parent_linked_item": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "health_plan", "type_code" ] }, "PatientHealthPlanList": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "display_name": { "type": "string", "maxLength": 255 }, "health_plan": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusF35Enum" } ], "readOnly": true }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "canceled": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/CanceledEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "cancel_date": { "type": "string", "format": "date", "nullable": true }, "months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "monthly_fee": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": -1000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "readOnly": true }, "discount": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "renewed_from": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "renewed_to": { "type": "string", "format": "uri", "readOnly": true }, "transferable": { "type": "boolean" }, "billing_day": { "type": "integer", "readOnly": true }, "external_subscription_id": { "type": "string", "nullable": true, "maxLength": 255 }, "can_cancel": { "type": "boolean", "readOnly": true }, "can_cancel_reason": { "nullable": true, "readOnly": true, "oneOf": [ { "$ref": "#/components/schemas/CanCancelReasonEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "renew": { "allOf": [ { "$ref": "#/components/schemas/RenewEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "payment_method": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "payment_frequency": { "allOf": [ { "$ref": "#/components/schemas/PaymentFrequencyEnum" } ], "readOnly": true, "description": "Monthly, or upfront when the whole term is paid in one payment (clinic prepayment or an upfront signup).\n\n* `1` - Monthly\n* `2` - Upfront" }, "next_payment_date": { "type": "string", "format": "date", "readOnly": true, "nullable": true, "description": "Date of the next scheduled payment, or null when none is left. A failed payment waiting for its retry is not included." }, "channel": { "allOf": [ { "$ref": "#/components/schemas/ChannelEnum" } ], "readOnly": true } }, "required": [ "billing_day", "can_cancel", "can_cancel_reason", "channel", "client", "created", "display_name", "health_plan", "id", "modified", "monthly_fee", "months", "next_payment_date", "patient", "payment_frequency", "renewed_from", "renewed_to", "status", "url" ] }, "PatientHealthPlanPayment": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "subscription": { "type": "string", "format": "uri" }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "create_date": { "type": "string", "format": "date" }, "payment_status": { "allOf": [ { "$ref": "#/components/schemas/PaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "initial_payment": { "type": "boolean" }, "prepayment": { "type": "boolean" }, "cancellation_invoice": { "type": "boolean" } }, "required": [ "create_date", "subscription", "url" ] }, "PatientHealthPlanPaymentCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "subscription": { "type": "string", "format": "uri" }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "create_date": { "type": "string", "format": "date" }, "payment_status": { "allOf": [ { "$ref": "#/components/schemas/PaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "initial_payment": { "type": "boolean" }, "prepayment": { "type": "boolean" }, "cancellation_invoice": { "type": "boolean" } }, "required": [ "create_date", "subscription", "url" ] }, "PatientHealthPlanPaymentCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "subscription": { "type": "string", "format": "uri" }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "create_date": { "type": "string", "format": "date" }, "payment_status": { "allOf": [ { "$ref": "#/components/schemas/PaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "initial_payment": { "type": "boolean" }, "prepayment": { "type": "boolean" }, "cancellation_invoice": { "type": "boolean" } }, "required": [ "create_date", "subscription" ] }, "PatientHealthPlanPaymentDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "subscription": { "type": "string", "format": "uri" }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "create_date": { "type": "string", "format": "date" }, "payment_status": { "allOf": [ { "$ref": "#/components/schemas/PaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "initial_payment": { "type": "boolean" }, "prepayment": { "type": "boolean" }, "cancellation_invoice": { "type": "boolean" }, "retry_attempts": { "type": "integer", "maximum": 65535, "minimum": 0 }, "latest_attempt_date": { "type": "string", "format": "date", "nullable": true }, "retry_available": { "type": "boolean" }, "external_link_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 255 }, "external_link_id": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "create_date", "subscription", "url" ] }, "PatientHealthPlanPaymentUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "subscription": { "type": "string", "format": "uri" }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "create_date": { "type": "string", "format": "date" }, "payment_status": { "allOf": [ { "$ref": "#/components/schemas/PaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "initial_payment": { "type": "boolean" }, "prepayment": { "type": "boolean" }, "cancellation_invoice": { "type": "boolean" } }, "required": [ "create_date", "subscription", "url" ] }, "PatientHealthPlanPaymentUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "subscription": { "type": "string", "format": "uri" }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "create_date": { "type": "string", "format": "date" }, "payment_status": { "allOf": [ { "$ref": "#/components/schemas/PaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "initial_payment": { "type": "boolean" }, "prepayment": { "type": "boolean" }, "cancellation_invoice": { "type": "boolean" } }, "required": [ "create_date", "subscription" ] }, "PatientHealthPlanRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "display_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "health_plan": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "canceled": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/CanceledEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "cancel_date": { "type": "string", "format": "date", "nullable": true }, "months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "discount": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "transferable": { "type": "boolean" }, "external_subscription_id": { "type": "string", "nullable": true, "maxLength": 255 }, "renew": { "allOf": [ { "$ref": "#/components/schemas/RenewEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "payment_method": { "allOf": [ { "$ref": "#/components/schemas/PaymentMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "internal_name": { "type": "string", "minLength": 1, "maxLength": 255 }, "internal_notes": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "invoicing_item": { "type": "string", "format": "uri", "nullable": true }, "compensation_item": { "type": "string", "format": "uri", "nullable": true }, "cancellation_fee_item": { "type": "string", "format": "uri", "nullable": true }, "next_plan": { "type": "string", "format": "uri", "nullable": true }, "invoicing_partner": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "pet_health_plan_item": { "type": "array", "items": { "type": "string", "format": "uri" } }, "pet_health_plan_itemgroup": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "client", "display_name", "health_plan", "internal_name", "months", "patient", "pet_health_plan_item", "pet_health_plan_itemgroup" ] }, "PatientHealthPlanSignupRequest": { "type": "object", "description": "The self-service signup request.\n\nPlain ids rather than the legacy surface's hyperlinked fields: integrators\nhold ids from their own identity mapping, and the card component hands\nback ``card.id`` as a plain id. Everything else the subscription needs is\nserver-set — payment method, status, billing day and the cancellation\npolicy are not the platform's to choose.", "properties": { "health_plan": { "type": "integer" }, "client": { "type": "integer" }, "patient": { "type": "integer" }, "payment_card": { "type": "integer" }, "department": { "type": "integer" }, "external_subscription_id": { "type": "string", "nullable": true, "description": "The caller's own reference for this subscription, stored as given. Left out, the subscription carries none.", "maxLength": 255 }, "payment_frequency": { "allOf": [ { "$ref": "#/components/schemas/PaymentFrequencyEnum" } ], "description": "Monthly charges the saved card every month. Upfront charges the whole term from the saved card in one payment, at signup and at each renewal.\n\n* `1` - Monthly\n* `2` - Upfront" } }, "required": [ "client", "department", "health_plan", "patient", "payment_card", "payment_frequency" ] }, "PatientHealthPlanSignupResult": { "type": "object", "description": "What a signup answers with: enough for the platform to render a\nconfirmation screen without a follow-up read.", "properties": { "id": { "type": "integer" }, "status": { "$ref": "#/components/schemas/StatusF35Enum" }, "monthly_fee": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "initial_payment": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "first_charge_date": { "type": "string", "format": "date" }, "first_charge_amount": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "description": "Amount of the first charge: the initial payment or the first month, or the whole term when paid upfront." } }, "required": [ "first_charge_amount", "first_charge_date", "id", "initial_payment", "monthly_fee", "status" ] }, "PatientIdQualifierEnum": { "enum": [ "IND", "GRP", "BES" ], "type": "string", "description": "* `IND` - Individ(er)\n* `GRP` - Grupp\n* `BES` - Besättning" }, "PatientLocation": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "location_parent_name": { "type": "string", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "is_active": { "type": "boolean" }, "capacity": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "boarding": { "type": "boolean" } }, "required": [ "id", "location_parent_name", "name" ] }, "PatientLocationAttribute": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 100 } }, "required": [ "id", "name", "url" ] }, "PatientLocationAttributeRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "name" ] }, "PatientLocationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "is_active": { "type": "boolean" }, "capacity": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "boarding": { "type": "boolean" } }, "required": [ "name" ] }, "PatientPartialDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer" }, "name": { "type": "string", "maxLength": 127 }, "color": { "type": "string", "nullable": true, "maxLength": 31 }, "archived": { "type": "boolean" }, "species": { "type": "string", "description": "species code can be found on active species List" }, "breed": { "type": "string", "nullable": true, "description": "Breed code can be found on active breed List" }, "remarks": { "type": "string", "nullable": true }, "microchip": { "type": "string", "nullable": true, "maxLength": 20 }, "microchip_date": { "type": "string", "format": "date", "nullable": true }, "additional_identification": { "type": "string", "nullable": true, "maxLength": 63 }, "animal_code": { "type": "string", "nullable": true, "title": "Unique farm code", "maxLength": 31 }, "insurance": { "type": "string", "nullable": true, "title": "Insurance number", "maxLength": 255 }, "insurance_company": { "type": "string", "format": "uri", "nullable": true }, "home_department": { "type": "string", "format": "uri", "nullable": true }, "old_patient_id": { "type": "string", "nullable": true, "maxLength": 32 }, "official_name": { "type": "string", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "register_number": { "type": "string", "maxLength": 50 }, "picture": { "type": "string", "format": "uri", "nullable": true }, "picture_medium": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "picture_thumb": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "deceased": { "type": "string", "format": "date", "nullable": true }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "gender": { "type": "string", "description": "{\"display_name\": \"Male\",\"value\": 1},{\"display_name\": \"Female\",\"value\": 2},{\"display_name\": \"Male, neutered\",\"value\": 3},{\"display_name\": \"Female, neutered\",\"value\": 4},{\"display_name\": \"Unknown\",\"value\": 0}" }, "gender_code": { "type": "integer", "readOnly": true }, "species_code": { "type": "integer", "readOnly": true }, "breed_code": { "type": "integer", "readOnly": true }, "passport_number": { "type": "string", "maxLength": 50 }, "weight": { "type": "string", "readOnly": true }, "critical_notes": { "type": "string", "nullable": true, "maxLength": 255 }, "passport_given": { "type": "string", "format": "date", "nullable": true }, "blood_group": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/BloodGroupEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "cpr_agreement": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CprAgreementEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "holding_place_number": { "type": "string", "format": "uri", "nullable": true }, "stable_name": { "type": "string", "maxLength": 63 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "private": { "type": "boolean", "title": "Private patient" }, "visible_departments": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department" }, "title": "Visible department" }, "visible_department_groups": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department group" }, "title": "Visible department group" } }, "required": [ "breed_code", "gender_code", "picture_medium", "picture_thumb", "species_code", "url", "weight" ] }, "PatientReferral": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "referral_date": { "type": "string", "format": "date-time" }, "client": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status094Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "archived": { "type": "boolean", "readOnly": true }, "referral_notes": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri", "nullable": true }, "veterinarian": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "attachment_note": { "type": "string", "format": "uri", "readOnly": true }, "referrers": { "type": "string", "readOnly": true }, "external_system": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalSystemEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "has_dicom_files": { "type": "boolean" }, "consultations": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true } }, "required": [ "archived", "attachment_note", "client", "consultations", "created", "created_user", "department", "id", "modified", "modified_user", "patient", "referral_date", "referrers", "url" ] }, "PatientReferralClient": { "type": "object", "properties": { "first_name": { "type": "string", "maxLength": 100 }, "last_name": { "type": "string", "maxLength": 100 }, "phone_number": { "type": "string", "maxLength": 30 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "maxLength": 255 }, "city": { "type": "string", "maxLength": 63 }, "zip_code": { "type": "string", "maxLength": 12 }, "id_number": { "type": "string", "maxLength": 63 } }, "required": [ "email", "first_name", "last_name", "phone_number" ] }, "PatientReferralClientRequest": { "type": "object", "properties": { "first_name": { "type": "string", "maxLength": 100 }, "last_name": { "type": "string", "maxLength": 100 }, "phone_number": { "type": "string", "minLength": 1, "maxLength": 30 }, "email": { "type": "string", "format": "email", "nullable": true, "minLength": 1, "maxLength": 254 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "maxLength": 255 }, "city": { "type": "string", "maxLength": 63 }, "zip_code": { "type": "string", "maxLength": 12 }, "id_number": { "type": "string", "maxLength": 63 } }, "required": [ "email", "first_name", "last_name", "phone_number" ] }, "PatientReferralCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "referral_date": { "type": "string", "format": "date-time" }, "client": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status094Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "archived": { "type": "boolean" }, "referral_notes": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri", "nullable": true }, "veterinarian": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "attachment_note": { "type": "string", "format": "uri", "readOnly": true }, "referrers": { "type": "string", "readOnly": true }, "external_system": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalSystemEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "has_dicom_files": { "type": "boolean" }, "consultations": { "type": "array", "items": { "type": "string", "format": "uri" }, "readOnly": true }, "client_details": { "$ref": "#/components/schemas/PatientReferralClient" }, "patient_details": { "$ref": "#/components/schemas/PatientReferralPatient" } }, "required": [ "attachment_note", "consultations", "created", "department", "id", "modified", "referral_date", "referrers", "url" ] }, "PatientReferralCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "referral_date": { "type": "string", "format": "date-time" }, "client": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status094Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "archived": { "type": "boolean" }, "referral_notes": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri", "nullable": true }, "veterinarian": { "type": "string", "format": "uri", "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "external_system": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalSystemEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "has_dicom_files": { "type": "boolean" }, "client_details": { "$ref": "#/components/schemas/PatientReferralClientRequest" }, "patient_details": { "$ref": "#/components/schemas/PatientReferralPatientRequest" }, "referrer_details": { "type": "array", "items": { "$ref": "#/components/schemas/ReferrerListRequest" } } }, "required": [ "department", "referral_date" ] }, "PatientReferralPatient": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "species": { "type": "string" }, "gender": { "allOf": [ { "$ref": "#/components/schemas/Gender2e2Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "breed": { "type": "string" }, "critical_notes": { "type": "string", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "insurance_company": { "type": "string", "format": "uri", "nullable": true }, "insurance": { "type": "string", "maxLength": 255 }, "microchip": { "type": "string", "maxLength": 15 }, "passport_number": { "type": "string", "maxLength": 50 }, "animal_code": { "type": "string", "nullable": true, "maxLength": 31 } }, "required": [ "gender", "name", "species" ] }, "PatientReferralPatientRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "species": { "type": "string" }, "gender": { "allOf": [ { "$ref": "#/components/schemas/Gender2e2Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "breed": { "type": "string" }, "critical_notes": { "type": "string", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "insurance_company": { "type": "string", "format": "uri", "nullable": true }, "insurance": { "type": "string", "maxLength": 255 }, "microchip": { "type": "string", "maxLength": 15 }, "passport_number": { "type": "string", "maxLength": 50 }, "animal_code": { "type": "string", "nullable": true, "maxLength": 31 } }, "required": [ "gender", "name", "species" ] }, "PatientReferralRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "referral_date": { "type": "string", "format": "date-time" }, "client": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status094Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "referral_notes": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri", "nullable": true }, "veterinarian": { "type": "string", "format": "uri", "nullable": true }, "external_system": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ExternalSystemEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "has_dicom_files": { "type": "boolean" } }, "required": [ "client", "department", "patient", "referral_date" ] }, "PatientRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer" }, "client": { "type": "string", "format": "uri", "description": "URL to owner/client of this patient" }, "name": { "type": "string", "minLength": 1, "description": "Patient's common name", "maxLength": 127 }, "official_name": { "type": "string", "description": "Patient's official registered name", "maxLength": 255 }, "species": { "type": "string", "minLength": 1, "description": "species code can be found on active species List" }, "breed": { "type": "string", "nullable": true, "minLength": 1, "description": "Breed code can be found on active breed List" }, "gender": { "type": "string", "minLength": 1, "description": "{\"display_name\": \"Male\",\"value\": 1},{\"display_name\": \"Female\",\"value\": 2},{\"display_name\": \"Male, neutered\",\"value\": 3},{\"display_name\": \"Female, neutered\",\"value\": 4},{\"display_name\": \"Unknown\",\"value\": 0}" }, "old_patient_id": { "type": "string", "nullable": true, "description": "Legacy patient ID from previous system", "maxLength": 32 }, "remarks": { "type": "string", "nullable": true, "description": "General remarks and notes about patient" }, "date_of_registration": { "type": "string", "format": "date", "nullable": true, "description": "Date when patient was registered in system" }, "date_of_birth": { "type": "string", "format": "date", "nullable": true, "description": "Patient's date of birth (YYYY-MM-DD)" }, "deceased": { "type": "string", "format": "date", "nullable": true, "description": "Date when patient deceased (null if alive)" }, "insurance": { "type": "string", "nullable": true, "title": "Insurance number", "description": "Insurance policy number or details", "maxLength": 255 }, "insurance_company": { "type": "string", "format": "uri", "nullable": true }, "color": { "type": "string", "nullable": true, "description": "Patient's color or coat description", "maxLength": 31 }, "critical_notes": { "type": "string", "nullable": true, "description": "Critical clinical notes displayed prominently", "maxLength": 255 }, "microchip": { "type": "string", "nullable": true, "description": "Microchip identification number", "maxLength": 20 }, "additional_identification": { "type": "string", "nullable": true, "description": "Additional identification marks or tattoos", "maxLength": 63 }, "archived": { "type": "boolean", "description": "True if patient is archived/inactive" }, "reason_of_death": { "type": "string", "nullable": true, "description": "Cause of death description", "maxLength": 255 }, "stable_name": { "type": "string", "description": "Name of stable where animal is housed", "maxLength": 63 }, "street_address": { "type": "string", "description": "Street address where animal is located (if different from owner)", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "description": "Second address line", "maxLength": 255 }, "zip_code": { "type": "string", "description": "Postal code for animal's location", "maxLength": 12 }, "city": { "type": "string", "description": "City where animal is located", "maxLength": 63 }, "not_for_food": { "type": "boolean", "title": "Not for food production", "description": "True if production animal is not for food chain" }, "passport_number": { "type": "string", "description": "Passport number (required for equines in EU)", "maxLength": 50 }, "register_number": { "type": "string", "description": "Registration number in official registry", "maxLength": 50 }, "home_department": { "type": "string", "format": "uri", "nullable": true, "description": "URL to primary department for this patient" }, "date_imported": { "type": "string", "format": "date-time", "nullable": true, "description": "Timestamp when patient was imported" }, "imported": { "type": "boolean", "description": "True if patient was imported from another system" }, "tags_rel": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "fields_rel": { "type": "array", "items": {}, "nullable": true }, "holding_place_number": { "type": "string", "format": "uri", "nullable": true, "description": "URL to holding place identifier for production animals" }, "animal_code": { "type": "string", "nullable": true, "title": "Unique farm code", "description": "Unique animal identification code", "maxLength": 31 }, "herd_size": { "type": "integer", "nullable": true }, "private": { "type": "boolean", "title": "Private patient", "description": "True if patient is private (not visible to all departments)" }, "visible_departments": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department" }, "title": "Visible department", "description": "List of URLs to departments that can see this private patient" }, "visible_department_groups": { "type": "array", "items": { "type": "string", "format": "uri", "title": "Visible department group" }, "title": "Visible department group", "description": "List of URLs to department groups that can see this private patient" }, "microchip_date": { "type": "string", "format": "date", "nullable": true, "description": "Date when microchip was implanted" }, "cpr_agreement": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CprAgreementEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "blood_group": { "nullable": true, "description": "Patient's blood group (if tested)\n\n* `1` - DEA 1.1 NEG\n* `2` - DEA 1.1 POS\n* `3` - A\n* `4` - B\n* `5` - AB\n* `6` - C\n* `7` - D\n* `8` - K\n* `9` - P\n* `10` - Q\n* `11` - U\n* `12` - T", "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/BloodGroupEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "last_consultation": { "type": "string", "format": "uri", "nullable": true, "description": "URL to patient's most recent consultation" }, "save_patient_with_duplicates": { "type": "boolean", "writeOnly": true, "default": false }, "picture": { "type": "string", "format": "binary", "nullable": true }, "passport_given": { "type": "string", "format": "date", "nullable": true, "description": "True if passport has been issued to owner" } }, "required": [ "client", "gender", "name", "species" ] }, "PatientSnapshotItem": { "type": "object", "description": "One patient in patients_snapshot (display only). All fields optional.\nRecommended keys: name, species, breed, date_of_birth.", "properties": { "name": { "type": "string", "nullable": true, "description": "Patient name." }, "species": { "type": "string", "nullable": true, "description": "Species." }, "breed": { "type": "string", "nullable": true, "description": "Breed." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Date of birth (any string format)." } } }, "PatientSnapshotItemRequest": { "type": "object", "description": "One patient in patients_snapshot (display only). All fields optional.\nRecommended keys: name, species, breed, date_of_birth.", "properties": { "name": { "type": "string", "nullable": true, "description": "Patient name." }, "species": { "type": "string", "nullable": true, "description": "Species." }, "breed": { "type": "string", "nullable": true, "description": "Breed." }, "date_of_birth": { "type": "string", "nullable": true, "description": "Date of birth (any string format)." } } }, "PatientSpeciesEnum": { "enum": [ "35", "36", "37", "38", "39", "40", "42", "43", "44", "45", "46", "47", "62", "63", "64", "66", "67", "72", "73", "74", "75", "76", "11", "12", "13", "14", "15", "16", "17", "18", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "41", "60", "61", "68", "80", "31", "32", "33", "34", "49", "48", "50", "51", "52", "53", "54", "55", "56", "57", "58", "59", "65", "70", "71", "79", "90" ], "type": "string", "description": "* `35` - Slaktkyckling (livdjursprod)\n* `36` - Slaktkyckling (köttprod)\n* `37` - Varphöns (livdjursprod)\n* `38` - Varphöns (äggprod)\n* `39` - Kalkon (livdjursprod)\n* `40` - Kalkon (köttprod)\n* `42` - Gris (köttprod)\n* `43` - Gris (livsdjursprod)\n* `44` - Nöt (köttprod med moderdjur)\n* `45` - Nöt (köttprod utan moderdjur)\n* `46` - Nöt (mjölkprod)\n* `47` - Nöt (Övrig)\n* `62` - Anka\n* `63` - Gås\n* `64` - Blötdjur (musslor, ostron, mm)\n* `66` - Räv\n* `67` - Akvariefisk/dammfisk, prydnad\n* `72` - Fisk, odlad, atlantlax\n* `73` - Fisk, odlad, guldsparid\n* `74` - Fisk, odlad, havsabborre\n* `75` - Fisk, odlad, karp\n* `76` - Fisk, odlad, regnbåge\n* `11` - Nöt\n* `12` - Gris, animalieprod.\n* `13` - Häst\n* `14` - Får\n* `15` - Get\n* `16` - Ren\n* `17` - Åsna\n* `18` - Kameldjur\n* `20` - Höns, inkl slaktkyckling\n* `21` - Strutsdjur\n* `22` - Kalkon\n* `23` - Anka/gås\n* `24` - Övriga fjäderfä\n* `25` - Fisk (odlad)\n* `26` - Mussla (odlad)\n* `27` - Pälsdjur\n* `28` - Insekter\n* `29` - Övrigt animalieproduktion\n* `41` - Kanin (animalieproduktion)\n* `60` - Mink\n* `61` - Chinchilla (pälsdjur)\n* `68` - Alpacka\n* `80` - Övriga djur\n* `31` - Hjort\n* `32` - Vildsvin\n* `33` - Fisk (vildlevande)\n* `34` - Älg\n* `49` - Övrigt vilt\n* `48` - Övrigt hägnat vilt\n* `50` - Gris (sällskapsdjur)\n* `51` - Hund\n* `52` - Katt\n* `53` - Kanin (sällskapsdjur)\n* `54` - Marsvin\n* `55` - Hamster\n* `56` - Iller\n* `57` - Mus\n* `58` - Råtta\n* `59` - Chinchilla (sällskapsdjur)\n* `65` - Reptiler\n* `70` - Fågel\n* `71` - Degu\n* `79` - Övrigt sällskapsdjur\n* `90` - Zoodjur (ej animalprod.)" }, "PatientStatus": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "date_added": { "type": "string", "format": "date-time" }, "text": { "type": "string", "nullable": true, "maxLength": 1000 }, "weight": { "type": "string", "format": "uri" }, "temperature": { "type": "string", "format": "uri" }, "heart_rate": { "type": "string", "format": "uri" }, "respiratory_rate": { "type": "string", "format": "uri" }, "blood_glucose": { "type": "number", "format": "double", "maximum": 10000, "minimum": -10000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "body_condition_score": { "type": "string", "format": "uri" }, "central_venous_pressure": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "blood_pressure": { "type": "string", "format": "uri" }, "peripheral_oxygen_saturation": { "type": "string", "format": "uri" }, "status_1": { "type": "string", "format": "uri" }, "status_2": { "type": "string", "format": "uri" }, "status_3": { "type": "string", "format": "uri" }, "status_4": { "type": "string", "format": "uri" }, "status_5": { "type": "string", "format": "uri" }, "status_6": { "type": "string", "format": "uri" }, "status_7": { "type": "string", "format": "uri" }, "status_8": { "type": "string", "format": "uri" }, "status_9": { "type": "string", "format": "uri" }, "status_10": { "type": "string", "format": "uri" }, "status_11": { "type": "string", "format": "uri" }, "status_12": { "type": "string", "format": "uri" }, "status_1_value": { "type": "string", "nullable": true }, "status_2_value": { "type": "string", "nullable": true }, "status_3_value": { "type": "string", "nullable": true }, "status_4_value": { "type": "string", "nullable": true }, "status_5_value": { "type": "string", "nullable": true }, "status_6_value": { "type": "string", "nullable": true }, "status_7_value": { "type": "string", "nullable": true }, "status_8_value": { "type": "string", "nullable": true }, "status_9_value": { "type": "string", "nullable": true }, "status_10_value": { "type": "string", "nullable": true }, "status_11_value": { "type": "string", "nullable": true }, "status_12_value": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "blood_pressure", "body_condition_score", "consultation", "created", "date_added", "heart_rate", "modified", "patient", "peripheral_oxygen_saturation", "respiratory_rate", "temperature", "weight" ] }, "PatientStatusRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "date_added": { "type": "string", "format": "date-time" }, "text": { "type": "string", "nullable": true, "maxLength": 1000 }, "weight": { "type": "string", "format": "uri" }, "temperature": { "type": "string", "format": "uri" }, "heart_rate": { "type": "string", "format": "uri" }, "respiratory_rate": { "type": "string", "format": "uri" }, "blood_glucose": { "type": "number", "format": "double", "maximum": 10000, "minimum": -10000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "body_condition_score": { "type": "string", "format": "uri" }, "central_venous_pressure": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "blood_pressure": { "type": "string", "format": "uri" }, "peripheral_oxygen_saturation": { "type": "string", "format": "uri" }, "status_1": { "type": "string", "format": "uri" }, "status_2": { "type": "string", "format": "uri" }, "status_3": { "type": "string", "format": "uri" }, "status_4": { "type": "string", "format": "uri" }, "status_5": { "type": "string", "format": "uri" }, "status_6": { "type": "string", "format": "uri" }, "status_7": { "type": "string", "format": "uri" }, "status_8": { "type": "string", "format": "uri" }, "status_9": { "type": "string", "format": "uri" }, "status_10": { "type": "string", "format": "uri" }, "status_11": { "type": "string", "format": "uri" }, "status_12": { "type": "string", "format": "uri" }, "status_1_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_2_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_3_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_4_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_5_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_6_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_7_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_8_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_9_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_10_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_11_value": { "type": "string", "nullable": true, "minLength": 1 }, "status_12_value": { "type": "string", "nullable": true, "minLength": 1 }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "blood_pressure", "body_condition_score", "consultation", "date_added", "heart_rate", "patient", "peripheral_oxygen_saturation", "respiratory_rate", "temperature", "weight" ] }, "PatientTypeEnum": { "enum": [ 0, 1 ], "type": "integer", "description": "* `0` - First opinion case\n* `1` - Referred patient" }, "PayerSnapshot": { "type": "object", "description": "Payer/client snapshot for display. All fields optional.\nRecommended keys: name, email, phone, id_number, organization_name,\nvat_number, register_number, street_address, zip_code, city, country, tags.", "properties": { "name": { "type": "string", "nullable": true, "description": "Payer name." }, "email": { "type": "string", "nullable": true, "description": "Email." }, "phone": { "type": "string", "nullable": true, "description": "Phone." }, "id_number": { "type": "string", "nullable": true, "description": "National ID etc." }, "organization_name": { "type": "string", "nullable": true, "description": "Company name." }, "vat_number": { "type": "string", "nullable": true, "description": "VAT number." }, "register_number": { "type": "string", "nullable": true, "description": "Business ID." }, "street_address": { "type": "string", "nullable": true, "description": "Address line 1." }, "street_address_2": { "type": "string", "nullable": true, "description": "Address line 2." }, "street_address_3": { "type": "string", "nullable": true, "description": "Address line 3." }, "zip_code": { "type": "string", "nullable": true, "description": "Postal code." }, "city": { "type": "string", "nullable": true, "description": "City." }, "state": { "type": "string", "nullable": true, "description": "State/region." }, "country_region": { "type": "string", "nullable": true, "description": "Region." }, "country": { "type": "string", "nullable": true, "description": "Country." }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "Tags (e.g. ['Corporate', 'E-invoice'])." } } }, "PayerSnapshotRequest": { "type": "object", "description": "Payer/client snapshot for display. All fields optional.\nRecommended keys: name, email, phone, id_number, organization_name,\nvat_number, register_number, street_address, zip_code, city, country, tags.", "properties": { "name": { "type": "string", "nullable": true, "description": "Payer name." }, "email": { "type": "string", "nullable": true, "description": "Email." }, "phone": { "type": "string", "nullable": true, "description": "Phone." }, "id_number": { "type": "string", "nullable": true, "description": "National ID etc." }, "organization_name": { "type": "string", "nullable": true, "description": "Company name." }, "vat_number": { "type": "string", "nullable": true, "description": "VAT number." }, "register_number": { "type": "string", "nullable": true, "description": "Business ID." }, "street_address": { "type": "string", "nullable": true, "description": "Address line 1." }, "street_address_2": { "type": "string", "nullable": true, "description": "Address line 2." }, "street_address_3": { "type": "string", "nullable": true, "description": "Address line 3." }, "zip_code": { "type": "string", "nullable": true, "description": "Postal code." }, "city": { "type": "string", "nullable": true, "description": "City." }, "state": { "type": "string", "nullable": true, "description": "State/region." }, "country_region": { "type": "string", "nullable": true, "description": "Region." }, "country": { "type": "string", "nullable": true, "description": "Country." }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1 }, "nullable": true, "description": "Tags (e.g. ['Corporate', 'E-invoice'])." } } }, "PayerStateEnum": { "enum": [ "AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "MP", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY" ], "type": "string", "description": "* `AL` - Alabama\n* `AK` - Alaska\n* `AS` - American Samoa\n* `AZ` - Arizona\n* `AR` - Arkansas\n* `AA` - Armed Forces Americas\n* `AE` - Armed Forces Europe\n* `AP` - Armed Forces Pacific\n* `CA` - California\n* `CO` - Colorado\n* `CT` - Connecticut\n* `DE` - Delaware\n* `DC` - District of Columbia\n* `FL` - Florida\n* `GA` - Georgia\n* `GU` - Guam\n* `HI` - Hawaii\n* `ID` - Idaho\n* `IL` - Illinois\n* `IN` - Indiana\n* `IA` - Iowa\n* `KS` - Kansas\n* `KY` - Kentucky\n* `LA` - Louisiana\n* `ME` - Maine\n* `MD` - Maryland\n* `MA` - Massachusetts\n* `MI` - Michigan\n* `MN` - Minnesota\n* `MS` - Mississippi\n* `MO` - Missouri\n* `MT` - Montana\n* `NE` - Nebraska\n* `NV` - Nevada\n* `NH` - New Hampshire\n* `NJ` - New Jersey\n* `NM` - New Mexico\n* `NY` - New York\n* `NC` - North Carolina\n* `ND` - North Dakota\n* `MP` - Northern Mariana Islands\n* `OH` - Ohio\n* `OK` - Oklahoma\n* `OR` - Oregon\n* `PA` - Pennsylvania\n* `PR` - Puerto Rico\n* `RI` - Rhode Island\n* `SC` - South Carolina\n* `SD` - South Dakota\n* `TN` - Tennessee\n* `TX` - Texas\n* `UT` - Utah\n* `VT` - Vermont\n* `VI` - Virgin Islands\n* `VA` - Virginia\n* `WA` - Washington\n* `WV` - West Virginia\n* `WI` - Wisconsin\n* `WY` - Wyoming" }, "PaymentCard": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "tokenization_id": { "type": "string", "nullable": true, "maxLength": 100 }, "info": { "type": "string", "maxLength": 255 }, "expiration_date": { "type": "string", "format": "date", "nullable": true }, "default": { "type": "boolean" }, "source": { "allOf": [ { "$ref": "#/components/schemas/SourceEnum" } ], "minimum": 0, "maximum": 65535 } }, "required": [ "client", "info" ] }, "PaymentCardRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "tokenization_id": { "type": "string", "nullable": true, "maxLength": 100 }, "info": { "type": "string", "minLength": 1, "maxLength": 255 }, "expiration_date": { "type": "string", "format": "date", "nullable": true }, "default": { "type": "boolean" }, "source": { "allOf": [ { "$ref": "#/components/schemas/SourceEnum" } ], "minimum": 0, "maximum": 65535 } }, "required": [ "client", "info" ] }, "PaymentFrequencyEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Monthly\n* `2` - Upfront" }, "PaymentMethod": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "code": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "name": { "type": "string", "readOnly": true }, "is_custom": { "type": "boolean" }, "is_card": { "type": "boolean" }, "is_active": { "type": "boolean" }, "in_prepayments": { "type": "boolean" }, "in_invoices": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "account_number": { "type": "string" } }, "required": [ "code", "created", "modified", "name", "url" ] }, "PaymentMethodEnum": { "enum": [ 0, 1, 2, 5, 3, 4, 6 ], "type": "integer", "description": "* `0` - Not specified\n* `1` - Monthly billing through Provet\n* `2` - Contract period as advance payment\n* `5` - External payment\n* `3` - Monthly recurring payments through Provet Pay\n* `4` - Monthly recurring payments through Gravity Payment\n* `6` - Monthly recurring payments through Direct Debit" }, "PaymentStatusEnum": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `1` - Upcoming\n* `2` - Invoice created\n* `3` - Invoice paid\n* `4` - Cancelled\n* `5` - Charged back" }, "PaymentType843Enum": { "enum": [ 0, 1, 2, 7, 3, 4, 5, 6, 8, 9, 10, 11, 12, 15, 5000, 5001, 5002, 5005, 5006, 5003, 5004 ], "type": "integer", "description": "* `0` - Card\n* `1` - Cash\n* `2` - Bank payment\n* `7` - Mobile payment\n* `3` - Rounding\n* `4` - Cheque\n* `5` - Voucher\n* `6` - Consolidated invoice\n* `8` - Prepayment\n* `9` - Gift card\n* `10` - Financing company\n* `11` - Other\n* `12` - Credit invoice\n* `15` - Insurance claim\n* `5000` - Klarna Instore\n* `5001` - Norion Bank AB / Walley invoicing\n* `5002` - SAV financing\n* `5005` - Svea financing\n* `5006` - Frakmenta financing\n* `5003` - Provet Pay\n* `5004` - Internal transfer" }, "PaymentTypeEnum": { "enum": [ 2, 15 ], "type": "integer", "description": "* `2` - Bank payment\n* `15` - Insurance claim" }, "PaymentsActionEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Refund the selected payments\n* `2` - Move the selected to prepayments" }, "PerformedByRuleEnum": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required" }, "PeripheralOxygenSaturation": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "peripheral_oxygen_saturation": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "id", "timestamp" ] }, "PeripheralOxygenSaturationRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "peripheral_oxygen_saturation": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "timestamp" ] }, "PersonnelGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "users": { "type": "array", "items": { "type": "string", "format": "uri" } }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "id", "name" ] }, "PersonnelGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "users": { "type": "array", "items": { "type": "string", "format": "uri" } }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "name" ] }, "PetmedchainDocument": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "pet": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "imported_history": { "type": "string", "format": "uri", "nullable": true }, "event": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/EventEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "pmc_id": { "type": "string", "maxLength": 255 }, "pmc_uri": { "type": "string", "maxLength": 255 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "id", "modified", "pmc_id", "pmc_uri", "url" ] }, "PetmedchainDocumentRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "pet": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "imported_history": { "type": "string", "format": "uri", "nullable": true }, "event": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/EventEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "pmc_id": { "type": "string", "minLength": 1, "maxLength": 255 }, "pmc_uri": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "pmc_id", "pmc_uri" ] }, "PetmedchainPet": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "pmc_id": { "type": "string", "maxLength": 255 }, "patient": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "maxLength": 255 }, "microchip": { "type": "string", "maxLength": 255 }, "species": { "type": "string", "maxLength": 255 }, "breed": { "type": "string", "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "verified_at": { "type": "string", "format": "date-time", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "breed", "created", "id", "modified", "name", "pmc_id", "species", "url" ] }, "PetmedchainPetRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "pmc_id": { "type": "string", "minLength": 1, "maxLength": 255 }, "patient": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "microchip": { "type": "string", "maxLength": 255 }, "species": { "type": "string", "minLength": 1, "maxLength": 255 }, "breed": { "type": "string", "minLength": 1, "maxLength": 255 }, "date_of_birth": { "type": "string", "format": "date", "nullable": true }, "verified_at": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "breed", "name", "pmc_id", "species" ] }, "Phone": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "client": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/PhoneTypeCodeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "phone_number": { "type": "string", "maxLength": 31 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "preferred_reminders": { "type": "boolean", "title": "Preferred for reminders" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "is_secondary_owners_phone_number": { "type": "boolean", "title": "Secondary owner's phone" } }, "required": [ "client", "created", "id", "modified", "phone_number", "type_code", "url" ] }, "PhoneRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/PhoneTypeCodeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "phone_number": { "type": "string", "minLength": 1, "maxLength": 31 }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "preferred_reminders": { "type": "boolean", "title": "Preferred for reminders" }, "is_secondary_owners_phone_number": { "type": "boolean", "title": "Secondary owner's phone" } }, "required": [ "client", "phone_number", "type_code" ] }, "PhoneTypeCodeEnum": { "enum": [ 1, 0 ], "type": "integer", "description": "* `1` - Mobile phone\n* `0` - Landline phone" }, "PortalClientLink": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "client": { "type": "string", "format": "uri" }, "client_id": { "type": "integer", "readOnly": true }, "portal_account_id": { "type": "string", "format": "uuid" }, "status": { "allOf": [ { "$ref": "#/components/schemas/PortalClientLinkStatusEnum" } ], "readOnly": true }, "source": { "allOf": [ { "$ref": "#/components/schemas/PortalClientLinkSourceEnum" } ], "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "client", "client_id", "created", "id", "modified", "portal_account_id", "source", "status", "url" ] }, "PortalClientLinkRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "client": { "type": "string", "format": "uri" }, "portal_account_id": { "type": "string", "format": "uuid" } }, "required": [ "client", "portal_account_id" ] }, "PortalClientLinkSourceEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Portal login\n* `2` - Booking match\n* `3` - Manual" }, "PortalClientLinkStatusEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Linked\n* `2` - Blocked\n* `3` - Unlinked" }, "PosTransaction": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "task_id": { "type": "string", "maxLength": 64 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "aborted": { "type": "string", "format": "date-time", "nullable": true }, "cashier_desk": { "type": "integer", "readOnly": true }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "terminal_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "department": { "type": "string", "format": "uri", "nullable": true }, "transaction_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/TransactionTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "payment_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/PaymentType843Enum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "payment_method": { "type": "string", "format": "uri", "nullable": true }, "payment": { "type": "string", "format": "uri", "nullable": true }, "unallocated_payment": { "type": "string", "format": "uri", "nullable": true }, "refunded_transaction": { "type": "string", "format": "uri", "nullable": true }, "creator": { "type": "string", "format": "uri" }, "payment_link": { "type": "object", "additionalProperties": {}, "nullable": true, "readOnly": true } }, "required": [ "amount", "cashier_desk", "created", "creator", "id", "modified", "payment_link", "task_id", "terminal_id" ] }, "PosTransactionCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "task_id": { "type": "string", "minLength": 1, "maxLength": 64 }, "aborted": { "type": "string", "format": "date-time", "nullable": true }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "terminal_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "department": { "type": "string", "format": "uri", "nullable": true }, "transaction_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/TransactionTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "payment_type": { "allOf": [ { "$ref": "#/components/schemas/PaymentType843Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "payment_method": { "type": "string", "format": "uri", "nullable": true }, "payment": { "type": "string", "format": "uri", "nullable": true }, "unallocated_payment": { "type": "string", "format": "uri", "nullable": true }, "refunded_transaction": { "type": "string", "format": "uri", "nullable": true }, "creator": { "type": "string", "format": "uri" }, "prepayment_data": { "$ref": "#/components/schemas/PosTransactionPrepaymentDataRequest" }, "payment_link_data": { "$ref": "#/components/schemas/PosTransactionPaymentLinkDataRequest" } }, "required": [ "amount", "creator", "payment_type", "terminal_id" ] }, "PosTransactionPaymentLinkDataRequest": { "type": "object", "properties": { "duration": { "type": "integer", "minimum": 1 }, "email": { "type": "string", "format": "email", "nullable": true, "minLength": 1 }, "phone": { "type": "string", "nullable": true, "minLength": 1 }, "delivery_method": { "allOf": [ { "$ref": "#/components/schemas/DeliveryMethodEnum" } ], "default": 1 }, "description": { "type": "string", "minLength": 1, "description": "Shown on the payment page. At most 280 characters as the payment provider counts them: emoji and other supplementary characters count as two.", "maxLength": 280 }, "return_url": { "type": "string", "format": "uri", "minLength": 1 }, "tokenize": { "$ref": "#/components/schemas/TokenizeEnum" }, "recurring_model": { "$ref": "#/components/schemas/RecurringModelEnum" } }, "required": [ "duration" ] }, "PosTransactionPrepaymentDataRequest": { "type": "object", "properties": { "client_id": { "type": "integer" }, "department_id": { "type": "integer" }, "description": { "type": "string", "minLength": 1 } }, "required": [ "client_id", "department_id" ] }, "PosTransactionResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "external_transaction_id": { "type": "string", "nullable": true, "maxLength": 64 }, "internal_error": { "type": "boolean" }, "result_raw": { "type": "string" }, "result_text": { "type": "string" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "transaction": { "type": "integer" }, "external_customer_receipt": { "type": "string", "nullable": true }, "external_merchant_receipt": { "type": "string", "nullable": true }, "unique_external_id": { "type": "string", "nullable": true, "maxLength": 64 } }, "required": [ "created", "result_raw", "result_text", "transaction" ] }, "PosTransactionResultRequest": { "type": "object", "properties": { "success": { "type": "boolean" }, "external_transaction_id": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 64 }, "internal_error": { "type": "boolean" }, "result_raw": { "type": "string", "minLength": 1 }, "result_text": { "type": "string", "minLength": 1 }, "transaction": { "type": "integer" }, "external_customer_receipt": { "type": "string", "nullable": true, "minLength": 1 }, "external_merchant_receipt": { "type": "string", "nullable": true, "minLength": 1 }, "unique_external_id": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 64 } }, "required": [ "result_raw", "result_text", "transaction" ] }, "PreliminaryBooking": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department": { "type": "string", "format": "uri" }, "type": { "allOf": [ { "$ref": "#/components/schemas/TypeB05Enum" } ], "readOnly": true }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "reason": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "client_notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "notes": { "type": "string", "nullable": true }, "request_hash": { "type": "string", "readOnly": true }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } }, "required": [ "department", "end", "expires_at", "id", "request_hash", "start", "type", "url" ] }, "PreliminaryBookingRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "user": { "type": "string", "format": "uri", "nullable": true }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department": { "type": "string", "format": "uri" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "reason": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "client_notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "notes": { "type": "string", "nullable": true, "minLength": 1 } }, "required": [ "department", "end", "start" ] }, "PrescriptionBilling": { "type": "object", "description": "Serializes PrescriptionInvoiceRow data in the format excepted by the\ne-prescription billing microservice.", "properties": { "SourceId": { "type": "string", "readOnly": true }, "OurRef": { "type": "string", "readOnly": true }, "CustomRef1": { "type": "string", "readOnly": true }, "ClaimerId": { "type": "string", "readOnly": true }, "RecipientPNR": { "type": "string", "readOnly": true }, "RecipientAddress": { "type": "string", "readOnly": true }, "AccountingDate": { "type": "string", "readOnly": true }, "Specifications": { "type": "string", "readOnly": true } }, "required": [ "AccountingDate", "ClaimerId", "CustomRef1", "OurRef", "RecipientAddress", "RecipientPNR", "SourceId", "Specifications" ] }, "PrescriptionBillingError": { "type": "object", "description": "Serializer for errors posted by the e-prescription billing microservice.", "properties": { "SourceId": { "type": "string", "readOnly": true }, "ErrorMessage": { "type": "string", "readOnly": true } }, "required": [ "ErrorMessage", "SourceId" ] }, "PrescriptionRepeat": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "refill_item": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "prescriber": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "invoice_rows": { "type": "array", "items": { "type": "string", "format": "uri" } }, "prescription_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "repeats": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "uses": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "renew_times": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "cancelled": { "type": "boolean" }, "refill_expiry_date": { "type": "string", "format": "date", "nullable": true } }, "required": [ "client", "id", "invoice_rows", "patient", "prescriber", "prescription_items", "refill_item", "repeats", "url", "uses" ] }, "PrescriptionRepeatRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "refill_item": { "type": "string", "format": "uri" }, "client": { "type": "string", "format": "uri" }, "prescriber": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "consultation_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "invoice_rows": { "type": "array", "items": { "type": "string", "format": "uri" } }, "prescription_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "repeats": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "uses": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "renew_times": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "cancelled": { "type": "boolean" }, "refill_expiry_date": { "type": "string", "format": "date", "nullable": true } }, "required": [ "client", "invoice_rows", "patient", "prescriber", "prescription_items", "refill_item", "repeats", "uses" ] }, "PreventConfirmationsEnum": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "* `0` - Do not prevent sending confirmations\n* `1` - Prevent sending all confirmations\n* `2` - Prevent sending email confirmations\n* `3` - Prevent sending SMS confirmations" }, "PreventRemindersEnum": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "* `0` - Do not prevent sending reminders\n* `1` - Prevent sending all reminders\n* `2` - Prevent sending email reminders\n* `3` - Prevent sending SMS reminders" }, "Procedure": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "parent": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverride" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "internal_instructions": { "type": "string", "nullable": true }, "special_procedure": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/SpecialProcedureEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryFd9Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "created", "id", "item_list", "modified", "name", "parent", "polymorphic_ctype", "type_code", "url", "vat_group" ] }, "ProcedureList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "hide_on_consultation_search": { "type": "boolean" }, "hide_on_countersale_search": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri", "readOnly": true }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true }, "archived": { "type": "boolean" }, "item_list": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "main_item": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 }, "primary_wholesaler_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID of the primary wholesaler for this stock item. Null on non-stock items (procedures) or when unset." }, "primary_wholesaler_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Wholesaler-specific product code for the primary wholesaler. Null on non-stock items or when unset." } }, "required": [ "created", "id", "item_list", "main_item", "modified", "name", "polymorphic_ctype", "primary_wholesaler_code", "primary_wholesaler_id", "type_code", "url", "vat_group" ] }, "ProcedureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "main_item": { "type": "string", "format": "uri", "nullable": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "minimum_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesaler_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "producer_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "special_discount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "margin_percent": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri" }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "item_list": { "type": "string", "format": "uri" }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "description": "ITEM_TYPE_PROCEDURE = 1, ITEM_TYPE_MEDICINE = 2, ITEM_TYPE_SUPPLY = 3, ITEM_TYPE_FOOD = 4, ITEM_TYPE_LABORATORY_ANALYSIS = 5, ITEM_TYPE_LABORATORY_ANALYSIS_PANEL = 6\n\n* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel", "minimum": -32768, "maximum": 32767 }, "parent_amount": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "instructions": { "type": "string", "nullable": true }, "archived": { "type": "boolean" }, "archived_datetime": { "type": "string", "format": "date-time", "nullable": true }, "exclude_discount": { "type": "boolean" }, "hide_zero_print": { "type": "boolean" }, "linked_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "hide_on_countersale_search": { "type": "boolean" }, "performed_by_rule": { "allOf": [ { "$ref": "#/components/schemas/PerformedByRuleEnum" } ], "description": "PERFORMED_BY_INHERIT = 0, PERFORMED_BY_REQUIRED = 1, PERFORMED_BY_NOT_REQUIRED = 2\n\n* `0` - Initial (based on item group)\n* `1` - Required\n* `2` - Not required", "minimum": -32768, "maximum": 32767 }, "royalty_fee": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation_search": { "type": "boolean" }, "disable_price_calculation": { "type": "boolean", "title": "Disable automatic selling price calculation" }, "species": { "type": "array", "items": { "type": "string", "nullable": true }, "nullable": true }, "no_commissions": { "type": "boolean" }, "no_department_rates": { "type": "boolean" }, "related_diagnoses_groups": { "type": "array", "items": { "type": "string", "format": "uri", "nullable": true } }, "conditional_price_overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalPriceOverrideRequest" } }, "tags": { "type": "array", "items": { "type": "string", "format": "uri" } }, "force_integer_quantity": { "type": "boolean" }, "sales_offset": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "internal_instructions": { "type": "string", "nullable": true }, "special_procedure": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/SpecialProcedureEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryFd9Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_dosage_units": { "type": "number", "format": "double", "maximum": 1000000, "minimum": -1000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 } }, "required": [ "item_list", "name", "type_code", "vat_group" ] }, "ProcessingStatusEnum": { "enum": [ 0, 1, 3 ], "type": "integer", "description": "* `0` - Unprocessed\n* `1` - Uncompleted\n* `3` - Completed" }, "ProductOrder": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status17bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "order_date": { "type": "string", "format": "date-time", "nullable": true }, "delivery_date": { "type": "string", "format": "date-time", "nullable": true }, "added_to_stock_date": { "type": "string", "format": "date-time", "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "email_sent_to": { "type": "string", "nullable": true, "maxLength": 254 }, "email_sent_at": { "type": "string", "format": "date-time", "nullable": true }, "wholesaler_reference_number": { "type": "string", "nullable": true, "title": "Wholesaler invoice number", "maxLength": 63 }, "wholesaler_confirmation_url": { "type": "string", "format": "uri", "nullable": true, "title": "Wholesaler order confirmation URL", "maxLength": 2000 }, "wholesaler": { "type": "string", "format": "uri", "nullable": true }, "invoice_date": { "type": "string", "format": "date", "nullable": true }, "due_date": { "type": "string", "format": "date", "nullable": true }, "internal_information": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "delivery_number": { "type": "string", "nullable": true, "maxLength": 63 }, "department_name": { "type": "string", "readOnly": true }, "department_email": { "type": "string", "readOnly": true }, "order_items_count": { "type": "integer", "readOnly": true } }, "required": [ "created", "department", "department_email", "department_name", "id", "modified", "order_items_count", "url" ] }, "ProductOrderDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status17bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "order_date": { "type": "string", "format": "date-time", "nullable": true }, "delivery_date": { "type": "string", "format": "date-time", "nullable": true }, "added_to_stock_date": { "type": "string", "format": "date-time", "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "email_sent_to": { "type": "string", "nullable": true, "maxLength": 254 }, "email_sent_at": { "type": "string", "format": "date-time", "nullable": true }, "wholesaler_reference_number": { "type": "string", "nullable": true, "title": "Wholesaler invoice number", "maxLength": 63 }, "wholesaler_confirmation_url": { "type": "string", "format": "uri", "nullable": true, "title": "Wholesaler order confirmation URL", "maxLength": 2000 }, "wholesaler": { "type": "string", "format": "uri", "nullable": true }, "invoice_date": { "type": "string", "format": "date", "nullable": true }, "due_date": { "type": "string", "format": "date", "nullable": true }, "internal_information": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "delivery_number": { "type": "string", "nullable": true, "maxLength": 63 }, "order_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department_name": { "type": "string", "readOnly": true }, "department_email": { "type": "string", "readOnly": true } }, "required": [ "created", "department", "department_email", "department_name", "id", "modified", "order_items", "url" ] }, "ProductOrderRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status17bEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "order_date": { "type": "string", "format": "date-time", "nullable": true }, "delivery_date": { "type": "string", "format": "date-time", "nullable": true }, "added_to_stock_date": { "type": "string", "format": "date-time", "nullable": true }, "sum_vat": { "type": "number", "format": "double", "maximum": 10000000000, "minimum": -10000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "email_sent_to": { "type": "string", "nullable": true, "maxLength": 254 }, "email_sent_at": { "type": "string", "format": "date-time", "nullable": true }, "wholesaler_reference_number": { "type": "string", "nullable": true, "title": "Wholesaler invoice number", "maxLength": 63 }, "wholesaler_confirmation_url": { "type": "string", "format": "uri", "nullable": true, "title": "Wholesaler order confirmation URL", "maxLength": 2000 }, "wholesaler": { "type": "string", "format": "uri", "nullable": true }, "invoice_date": { "type": "string", "format": "date", "nullable": true }, "due_date": { "type": "string", "format": "date", "nullable": true }, "internal_information": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "delivery_number": { "type": "string", "nullable": true, "maxLength": 63 } }, "required": [ "department" ] }, "QrCodeCreate": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255 }, "subtitle": { "type": "string", "maxLength": 255 }, "qr_code_data": { "type": "string", "maxLength": 511 } }, "required": [ "qr_code_data" ] }, "QrCodeCreateRequest": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 255 }, "subtitle": { "type": "string", "maxLength": 255 }, "qr_code_data": { "type": "string", "minLength": 1, "maxLength": 511 } }, "required": [ "qr_code_data" ] }, "Reason": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "group": { "type": "string", "format": "uri" }, "name": { "type": "string", "maxLength": 255 }, "online_booking_name": { "type": "string", "maxLength": 255 }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "proficient_staff": { "type": "array", "items": { "type": "string", "format": "uri" } }, "online_booking_resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "without_vet": { "type": "boolean" }, "available_online": { "type": "boolean" }, "instructions": { "type": "string" }, "available_from": { "type": "string", "format": "time", "nullable": true }, "available_to": { "type": "string", "format": "time", "nullable": true }, "prevent_reminders": { "allOf": [ { "$ref": "#/components/schemas/PreventRemindersEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "prevent_confirmations": { "allOf": [ { "$ref": "#/components/schemas/PreventConfirmationsEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "email_message": { "allOf": [ { "$ref": "#/components/schemas/EmailMessageEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "email_confirmation_text": { "type": "string", "nullable": true }, "email_reminder_text": { "type": "string", "nullable": true }, "sms_message": { "allOf": [ { "$ref": "#/components/schemas/SmsMessageEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "sms_reminder_text": { "type": "string", "nullable": true }, "sms_confirmation_text": { "type": "string", "nullable": true }, "default_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "default_clinical_note": { "type": "string", "format": "uri", "nullable": true }, "color": { "type": "string" }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "archived": { "type": "boolean" }, "telemedicine": { "type": "boolean" }, "species": { "type": "string", "readOnly": true }, "advance_payment_item": { "type": "string", "format": "uri", "nullable": true }, "shift_types": { "type": "array", "items": { "type": "string", "format": "uri" } }, "no_messages": { "type": "string", "readOnly": true }, "no_confirmations": { "type": "string", "readOnly": true }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryFd9Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "default_resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "data_excluded_from_communication": { "type": "string" }, "price": { "type": "number", "format": "double", "maximum": 100000000, "minimum": 0.0, "exclusiveMaximum": true, "nullable": true }, "starting_from": { "type": "boolean" }, "prepayment_amount": { "type": "number", "format": "double", "maximum": 100000000, "minimum": 0.0, "exclusiveMaximum": true, "title": "Prepayment" } }, "required": [ "duration", "group", "id", "name", "no_confirmations", "no_messages", "species", "url" ] }, "ReasonGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "maxLength": 255 } }, "required": [ "id", "name", "url" ] }, "ReasonGroupRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri", "nullable": true }, "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ] }, "ReasonRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "group": { "type": "string", "format": "uri" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "online_booking_name": { "type": "string", "maxLength": 255 }, "duration": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "proficient_staff": { "type": "array", "items": { "type": "string", "format": "uri" } }, "online_booking_resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "without_vet": { "type": "boolean" }, "available_online": { "type": "boolean" }, "instructions": { "type": "string" }, "available_from": { "type": "string", "format": "time", "nullable": true }, "available_to": { "type": "string", "format": "time", "nullable": true }, "prevent_reminders": { "allOf": [ { "$ref": "#/components/schemas/PreventRemindersEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "prevent_confirmations": { "allOf": [ { "$ref": "#/components/schemas/PreventConfirmationsEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "email_message": { "allOf": [ { "$ref": "#/components/schemas/EmailMessageEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "email_confirmation_text": { "type": "string", "nullable": true }, "email_reminder_text": { "type": "string", "nullable": true }, "sms_message": { "allOf": [ { "$ref": "#/components/schemas/SmsMessageEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "sms_reminder_text": { "type": "string", "nullable": true }, "sms_confirmation_text": { "type": "string", "nullable": true }, "default_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "default_clinical_note": { "type": "string", "format": "uri", "nullable": true }, "color": { "type": "string" }, "reporting_dimension_1": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_2": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "reporting_dimension_3": { "type": "string", "description": "Primarily code is used, if not found id is used" }, "archived": { "type": "boolean" }, "telemedicine": { "type": "boolean" }, "advance_payment_item": { "type": "string", "format": "uri", "nullable": true }, "shift_types": { "type": "array", "items": { "type": "string", "format": "uri" } }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryFd9Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "default_resources": { "type": "array", "items": { "type": "string", "format": "uri" } }, "data_excluded_from_communication": { "type": "string" }, "price": { "type": "number", "format": "double", "maximum": 100000000, "minimum": 0.0, "exclusiveMaximum": true, "nullable": true }, "starting_from": { "type": "boolean" }, "prepayment_amount": { "type": "number", "format": "double", "maximum": 100000000, "minimum": 0.0, "exclusiveMaximum": true, "title": "Prepayment" } }, "required": [ "duration", "group", "name" ] }, "ReceivablesFile": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "original_name": { "type": "string", "nullable": true, "maxLength": 255 }, "file": { "type": "string" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReceivablesFileStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "processing_status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ProcessingStatusEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] } }, "required": [ "created", "created_user", "file", "id", "original_name", "processing_status", "status" ] }, "ReceivablesFileRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "original_name": { "type": "string", "nullable": true, "maxLength": 255 }, "file": { "type": "string", "minLength": 1 }, "created_user": { "type": "string", "format": "uri" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReceivablesFileStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "processing_status": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/ProcessingStatusEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] } }, "required": [ "created_user", "file", "original_name", "processing_status", "status" ] }, "ReceivablesFileStatusEnum": { "enum": [ 0, 1, 3 ], "type": "integer", "description": "* `0` - Draft\n* `1` - Targeting\n* `3` - Executed" }, "ReceivablesPayment": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "payer": { "type": "string", "nullable": true, "maxLength": 255 }, "bank_payment_file": { "type": "string", "format": "uri" }, "reference_number": { "type": "string", "nullable": true, "maxLength": 255 }, "reference_text": { "type": "string", "nullable": true }, "invoice_number": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "nullable": true }, "currency": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "date": { "type": "string", "format": "date" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReceivablesPaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "invoice_id": { "type": "integer", "nullable": true, "readOnly": true }, "raw": { "type": "string" }, "raw_hash": { "type": "string", "nullable": true, "maxLength": 50 }, "payment_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/PaymentTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "bank_reference": { "type": "string", "nullable": true, "maxLength": 40 } }, "required": [ "bank_payment_file", "date", "id", "invoice_id", "payer", "raw" ] }, "ReceivablesPaymentRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "payer": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "bank_payment_file": { "type": "string", "format": "uri" }, "reference_number": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 255 }, "reference_text": { "type": "string", "nullable": true, "minLength": 1 }, "invoice_number": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64", "nullable": true }, "currency": { "oneOf": [ { "$ref": "#/components/schemas/CurrencyEnum" }, { "$ref": "#/components/schemas/BlankEnum" } ] }, "sum": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "date": { "type": "string", "format": "date" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReceivablesPaymentStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "invoice": { "type": "string", "format": "uri", "nullable": true }, "raw": { "type": "string", "minLength": 1 }, "raw_hash": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 50 }, "payment_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/PaymentTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "bank_reference": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 40 } }, "required": [ "bank_payment_file", "date", "payer", "raw" ] }, "ReceivablesPaymentStatusEnum": { "enum": [ 0, 3, 6, 9 ], "type": "integer", "description": "* `0` - Ignored\n* `3` - Untargeted\n* `6` - Targeted\n* `9` - Payment created" }, "ReceiverSnapshot": { "type": "object", "description": "Recipient/clinic snapshot for display. All fields optional.\nRecommended keys: name, street_address, zip_code, city, vat_number, iban, bic.", "properties": { "name": { "type": "string", "nullable": true, "description": "Clinic name." }, "street_address": { "type": "string", "nullable": true, "description": "Address line 1." }, "street_address_2": { "type": "string", "nullable": true, "description": "Address line 2." }, "zip_code": { "type": "string", "nullable": true, "description": "Postal code." }, "city": { "type": "string", "nullable": true, "description": "City." }, "state": { "type": "string", "nullable": true, "description": "State/region." }, "country_region": { "type": "string", "nullable": true, "description": "Region." }, "vat_number": { "type": "string", "nullable": true, "description": "VAT number." }, "iban": { "type": "string", "nullable": true, "description": "IBAN." }, "bic": { "type": "string", "nullable": true, "description": "BIC/SWIFT." } } }, "ReceiverSnapshotRequest": { "type": "object", "description": "Recipient/clinic snapshot for display. All fields optional.\nRecommended keys: name, street_address, zip_code, city, vat_number, iban, bic.", "properties": { "name": { "type": "string", "nullable": true, "description": "Clinic name." }, "street_address": { "type": "string", "nullable": true, "description": "Address line 1." }, "street_address_2": { "type": "string", "nullable": true, "description": "Address line 2." }, "zip_code": { "type": "string", "nullable": true, "description": "Postal code." }, "city": { "type": "string", "nullable": true, "description": "City." }, "state": { "type": "string", "nullable": true, "description": "State/region." }, "country_region": { "type": "string", "nullable": true, "description": "Region." }, "vat_number": { "type": "string", "nullable": true, "description": "VAT number." }, "iban": { "type": "string", "nullable": true, "description": "IBAN." }, "bic": { "type": "string", "nullable": true, "description": "BIC/SWIFT." } } }, "RecurringModelEnum": { "enum": [ "subscription", "one-off" ], "type": "string", "description": "* `subscription` - Subscription payments\n* `one-off` - One-off payments" }, "RecurringTypeEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Daily\n* `2` - Weekly\n* `3` - Monthly\n* `4` - Yearly" }, "ReferralFeedback": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "patient_referral": { "type": "string", "format": "uri" }, "referrers": { "type": "array", "items": { "type": "string", "format": "uri" } }, "text": { "type": "string", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReferralFeedbackStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "modified_session": { "type": "string", "nullable": true, "maxLength": 63 }, "approved": { "type": "boolean" }, "approved_date": { "type": "string", "format": "date-time", "nullable": true }, "approved_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "id", "modified", "patient_referral", "referrers", "url" ] }, "ReferralFeedbackAttachment": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "referral_feedback": { "type": "string", "format": "uri" }, "upload": { "type": "string", "readOnly": true }, "data": { "type": "string", "readOnly": true }, "active": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "data", "id", "modified", "referral_feedback", "upload" ] }, "ReferralFeedbackStatusEnum": { "enum": [ 1, 5, 2, 3, 4 ], "type": "integer", "description": "* `1` - Not sent\n* `5` - Sending\n* `2` - Sent\n* `3` - Sent, but an attachment was missing\n* `4` - Failed to send" }, "ReferralInternalStatus": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "text": { "type": "string", "maxLength": 31 }, "background_color": { "$ref": "#/components/schemas/BackgroundColorEnum" }, "text_color": { "$ref": "#/components/schemas/TextColorEnum" }, "default": { "type": "boolean" }, "mapped_to": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/MappedToEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "locking": { "type": "boolean" }, "require_results": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "archived": { "type": "boolean" } }, "required": [ "created", "department", "id", "modified", "text", "url" ] }, "Referrer": { "type": "object", "description": "Use namespaced fields.", "properties": { "referring_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "referring_organization": { "type": "string", "format": "uri", "nullable": true }, "patient_referral": { "type": "string", "format": "uri" } }, "required": [ "patient_referral" ] }, "ReferrerListRequest": { "type": "object", "properties": { "referring_veterinarian_first_name": { "type": "string", "writeOnly": true, "minLength": 1 }, "referring_veterinarian_last_name": { "type": "string", "writeOnly": true, "minLength": 1 }, "referring_veterinarian_email": { "type": "string", "format": "email", "writeOnly": true, "minLength": 1 }, "referring_veterinarian_phone_number": { "type": "string", "writeOnly": true, "minLength": 1 }, "referring_organization_name": { "type": "string", "writeOnly": true, "minLength": 1 }, "referring_organization_email": { "type": "string", "format": "email", "writeOnly": true, "minLength": 1 }, "referring_organization_phone_number": { "type": "string", "writeOnly": true, "minLength": 1 } } }, "ReferrerRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "referring_veterinarian": { "type": "string", "format": "uri", "nullable": true }, "referring_organization": { "type": "string", "format": "uri", "nullable": true }, "patient_referral": { "type": "string", "format": "uri" } }, "required": [ "patient_referral" ] }, "RefillItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "prescription_repeat": { "type": "string", "format": "uri" }, "item": { "type": "string", "format": "uri" }, "refill_expiry_date": { "type": "string", "format": "date", "nullable": true }, "name": { "type": "string", "maxLength": 255 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "use_dispense_fee": { "type": "boolean" }, "instructions": { "type": "string", "nullable": true }, "medication_duration_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "withdrawal_periods": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "alternative_pricing_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true, "description": "ID of the organization.AlternativePricing object used for this refill" }, "usage_type": { "type": "integer", "maximum": 32767, "minimum": -32768, "nullable": true } }, "required": [ "created", "id", "item", "name", "prescription_repeat", "url" ] }, "RefillItemCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "item": { "type": "string", "format": "uri" }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "medication_duration_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "instructions": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "required": [ "id", "item", "usage_size" ] }, "RefillItemCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "item": { "type": "string", "format": "uri" }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "medication_duration_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "instructions": { "type": "string", "nullable": true }, "patient": { "type": "string", "format": "uri", "writeOnly": true }, "prescriber": { "type": "string", "format": "uri", "writeOnly": true, "title": "Presciber" }, "repeats": { "type": "integer", "minimum": 1, "writeOnly": true }, "refill_expiry_date": { "type": "string", "format": "date", "writeOnly": true }, "created": { "type": "string", "format": "date-time" }, "alternative_pricing_id": { "type": "integer", "writeOnly": true, "nullable": true, "description": "ID of the AlternativePricing to use for this refill" } }, "required": [ "item", "patient", "prescriber", "repeats", "usage_size" ] }, "RemindEnum": { "enum": [ 0, 10, 30, 60 ], "description": "* `None` - No reminder\n* `0` - At deadline\n* `10` - 10 minutes\n* `30` - 30 minutes\n* `60` - 60 minutes" }, "Reminder": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "reminder_template": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "email_address": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "email_subject": { "type": "string", "nullable": true, "maxLength": 255 }, "email_text": { "type": "string", "nullable": true }, "sms_text": { "type": "string", "nullable": true }, "post_text": { "type": "string", "nullable": true }, "text_manually": { "type": "boolean" }, "send_before": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "send_method": { "allOf": [ { "$ref": "#/components/schemas/SendMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "expiry_date": { "type": "string", "format": "date" }, "planned_sending_date": { "type": "string", "format": "date", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReminderStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "created_by": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified_by": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "recurring_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/RecurringTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "recurring_times": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "recurring_interval": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "external_url": { "type": "string", "format": "uri", "nullable": true, "maxLength": 200 }, "replaced_by": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client", "created", "created_by", "department", "expiry_date", "modified", "modified_by", "send_before", "url" ] }, "ReminderRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "reminder_template": { "type": "string", "format": "uri", "nullable": true }, "patient": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri" }, "email_address": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "email_subject": { "type": "string", "nullable": true, "maxLength": 255 }, "email_text": { "type": "string", "minLength": 1, "nullable": true }, "sms_text": { "type": "string", "nullable": true }, "post_text": { "type": "string", "nullable": true }, "text_manually": { "type": "boolean" }, "send_before": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "send_method": { "allOf": [ { "$ref": "#/components/schemas/SendMethodEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "expiry_date": { "type": "string", "format": "date" }, "planned_sending_date": { "type": "string", "format": "date", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ReminderStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "recurring_type": { "nullable": true, "minimum": -2147483648, "maximum": 2147483647, "oneOf": [ { "$ref": "#/components/schemas/RecurringTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "recurring_times": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "recurring_interval": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "external_url": { "type": "string", "format": "uri", "nullable": true, "maxLength": 200 }, "replaced_by": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client", "department", "expiry_date", "send_before" ] }, "ReminderStatusEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "* `0` - Created\n* `1` - Queued\n* `2` - Sending\n* `3` - Sent\n* `4` - Prevented\n* `5` - Paused\n* `6` - Cancelled" }, "ReminderTemplate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "title": { "type": "string", "maxLength": 255 }, "email_text": { "type": "string", "nullable": true }, "sms_text": { "type": "string", "nullable": true }, "post_text": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "created_by": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified_by": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "created_by", "id", "modified", "modified_by", "title", "url" ] }, "ReminderTemplateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "email_text": { "type": "string", "minLength": 1, "nullable": true }, "sms_text": { "type": "string", "nullable": true }, "post_text": { "type": "string", "nullable": true }, "department": { "type": "string", "format": "uri", "nullable": true }, "update_existing": { "type": "boolean", "writeOnly": true } }, "required": [ "title" ] }, "RenewEnum": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "* `0` - Do not renew\n* `1` - Renew once\n* `2` - Renew continuously" }, "RepeatTimeunitEnum": { "enum": [ "Dg", "V", "Mn" ], "type": "string", "description": "* `Dg` - days\n* `V` - weeks\n* `Mn` - months" }, "ResourceDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "initials": { "type": "string", "nullable": true, "maxLength": 4 }, "is_active": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "web": { "type": "boolean" }, "sharing_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "sharing_department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "department", "id", "name", "url" ] }, "ResourceDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "initials": { "type": "string", "nullable": true, "minLength": 1, "maxLength": 4 }, "is_active": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "web": { "type": "boolean" }, "sharing_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "sharing_department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "department", "name" ] }, "ResourcesAvailability": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "minimum": 1 }, "department_id": { "type": "integer" }, "available_to": { "type": "string", "format": "date-time" }, "treating_employees": { "type": "string", "default": "" }, "user_types": { "type": "string", "default": "" }, "reason": { "type": "integer", "nullable": true }, "show_extra": { "type": "boolean", "default": false } }, "required": [ "department_id", "duration", "end", "start" ] }, "RespiratoryRate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "respiratory_rate": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "id", "timestamp" ] }, "RespiratoryRateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "respiratory_rate": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "timestamp" ] }, "RuleType3ebEnum": { "enum": [ 0, 1 ], "type": "integer", "description": "* `0` - Not valid\n* `1` - Valid only" }, "RuleType4b6Enum": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "* `0` - Tags\n* `1` - Clients\n* `2` - Patients\n* `3` - Species\n* `4` - All clients" }, "RuleTypeAfbEnum": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "* `0` - Item types\n* `1` - Item subgroups\n* `2` - Items\n* `3` - Fixed price templates\n* `4` - Item categories" }, "SendMethodEnum": { "enum": [ 1, 2, 0, 3, 4 ], "type": "integer", "description": "* `1` - Email\n* `2` - SMS\n* `0` - Email and SMS\n* `3` - Mail\n* `4` - External" }, "ShiftTemplate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "active": { "type": "boolean" }, "name": { "type": "string", "maxLength": 255 }, "code": { "type": "string", "nullable": true, "maxLength": 32 }, "two_day_template": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true }, "modified_user": { "type": "string", "format": "uri", "readOnly": true, "nullable": true } }, "required": [ "created", "created_user", "department", "id", "modified", "modified_user", "name", "url" ] }, "ShiftTemplateBlock": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "block_index": { "type": "integer", "maximum": 65535, "minimum": 0 }, "start_time": { "type": "string", "format": "time" }, "end_time": { "type": "string", "format": "time" } }, "required": [ "end_time", "id", "start_time" ] }, "ShiftTemplateBlockFragment": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "start_time": { "type": "string", "format": "time" }, "end_time": { "type": "string", "format": "time" }, "shift_type": { "type": "integer" }, "web": { "type": "boolean" }, "note": { "type": "string", "nullable": true }, "ward": { "type": "integer", "nullable": true }, "team": { "type": "integer", "nullable": true } }, "required": [ "end_time", "id", "shift_type", "start_time" ] }, "ShiftTemplateBlockFragmentRequest": { "type": "object", "properties": { "start_time": { "type": "string", "format": "time" }, "end_time": { "type": "string", "format": "time" }, "shift_type": { "type": "integer" }, "web": { "type": "boolean" }, "note": { "type": "string", "nullable": true }, "ward": { "type": "integer", "nullable": true }, "team": { "type": "integer", "nullable": true } }, "required": [ "end_time", "shift_type", "start_time" ] }, "ShiftTemplateBlockRequest": { "type": "object", "properties": { "block_index": { "type": "integer", "maximum": 65535, "minimum": 0 }, "start_time": { "type": "string", "format": "time" }, "end_time": { "type": "string", "format": "time" } }, "required": [ "end_time", "start_time" ] }, "ShiftTemplateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "active": { "type": "boolean" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "code": { "type": "string", "nullable": true, "maxLength": 32 }, "two_day_template": { "type": "boolean" }, "department": { "type": "string", "format": "uri" } }, "required": [ "department", "name" ] }, "ShiftType": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "code": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "department": { "type": "string", "format": "uri" }, "background_color": { "type": "string", "pattern": "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "example": "#3780b9", "description": "Background colour of the shift, as a hex value. Defaults to #3780b9. Any 24-bit colour is accepted, not only the options offered in the UI. This is the colour that is stored; the calendar may render a variation of it, so do not rely on it to reproduce how a shift looks in the calendar." }, "text_color": { "type": "string", "pattern": "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "example": "#3780b9", "description": "Colour of the shift text, as a hex value. Defaults to #000000. Any 24-bit colour is accepted, not only the options offered in the UI. This is the colour that is stored; some clinics take the text colour from the background colour instead, in which case this value is stored but not shown." }, "in_appointments": { "type": "boolean" }, "in_online_booking": { "type": "boolean" }, "in_all_day": { "type": "boolean" }, "is_custom": { "type": "boolean" }, "is_active": { "type": "boolean" }, "complaint_types": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "code", "department", "name", "url" ] }, "ShiftTypeCreateUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 30 }, "code": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "department": { "type": "string", "format": "uri" }, "background_color": { "type": "string", "pattern": "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "example": "#3780b9", "description": "Background colour of the shift, as a hex value. Defaults to #3780b9. Any 24-bit colour is accepted, not only the options offered in the UI. This is the colour that is stored; the calendar may render a variation of it, so do not rely on it to reproduce how a shift looks in the calendar." }, "text_color": { "type": "string", "pattern": "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "example": "#3780b9", "description": "Colour of the shift text, as a hex value. Defaults to #000000. Any 24-bit colour is accepted, not only the options offered in the UI. This is the colour that is stored; some clinics take the text colour from the background colour instead, in which case this value is stored but not shown." }, "in_appointments": { "type": "boolean" }, "in_online_booking": { "type": "boolean" }, "in_all_day": { "type": "boolean" }, "is_custom": { "type": "boolean" }, "is_active": { "type": "boolean" }, "complaint_types": { "type": "array", "items": { "type": "string", "format": "uri" } }, "update_existing_shifts": { "type": "boolean" } }, "required": [ "code", "department", "name", "url" ] }, "ShiftTypeCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 30 }, "code": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "department": { "type": "string", "format": "uri" }, "background_color": { "type": "string", "pattern": "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "example": "#3780b9", "minLength": 1, "description": "Background colour of the shift, as a hex value. Defaults to #3780b9. Any 24-bit colour is accepted, not only the options offered in the UI. This is the colour that is stored; the calendar may render a variation of it, so do not rely on it to reproduce how a shift looks in the calendar." }, "text_color": { "type": "string", "pattern": "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$", "example": "#3780b9", "minLength": 1, "description": "Colour of the shift text, as a hex value. Defaults to #000000. Any 24-bit colour is accepted, not only the options offered in the UI. This is the colour that is stored; some clinics take the text colour from the background colour instead, in which case this value is stored but not shown." }, "in_appointments": { "type": "boolean" }, "in_online_booking": { "type": "boolean" }, "in_all_day": { "type": "boolean" }, "is_custom": { "type": "boolean" }, "is_active": { "type": "boolean" }, "complaint_types": { "type": "array", "items": { "type": "string", "format": "uri" } }, "update_existing_shifts": { "type": "boolean" } }, "required": [ "code", "department", "name" ] }, "SmsLog": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "sent_time": { "type": "string", "format": "date-time" }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusCc4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "department": { "type": "string", "format": "uri", "nullable": true }, "sender": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "msgid": { "type": "string", "nullable": true, "maxLength": 63 } }, "required": [ "created", "modified", "sent_time", "status", "url" ] }, "SmsLogDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "sent_time": { "type": "string", "format": "date-time" }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusCc4Enum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "department": { "type": "string", "format": "uri", "nullable": true }, "sender": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "status_check_count": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "status_msg": { "type": "string", "nullable": true }, "success_timestamp": { "type": "string", "format": "date-time", "nullable": true }, "error_reported": { "type": "boolean" }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "message": { "type": "string", "nullable": true }, "sms_count": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "balance_left": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "msgid": { "type": "string", "nullable": true, "maxLength": 63 } }, "required": [ "created", "id", "modified", "patients", "sent_time", "sms_count", "status" ] }, "SmsMessageEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Use standard (non reason specific) confirmations and reminders\n* `2` - Use reason specific message, same for confirmation and reminder\n* `3` - Use reason specific message, customised confirmation and reminder" }, "SourceEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Nordhealth Pay\n* `2` - Gravity Payments" }, "SpecialMedicineEnum": { "enum": [ 0, 1 ], "type": "integer", "description": "* `0` - ---------\n* `1` - Euthanasia" }, "SpecialProcedureEnum": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "* `0` - ---------\n* `1` - Euthanasia\n* `2` - Neutering\n* `3` - Microchipping" }, "Status094Enum": { "enum": [ 8, 2, 9, 3, 4, 5, 6 ], "type": "integer", "description": "* `8` - Incoming\n* `2` - Received\n* `9` - Approved\n* `3` - Appointment booked\n* `4` - Started\n* `5` - Ended\n* `6` - Feedback sent" }, "Status0ddEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "description": "* `0` - Received\n* `1` - Submitted\n* `2` - Quarantined\n* `3` - Sent to wholesaler\n* `4` - Not dispatched\n* `5` - In Delivery\n* `6` - Cancelled\n* `7` - DNP returned in Mail\n* `8` - DNP returned by wholesaler\n* `9` - Delivered" }, "Status17bEnum": { "enum": [ 0, 1, 2, 4, 3 ], "type": "integer", "description": "* `0` - Ordering in process\n* `1` - Ordered\n* `2` - Products delivered\n* `4` - Partially added to stock\n* `3` - Added to stock" }, "Status183Enum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Pending\n* `2` - Cancelled\n* `3` - Paid\n* `4` - Failed" }, "Status315Enum": { "enum": [ 3, 0, 1, 2 ], "type": "integer", "description": "* `3` - Planned\n* `0` - Not started\n* `1` - In progress\n* `2` - Complete" }, "Status36bEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Active\n* `2` - Archived\n* `3` - Draft" }, "Status5c4Enum": { "enum": [ 1, 2, 3, 4, 8, 5, 6, 7 ], "type": "integer", "description": "* `1` - Draft\n* `2` - Sending\n* `3` - Sent\n* `4` - Accepted\n* `8` - Accepted with warnings\n* `5` - Rejected\n* `6` - Canceled\n* `7` - Error" }, "Status7c4Enum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Not started\n* `2` - In progress\n* `3` - Complete\n* `4` - Archived" }, "Status85eEnum": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `1` - Open\n* `2` - Ready for accounting\n* `3` - Reported to accounting\n* `4` - Archived\n* `5` - Closed" }, "Status9c9Enum": { "enum": [ 0, 8, 5, 7, 6, 9, 10, 11 ], "type": "integer", "description": "* `0` - Checked in\n* `8` - In progress\n* `5` - Ready for discharge\n* `7` - Invoicing\n* `6` - Discharged\n* `9` - Invoice paid\n* `10` - Finalized\n* `11` - Draft" }, "StatusA2dEnum": { "enum": [ 0, 1 ], "type": "integer", "description": "* `0` - Draft\n* `1` - Finalized" }, "StatusAb8Enum": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "* `0` - Planned\n* `1` - Prepared\n* `2` - Started\n* `3` - Done\n* `4` - Skipped" }, "StatusC54Enum": { "enum": [ "DRAFT", "FINALIZED", "PAID", "PARTIALLY_PAID", "OVERPAID", "CANCELLED" ], "type": "string", "description": "* `DRAFT` - Draft\n* `FINALIZED` - Finalized\n* `PAID` - Paid\n* `PARTIALLY_PAID` - Partially Paid\n* `OVERPAID` - Overpaid\n* `CANCELLED` - Cancelled" }, "StatusCc4Enum": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "description": "* `1` - Sending...\n* `2` - Unknown\n* `3` - Sent\n* `4` - Success\n* `5` - Failed" }, "StatusF35Enum": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "description": "* `0` - Upcoming\n* `1` - Active\n* `2` - Ended\n* `3` - Cancelled\n* `4` - Suspended\n* `5` - Applied for\n* `6` - Signed\n* `7` - Pending payment\n* `8` - Signup failed\n* `9` - Pending card activation" }, "StatusTypeEnum": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "* `0` - Internal\n* `1` - Research\n* `2` - External" }, "StockItem": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "item": { "type": "string", "format": "uri" }, "item_type_code": { "type": "integer" }, "item_name": { "type": "string" }, "item_unit_description": { "type": "string", "readOnly": true }, "item_package_description": { "type": "string", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "department_level": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "readOnly": true }, "stock_level": { "type": "number", "format": "double", "readOnly": true }, "wholesale_price_unit": { "type": "number", "format": "double", "readOnly": true }, "stock_value": { "type": "number", "format": "double", "readOnly": true } }, "required": [ "department", "department_level", "item", "item_name", "item_package_description", "item_type_code", "item_unit_description", "stock_level", "stock_value", "url", "wholesale_price_unit" ] }, "StockItemCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "item": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" } }, "required": [ "department", "item", "url" ] }, "StockItemCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "item": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" } }, "required": [ "department", "item" ] }, "StockItemList": { "type": "object", "description": "List-optimized serializer for non-polymorphic Item prefetch.\n\nItems are prefetched with non_polymorphic() and subtype fields\n(unit, package_description, dosage_units) are injected as instance\nattributes by _hydrate_item_subtype_fields(). This avoids:\n- 3000 reverse() calls (cached URL fields resolve once)\n- Per-subtype DB queries from polymorphic resolution (~400ms)", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "item": { "type": "string", "format": "uri", "readOnly": true }, "item_type_code": { "type": "integer" }, "item_name": { "type": "string" }, "item_unit_description": { "type": "string", "readOnly": true }, "item_package_description": { "type": "string", "readOnly": true }, "department": { "type": "string", "format": "uri", "readOnly": true }, "department_level": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "readOnly": true }, "stock_level": { "type": "number", "format": "double", "readOnly": true }, "wholesale_price_unit": { "type": "number", "format": "double", "readOnly": true }, "stock_value": { "type": "number", "format": "double", "readOnly": true } }, "required": [ "department", "department_level", "item", "item_name", "item_package_description", "item_type_code", "item_unit_description", "stock_level", "stock_value", "url", "wholesale_price_unit" ] }, "StockItemRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "item": { "type": "string", "format": "uri" }, "item_type_code": { "type": "integer" }, "item_name": { "type": "string", "minLength": 1 }, "department": { "type": "string", "format": "uri" } }, "required": [ "department", "item", "item_name", "item_type_code" ] }, "StockLevelDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "item": { "type": "string", "format": "uri" }, "item_type_code": { "type": "integer" }, "item_name": { "type": "string" }, "item_unit_description": { "type": "string", "readOnly": true }, "item_package_description": { "type": "string", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "department_level": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "readOnly": true }, "stock_level": { "type": "number", "format": "double", "readOnly": true }, "wholesale_price_unit": { "type": "number", "format": "double", "readOnly": true }, "stock_value": { "type": "number", "format": "double", "readOnly": true }, "item_entries": { "type": "array", "items": { "type": "object", "additionalProperties": {} }, "readOnly": true }, "location_levels": { "type": "array", "items": { "type": "object", "description": "Stock level for a single stock location.", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "packages": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" } }, "required": [ "id", "name", "packages", "units" ] }, "readOnly": true } }, "required": [ "department", "department_level", "item", "item_entries", "item_name", "item_package_description", "item_type_code", "item_unit_description", "location_levels", "stock_level", "stock_value", "url", "wholesale_price_unit" ] }, "StockLocation": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "name": { "type": "string", "maxLength": 63 }, "is_default": { "type": "boolean" }, "archived": { "type": "boolean" }, "department": { "type": "string", "format": "uri" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "department", "modified", "name", "url" ] }, "SupplyList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "code": { "type": "string", "maxLength": 40 }, "barcode": { "type": "string", "nullable": true, "maxLength": 40 }, "account_number": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "print_name": { "type": "string", "nullable": true, "maxLength": 255 }, "hide_on_consultation": { "type": "boolean" }, "hide_on_consultation_search": { "type": "boolean" }, "hide_on_countersale_search": { "type": "boolean" }, "price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "price_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "wholesale_price": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "vat_group": { "type": "string", "format": "uri", "readOnly": true }, "minimum_charge": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "minimum_charge_with_vat": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "type_code": { "allOf": [ { "$ref": "#/components/schemas/TypeCode4d9Enum" } ], "minimum": -32768, "maximum": 32767 }, "polymorphic_ctype": { "type": "string", "format": "uri", "readOnly": true }, "archived": { "type": "boolean" }, "item_list": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "invoice_group": { "type": "string", "format": "uri", "nullable": true }, "main_item": { "type": "string", "format": "uri", "readOnly": true }, "external_reporting_code": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_2": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_3": { "type": "string", "nullable": true, "maxLength": 255 }, "alert_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true }, "optimum_level": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "nullable": true, "title": "Optimum level (packages)" }, "not_in_stock_management": { "type": "boolean" }, "discontinued_product": { "type": "boolean", "description": "These items can no longer be added into orders" }, "unit": { "type": "string", "nullable": true, "maxLength": 63 }, "default_order_amount": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "manufacturer": { "nullable": true }, "shelf_location": { "type": "string", "nullable": true, "maxLength": 63 }, "usage_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UsageTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "default_usage_size": { "allOf": [ { "$ref": "#/components/schemas/DefaultUsageSizeEnum" } ], "description": "USAGE_SIZE_PACKAGE = 1, USAGE_SIZE_DOSAGE_UNITS = 2\n\n* `1` - Package\n* `2` - Units", "minimum": -32768, "maximum": 32767 }, "manufacturer_url": { "type": "string", "nullable": true, "format": "uri", "maxLength": 200 }, "allow_home_delivery": { "type": "boolean" }, "external_reporting_code_4": { "type": "string", "nullable": true, "maxLength": 255 }, "external_reporting_code_5": { "type": "string", "nullable": true, "maxLength": 255 }, "primary_wholesaler_id": { "type": "integer", "nullable": true, "readOnly": true, "description": "ID of the primary wholesaler for this stock item. Null on non-stock items (procedures) or when unset." }, "primary_wholesaler_code": { "type": "string", "nullable": true, "readOnly": true, "description": "Wholesaler-specific product code for the primary wholesaler. Null on non-stock items or when unset." } }, "required": [ "created", "id", "item_list", "main_item", "modified", "name", "polymorphic_ctype", "primary_wholesaler_code", "primary_wholesaler_id", "type_code", "url", "vat_group" ] }, "TagText": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "department_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "default": -1 }, "text": { "type": "string", "maxLength": 50 }, "background": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "title": "Background color" }, "foreground": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "title": "Text color" }, "readonly": { "type": "boolean" }, "in_client": { "type": "boolean", "title": "Client" }, "in_invoice": { "type": "boolean", "title": "Invoice" }, "in_patient": { "type": "boolean", "title": "Patient" }, "in_item": { "type": "boolean", "title": "Item" }, "in_health_plan": { "type": "boolean", "title": "Health plan" }, "in_custom_field": { "type": "boolean", "title": "Custom field" }, "in_permission_group": { "type": "boolean", "title": "Permission groups" }, "permission_groups": { "type": "array", "items": { "type": "integer" } } }, "required": [ "id", "text" ] }, "TagTextRequest": { "type": "object", "properties": { "department_id": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "default": -1 }, "text": { "type": "string", "minLength": 1, "maxLength": 50 }, "background": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "title": "Background color" }, "foreground": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "title": "Text color" }, "readonly": { "type": "boolean" }, "in_client": { "type": "boolean", "title": "Client" }, "in_invoice": { "type": "boolean", "title": "Invoice" }, "in_patient": { "type": "boolean", "title": "Patient" }, "in_item": { "type": "boolean", "title": "Item" }, "in_health_plan": { "type": "boolean", "title": "Health plan" }, "in_custom_field": { "type": "boolean", "title": "Custom field" }, "in_permission_group": { "type": "boolean", "title": "Permission groups" }, "permission_groups": { "type": "array", "items": { "type": "integer" } } }, "required": [ "text" ] }, "TargetArea": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "modality": { "type": "string", "format": "uri", "nullable": true }, "target_area": { "type": "string", "maxLength": 255 }, "code": { "type": "string", "nullable": true, "maxLength": 16 }, "procedure": { "type": "string" } }, "required": [ "id", "target_area", "url" ] }, "Task": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "title": { "type": "string", "maxLength": 255 }, "text": { "type": "string", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/TaskStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "task_type": { "allOf": [ { "$ref": "#/components/schemas/TaskTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "favourite": { "type": "boolean" }, "due": { "type": "string", "format": "date-time", "nullable": true }, "remind": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RemindEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "user": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri" }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "ward": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "created_user", "modified", "patients", "title", "url" ] }, "TaskRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "text": { "type": "string", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/TaskStatusEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "completed": { "type": "string", "format": "date-time", "nullable": true }, "task_type": { "allOf": [ { "$ref": "#/components/schemas/TaskTypeEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "favourite": { "type": "boolean" }, "due": { "type": "string", "format": "date-time", "nullable": true }, "remind": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RemindEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "user": { "type": "string", "format": "uri", "nullable": true }, "client": { "type": "string", "format": "uri", "nullable": true }, "patients": { "type": "array", "items": { "type": "string", "format": "uri" } }, "created_user": { "type": "string", "format": "uri" }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "ward": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created_user", "patients", "title" ] }, "TaskStatusEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Not done\n* `2` - Done" }, "TaskTypeEnum": { "enum": [ 5, 1, 3, 4, 6, 2 ], "type": "integer", "description": "* `5` - Task\n* `1` - Telephone\n* `3` - Email\n* `4` - Laboratory\n* `6` - Clinical note draft\n* `2` - Other" }, "Team": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "code": { "type": "string", "maxLength": 31 }, "ward": { "type": "string", "format": "uri", "nullable": true }, "is_active": { "type": "boolean" } }, "required": [ "code", "id", "name", "url", "ward" ] }, "TeamRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "code": { "type": "string", "minLength": 1, "maxLength": 31 }, "ward": { "type": "string", "format": "uri", "nullable": true }, "is_active": { "type": "boolean" } }, "required": [ "code", "name", "ward" ] }, "Temperature": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "temperature": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "units": { "type": "string", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "id", "temperature", "timestamp", "units" ] }, "TemperatureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "temperature": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "temperature", "timestamp" ] }, "TemplateInTemplate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "child_template": { "type": "string", "format": "uri" }, "parent_template": { "type": "string", "format": "uri" } }, "required": [ "child_template", "created", "id", "parent_template", "url" ] }, "TemplateInTemplateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "child_template": { "type": "string", "format": "uri" }, "parent_template": { "type": "string", "format": "uri" } }, "required": [ "child_template", "parent_template" ] }, "TextColorEnum": { "enum": [ "000000", "ffffff", "3780b9", "6b37b9", "f39c12", "ff9a80", "c0392b", "2c3e50", "f1c40f", "8A5B33", "7f8c8d", "3ecc71" ], "type": "string", "description": "* `000000` - Black\n* `ffffff` - White\n* `3780b9` - Blue\n* `6b37b9` - Purple\n* `f39c12` - Orange\n* `ff9a80` - Pink\n* `c0392b` - Red\n* `2c3e50` - Midnight blue\n* `f1c40f` - Sun\n* `8A5B33` - Tree\n* `7f8c8d` - Gray\n* `3ecc71` - Green" }, "TextTemplate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "title": { "type": "string", "maxLength": 255 }, "text": { "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type89eEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "specific_user": { "type": "string", "format": "uri", "nullable": true }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "boolean" }, "draft": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "id", "modified", "text", "title", "type", "url" ] }, "TextTemplateDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "title": { "type": "string", "maxLength": 255 }, "text": { "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type89eEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "specific_user": { "type": "string", "format": "uri", "nullable": true }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "boolean" }, "draft": { "type": "boolean" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "created", "id", "modified", "text", "title", "type", "url" ] }, "TextTemplateDetailRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 255 }, "text": { "type": "string", "minLength": 1 }, "type": { "allOf": [ { "$ref": "#/components/schemas/Type89eEnum" } ], "minimum": -2147483648, "maximum": 2147483647 }, "specific_user": { "type": "string", "format": "uri", "nullable": true }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "archived": { "type": "boolean" }, "draft": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "text", "title", "type" ] }, "TimezoneEnum": { "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GMT", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC" ], "type": "string", "description": "* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Coyhaique` - America/Coyhaique\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GMT` - GMT\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC" }, "TokenizeEnum": { "enum": [ "ask", "yes", "no" ], "type": "string", "description": "* `ask` - Ask\n* `yes` - Yes\n* `no` - No" }, "TransactionCategoryEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 27, 28 ], "type": "integer", "description": "* `1` - Finalizing an invoice\n* `2` - Payment of invoice (normal)\n* `3` - Creating a prepayment\n* `4` - Payment of invoice (prepayment)\n* `5` - Overpaying on an invoice\n* `6` - Finalizing a credit note\n* `7` - Credit invoice with credit loss\n* `8` - Creating a consolidated invoice\n* `9` - Revoking a consolidated invoice\n* `10` - Removing an invoice invoice payment\n* `11` - Modifying an invoice\n* `12` - Invoice payment through debt collection\n* `13` - Refunding prepayment\n* `14` - Refunding a credit note\n* `15` - Using credit note against an invoice\n* `16` - Adding insurance debt\n* `17` - Removing insurance debt\n* `18` - Removing an invoice payment (prepayment)\n* `19` - Removing an invoice payment (credit note)\n* `20` - Payment of invoice (insurance company)\n* `21` - Removing an invoice payment (insurance company)\n* `23` - Transferring a credit note to prepayments\n* `24` - Charging a fee for invoicing\n* `25` - Cash deposit to register\n* `26` - Cash withdrawal from register\n* `27` - Cash discrepancy compensation\n* `28` - Cancelling a prepayment" }, "TransactionTerminal": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "serial_number": { "type": "string", "nullable": true, "maxLength": 255 }, "brand": { "type": "string", "nullable": true, "maxLength": 255 }, "model": { "type": "string", "nullable": true, "maxLength": 255 }, "archived": { "type": "boolean" }, "department": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "department", "id", "modified", "name" ] }, "TransactionTypeEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - PoSXML\n* `2` - Baxi\n* `3` - Connect@Cloud\n* `4` - Nordhealth Pay" }, "TreatmentPlan": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "start_date": { "type": "string", "format": "date" }, "end_date": { "type": "string", "format": "date", "nullable": true }, "ongoing": { "type": "boolean" }, "every_n_days": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "repetitions_per_day": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "treatment_plan_items": { "type": "array", "items": { "type": "string", "format": "uri" } }, "timings": { "type": "string", "readOnly": true }, "is_cabinet_item": { "type": "boolean" } }, "required": [ "consultation", "every_n_days", "id", "patient", "repetitions_per_day", "start_date", "timings", "treatment_plan_items", "url" ] }, "TreatmentPlanCreateRequest": { "type": "object", "description": "Create a scheduled treatment plan for a stock item on a consultation.\n\nSupports medicine, food and supply items (procedures are not supported). The\nschedule is fanned out into individual plan items across the date range at\neach supplied timing. Mark each item done to create its billing item and,\nfor cabinet items, trigger Cubex dispensing. Values not supplied fall back to\nitem/department defaults.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "description": "Required only when the consultation has more than one patient; otherwise the consultation's patient is used." }, "item": { "type": "string", "format": "uri", "description": "Medicine, food or supply item. Procedures are not supported." }, "start_date": { "type": "string", "format": "date" }, "end_date": { "type": "string", "format": "date" }, "ongoing": { "type": "boolean", "default": false }, "every_n_days": { "allOf": [ { "$ref": "#/components/schemas/EveryNDaysEnum" } ], "default": 1 }, "repetitions_per_day": { "type": "integer", "minimum": 1, "default": 1 }, "timings": { "type": "array", "items": { "type": "string", "format": "time" }, "description": "Times of day for each scheduled dose, e.g. ['08:00', '20:00']." }, "first_day_timings": { "type": "array", "items": { "type": "string", "format": "time" } }, "dispense_fee_repetitions": { "$ref": "#/components/schemas/DispenseFeeRepetitionsEnum" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000000000000, "minimum": 0.0, "exclusiveMaximum": true }, "usage_size": { "$ref": "#/components/schemas/UsageSizeEnum" }, "instructions": { "type": "string" } }, "required": [ "consultation", "item", "start_date", "timings" ] }, "TreatmentPlanFood": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "treatment_plan": { "type": "string", "format": "uri" }, "planned_time": { "type": "string", "format": "date-time" }, "planned_user": { "type": "string", "format": "uri", "nullable": true }, "prepared_time": { "type": "string", "format": "date-time", "nullable": true }, "prepared_user": { "type": "string", "format": "uri", "nullable": true }, "started_time": { "type": "string", "format": "date-time", "nullable": true }, "started_user": { "type": "string", "format": "uri", "nullable": true }, "done_time": { "type": "string", "format": "date-time", "nullable": true }, "done_user": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusAb8Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "instructions": { "type": "string", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "archived": { "type": "boolean" }, "unit": { "type": "string", "description": "Unit description from item settings" }, "package_description": { "type": "string", "description": "Package description from item settings" } }, "required": [ "id", "item", "package_description", "planned_time", "treatment_plan", "unit", "url" ] }, "TreatmentPlanFoodRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "treatment_plan": { "type": "string", "format": "uri" }, "planned_time": { "type": "string", "format": "date-time" }, "planned_user": { "type": "string", "format": "uri", "nullable": true }, "prepared_time": { "type": "string", "format": "date-time", "nullable": true }, "prepared_user": { "type": "string", "format": "uri", "nullable": true }, "started_time": { "type": "string", "format": "date-time", "nullable": true }, "started_user": { "type": "string", "format": "uri", "nullable": true }, "done_time": { "type": "string", "format": "date-time", "nullable": true }, "done_user": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusAb8Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "instructions": { "type": "string", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "archived": { "type": "boolean" }, "unit": { "type": "string", "minLength": 1, "description": "Unit description from item settings" }, "package_description": { "type": "string", "minLength": 1, "description": "Package description from item settings" } }, "required": [ "item", "package_description", "planned_time", "treatment_plan", "unit" ] }, "TreatmentPlanFoodUpdatePartial": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } } }, "TreatmentPlanList": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "start_date": { "type": "string", "format": "date" }, "end_date": { "type": "string", "format": "date", "nullable": true }, "ongoing": { "type": "boolean" }, "every_n_days": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "repetitions_per_day": { "type": "integer", "maximum": 32767, "minimum": -32768 }, "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "is_cabinet_item": { "type": "boolean" } }, "required": [ "consultation", "every_n_days", "id", "patient", "repetitions_per_day", "start_date", "url" ] }, "TreatmentPlanMedicine": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "treatment_plan": { "type": "string", "format": "uri" }, "planned_time": { "type": "string", "format": "date-time" }, "planned_user": { "type": "string", "format": "uri", "nullable": true }, "prepared_time": { "type": "string", "format": "date-time", "nullable": true }, "prepared_user": { "type": "string", "format": "uri", "nullable": true }, "started_time": { "type": "string", "format": "date-time", "nullable": true }, "started_user": { "type": "string", "format": "uri", "nullable": true }, "done_time": { "type": "string", "format": "date-time", "nullable": true }, "done_user": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusAb8Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "instructions": { "type": "string", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "measurement_loss": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "archived": { "type": "boolean" }, "unit": { "type": "string", "description": "Unit description from item settings" }, "package_description": { "type": "string", "description": "Package description from item settings" } }, "required": [ "id", "item", "package_description", "planned_time", "treatment_plan", "unit", "url" ] }, "TreatmentPlanMedicineCreateRequest": { "type": "object", "description": "Create a medicine treatment plan item on a consultation.\n\nCreates a single-occurrence medicine treatment plan (planned for the current\ntime). The resulting plan item can then be marked done to create the billing\nitem and, for cabinet items, trigger Cubex dispensing. Values not supplied\nfall back to the item/department defaults.", "properties": { "consultation": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri", "description": "Required only when the consultation has more than one patient; otherwise the consultation's patient is used." }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000000000000, "minimum": 0.0, "exclusiveMaximum": true }, "usage_size": { "$ref": "#/components/schemas/UsageSizeEnum" }, "instructions": { "type": "string" } }, "required": [ "consultation", "item" ] }, "TreatmentPlanMedicineRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "treatment_plan": { "type": "string", "format": "uri" }, "planned_time": { "type": "string", "format": "date-time" }, "planned_user": { "type": "string", "format": "uri", "nullable": true }, "prepared_time": { "type": "string", "format": "date-time", "nullable": true }, "prepared_user": { "type": "string", "format": "uri", "nullable": true }, "started_time": { "type": "string", "format": "date-time", "nullable": true }, "started_user": { "type": "string", "format": "uri", "nullable": true }, "done_time": { "type": "string", "format": "date-time", "nullable": true }, "done_user": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusAb8Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "instructions": { "type": "string", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "measurement_loss": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "archived": { "type": "boolean" }, "unit": { "type": "string", "minLength": 1, "description": "Unit description from item settings" }, "package_description": { "type": "string", "minLength": 1, "description": "Package description from item settings" } }, "required": [ "item", "package_description", "planned_time", "treatment_plan", "unit" ] }, "TreatmentPlanMedicineUpdatePartial": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } } }, "TreatmentPlanProcedure": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "treatment_plan": { "type": "string", "format": "uri" }, "planned_time": { "type": "string", "format": "date-time" }, "planned_user": { "type": "string", "format": "uri", "nullable": true }, "prepared_time": { "type": "string", "format": "date-time", "nullable": true }, "prepared_user": { "type": "string", "format": "uri", "nullable": true }, "started_time": { "type": "string", "format": "date-time", "nullable": true }, "started_user": { "type": "string", "format": "uri", "nullable": true }, "done_time": { "type": "string", "format": "date-time", "nullable": true }, "done_user": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusAb8Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "description": { "type": "string", "nullable": true }, "archived": { "type": "boolean" } }, "required": [ "id", "item", "planned_time", "treatment_plan", "url" ] }, "TreatmentPlanProcedureRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "treatment_plan": { "type": "string", "format": "uri" }, "planned_time": { "type": "string", "format": "date-time" }, "planned_user": { "type": "string", "format": "uri", "nullable": true }, "prepared_time": { "type": "string", "format": "date-time", "nullable": true }, "prepared_user": { "type": "string", "format": "uri", "nullable": true }, "started_time": { "type": "string", "format": "date-time", "nullable": true }, "started_user": { "type": "string", "format": "uri", "nullable": true }, "done_time": { "type": "string", "format": "date-time", "nullable": true }, "done_user": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusAb8Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "description": { "type": "string", "nullable": true }, "archived": { "type": "boolean" } }, "required": [ "item", "planned_time", "treatment_plan" ] }, "TreatmentPlanProcedureUpdatePartial": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true } } }, "TreatmentPlanSupply": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "treatment_plan": { "type": "string", "format": "uri" }, "planned_time": { "type": "string", "format": "date-time" }, "planned_user": { "type": "string", "format": "uri", "nullable": true }, "prepared_time": { "type": "string", "format": "date-time", "nullable": true }, "prepared_user": { "type": "string", "format": "uri", "nullable": true }, "started_time": { "type": "string", "format": "date-time", "nullable": true }, "started_user": { "type": "string", "format": "uri", "nullable": true }, "done_time": { "type": "string", "format": "date-time", "nullable": true }, "done_user": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusAb8Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "instructions": { "type": "string", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "archived": { "type": "boolean" }, "unit": { "type": "string", "description": "Unit description from item settings" }, "package_description": { "type": "string", "description": "Package description from item settings" } }, "required": [ "id", "item", "package_description", "planned_time", "treatment_plan", "unit", "url" ] }, "TreatmentPlanSupplyRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "treatment_plan": { "type": "string", "format": "uri" }, "planned_time": { "type": "string", "format": "date-time" }, "planned_user": { "type": "string", "format": "uri", "nullable": true }, "prepared_time": { "type": "string", "format": "date-time", "nullable": true }, "prepared_user": { "type": "string", "format": "uri", "nullable": true }, "started_time": { "type": "string", "format": "date-time", "nullable": true }, "started_user": { "type": "string", "format": "uri", "nullable": true }, "done_time": { "type": "string", "format": "date-time", "nullable": true }, "done_user": { "type": "string", "format": "uri", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusAb8Enum" } ], "minimum": -32768, "maximum": 32767 }, "consultation_item": { "type": "string", "format": "uri", "nullable": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 }, "instructions": { "type": "string", "nullable": true }, "item": { "type": "string", "format": "uri" }, "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "archived": { "type": "boolean" }, "unit": { "type": "string", "minLength": 1, "description": "Unit description from item settings" }, "package_description": { "type": "string", "minLength": 1, "description": "Package description from item settings" } }, "required": [ "item", "package_description", "planned_time", "treatment_plan", "unit" ] }, "TreatmentPlanSupplyUpdatePartial": { "type": "object", "description": "Use namespaced fields.", "properties": { "quantity": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "usage_size": { "allOf": [ { "$ref": "#/components/schemas/UsageSizeEnum" } ], "minimum": -32768, "maximum": 32767 } } }, "Triage": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "consultation": { "type": "string", "format": "uri" }, "category": { "type": "string", "format": "uri", "nullable": true }, "active": { "type": "boolean" }, "entries": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "consultation", "entries", "id", "url" ] }, "TriageCategory": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "order": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "code": { "type": "string", "maxLength": 10 }, "name": { "type": "string", "maxLength": 50 }, "background_color": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "text_color": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64" }, "min_time": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "max_time": { "type": "integer", "maximum": 2147483647, "minimum": -2147483648, "nullable": true }, "department": { "type": "string", "format": "uri" }, "archived": { "type": "boolean" } }, "required": [ "code", "department", "id", "name", "order", "url" ] }, "TriageEntry": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "triage": { "type": "string", "format": "uri" }, "user": { "type": "string", "format": "uri" }, "category": { "type": "string", "format": "uri", "nullable": true }, "clinical_note": { "type": "string", "format": "uri" }, "patient_status": { "type": "string", "format": "uri" } }, "required": [ "clinical_note", "id", "patient_status", "triage", "url", "user" ] }, "TriggerEnum": { "enum": [ 1, 39, 44, 2, 3, 17, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 38, 19, 20, 21, 22, 23, 24, 25, 31, 26, 29, 27, 30, 28, 32, 33, 34, 35, 36, 41, 42, 43, 37, 40, 45, 46, 47, 52, 53, 48, 49, 50, 55, 51, 54, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68 ], "type": "integer", "description": "* `1` - Client\n* `39` - Client delete\n* `44` - Client communication preference\n* `2` - Patient\n* `3` - Consultation\n* `17` - Consultation waiting discharge\n* `4` - Consultation delete\n* `5` - Consultation item\n* `6` - Diagnostic imaging worklist\n* `7` - Diagnostic imaging worklist update\n* `8` - Diagnostic imaging worklist delete\n* `9` - Invoice\n* `10` - Invoice draft\n* `11` - Invoice payment\n* `12` - Unallocated payment\n* `13` - Insurance claim\n* `14` - Accounting report\n* `15` - Organization item\n* `16` - Laboratory referral\n* `18` - Patient referral\n* `38` - Patient referral feedback sent\n* `19` - SMS sent log\n* `20` - Email sent log\n* `21` - Appointment\n* `22` - Appointment delete\n* `23` - Invoice row delete\n* `24` - Reminder delete\n* `25` - Reminder template delete\n* `31` - Reminder create/modify\n* `26` - Treatment plan\n* `29` - Treatment plan delete\n* `27` - Treatment plan item\n* `30` - Treatment plan item delete\n* `28` - User\n* `32` - Organization medicine\n* `33` - Organization supply\n* `34` - Organization food\n* `35` - Organization procedure\n* `36` - Organization laboratory analysis\n* `41` - Appointment reminder create\n* `42` - Appointment reminder update\n* `43` - Appointment reminder delete\n* `37` - Organization laboratory analysis panel\n* `40` - Notes & Communication\n* `45` - Consultation finalized\n* `46` - Stock order\n* `47` - Stock order delete\n* `52` - Stock order item\n* `53` - Stock order item delete\n* `48` - Stock item entry\n* `49` - Stock item entry delete\n* `50` - Cabinet item use\n* `55` - Cabinet item cancel use\n* `51` - Organization cabinet item\n* `54` - Health plan status update\n* `56` - Home delivery order created\n* `57` - Home delivery item updated\n* `58` - Home delivery item replaced\n* `59` - External SMS\n* `60` - Invoice, extra fee rows can be added to the invoice after finalization\n* `61` - Reason group\n* `62` - Reason\n* `63` - Department settings\n* `64` - Organization settings\n* `65` - Phone number\n* `66` - Cash register\n* `67` - Cash book entry\n* `68` - Z report" }, "TriggerTypeEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Preemptive\n* `2` - Informative" }, "Type2a8Enum": { "enum": [ 1, 0, 2, 3, 4, 5 ], "type": "integer", "description": "* `1` - Outpatient\n* `0` - Inpatient\n* `2` - Home call\n* `3` - Farm visit\n* `4` - Boarding\n* `5` - Pet service" }, "Type89eEnum": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "* `0` - Clinical note template\n* `1` - Discharge note template\n* `2` - Medicine instruction template\n* `3` - Communications template\n* `4` - Preliminary note template\n* `5` - Referral remark template\n* `6` - Laboratory result report template" }, "TypeAe4Enum": { "enum": [ 1, 4, 2, 3, 5, 6, 8, 9 ], "type": "integer", "description": "* `1` - Consultation\n* `4` - Internal booking\n* `2` - Online booking\n* `3` - Other\n* `5` - Unknown client\n* `6` - Farm visit\n* `8` - Boarding\n* `9` - Pet service" }, "TypeB05Enum": { "enum": [ 1, 4, 2, 3, 5, 6, 8, 9, 7 ], "type": "integer", "description": "* `1` - Consultation\n* `4` - Internal booking\n* `2` - Online booking\n* `3` - Other\n* `5` - Unknown client\n* `6` - Farm visit\n* `8` - Boarding\n* `9` - Pet service\n* `7` - Preliminary booking" }, "TypeBdfEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 34, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33 ], "type": "integer", "description": "* `1` - Species\n* `2` - Breed\n* `3` - Diagnosis\n* `4` - Insurance company\n* `5` - Consultation note type\n* `6` - Reporting dimension 1\n* `7` - Reporting dimension 2\n* `34` - Reporting dimension 3\n* `8` - Patient status field 1\n* `9` - Patient status field 2\n* `10` - Patient status field 3\n* `11` - Patient status field 4\n* `12` - Patient status field 5\n* `13` - Patient status field 6\n* `14` - Patient status field 7\n* `15` - Patient status field 8\n* `16` - Patient status field 9\n* `17` - Patient status field 10\n* `18` - Patient status field 11\n* `19` - Patient status field 12\n* `20` - Statement type\n* `21` - Complication report category\n* `22` - Complication report subcategory\n* `23` - Laboratory report 1\n* `24` - Laboratory report 2\n* `25` - Laboratory report 3\n* `26` - Sample type\n* `27` - VetEnvoy insurance company\n* `28` - Medicine reason of use types\n* `29` - Medicine related diagnosis\n* `30` - Referral sending reason\n* `31` - Referral area of expertise\n* `32` - Item entry subtype\n* `33` - Clinical sign" }, "TypeCode095Enum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - SMS\n* `2` - Email\n* `3` - Self check-in SMS\n* `4` - Self check-in email" }, "TypeCode4d9Enum": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "* `1` - Procedure\n* `2` - Medicine\n* `3` - Supply\n* `4` - Food\n* `5` - Laboratory analysis\n* `6` - Laboratory analysis panel" }, "UnallocatedPaymentCreate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "payment_type": { "type": "integer" }, "paid": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "date_added": { "type": "string", "format": "date-time" }, "client": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "refunds": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "external_info": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "appointment": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client", "created", "department", "external_info", "modified", "paid", "payment_type", "url" ] }, "UnallocatedPaymentCreateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "payment_type": { "type": "integer" }, "paid": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "date_added": { "type": "string", "format": "date-time" }, "client": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "refunds": { "type": "string", "format": "uri", "nullable": true }, "appointment": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "client", "department", "paid", "payment_type" ] }, "UnallocatedPaymentDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "payment_type": { "type": "string", "readOnly": true }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "paid": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true, "title": "Amount" }, "date_added": { "type": "string", "format": "date-time" }, "unused_amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "fully_used": { "type": "boolean" }, "client": { "type": "string", "format": "uri", "nullable": true }, "refunds": { "type": "string", "format": "uri", "nullable": true }, "from_invoice": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "payment_method": { "type": "string", "format": "uri", "nullable": true }, "external_info": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "account_number": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "created", "department", "external_info", "modified", "paid", "payment_type", "unused_amount", "url" ] }, "UnallocatedPaymentExternalInfo": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "external_id": { "type": "string", "maxLength": 80 }, "metadata": { "type": "string" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "created", "external_id", "modified", "url" ] }, "UnallocatedPaymentExternalInfoRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "external_id": { "type": "string", "minLength": 1, "maxLength": 80 }, "metadata": { "type": "string" } }, "required": [ "external_id" ] }, "UnallocatedPaymentList": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "description": { "type": "string", "nullable": true, "maxLength": 255 }, "payment_type": { "type": "string", "readOnly": true }, "paid": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "date_added": { "type": "string", "format": "date-time" }, "client": { "type": "string", "format": "uri" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "refunds": { "type": "string", "format": "uri", "nullable": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "external_info": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "appointment": { "type": "string", "format": "uri", "nullable": true }, "unused_amount": { "type": "number", "format": "double", "maximum": 1000000000000000, "minimum": -1000000000000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "fully_used": { "type": "boolean" } }, "required": [ "client", "created", "department", "external_info", "modified", "paid", "payment_type", "unused_amount", "url" ] }, "UnitDescriptionEnum": { "enum": [ "st", "gr", "kg", "ml", "lt" ], "type": "string", "description": "* `st` - pieces\n* `gr` - grams\n* `kg` - kilograms\n* `ml` - millilitres\n* `lt` - litres" }, "Upload": { "type": "object", "description": "Serializes Upload objects to a format expected by .forms.widgets.DropzoneWidget and\ndropzone.js.\n\nProvides two URL fields:\n- url: Preview URL (Office viewer for Office files when flag enabled, video preview, etc.)\n- file_url: Always direct download URL\n\nUsed by both DropzoneWidget (edit modal) and DropzonePreviewWidget (view modal).", "properties": { "name": { "type": "string" }, "size": { "type": "integer", "maximum": 9223372036854775807, "minimum": -9223372036854775808, "format": "int64" }, "url": { "type": "string", "format": "uri", "readOnly": true }, "file_url": { "type": "string", "format": "uri", "readOnly": true }, "thumbnail_url": { "type": "string", "format": "uri" }, "delete_url": { "type": "string", "readOnly": true } }, "required": [ "delete_url", "file_url", "name", "size", "thumbnail_url", "url" ] }, "UploadUrlsRequest": { "type": "object", "properties": { "document_type": { "$ref": "#/components/schemas/DocumentTypeEnum" }, "object_id": { "type": "integer", "minimum": 1 }, "filenames": { "type": "string" } }, "required": [ "document_type", "filenames", "object_id" ] }, "UsageSizeEnum": { "enum": [ 1, 2 ], "type": "integer", "description": "* `1` - Package\n* `2` - Units" }, "UsageTypeEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Administered\n* `2` - Dispensed\n* `3` - Prescribed\n* `4` - Home delivery" }, "User": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "email": { "type": "string", "format": "email", "description": "The email address is used to log in to Provet. This address may also be used in communication features of the system such as emailing and insurance claims. It is recommended to use a company-provided email instead of a personal email.", "maxLength": 100 }, "first_name": { "type": "string", "maxLength": 100 }, "last_name": { "type": "string", "maxLength": 100 }, "is_active": { "type": "boolean", "description": "User can log in and is billable." }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "last_login": { "type": "string", "format": "date-time", "nullable": true }, "user_details": { "type": "string", "format": "uri" }, "is_staff": { "type": "string", "readOnly": true }, "groups": { "type": "array", "items": { "type": "string", "format": "uri" }, "description": "The groups this user belongs to. A user will get all permissions granted to each of their groups." } }, "required": [ "created", "email", "id", "is_staff", "modified", "url", "user_details" ] }, "UserDepartmentPermission": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "department": { "type": "string", "format": "uri" }, "permission_group": { "type": "string", "format": "uri" } }, "required": [ "department", "id", "permission_group" ] }, "UserDepartmentPermissionRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "permission_group": { "type": "string", "format": "uri" } }, "required": [ "department", "permission_group" ] }, "UserDetails": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "user": { "type": "string", "format": "uri" }, "title": { "type": "string", "nullable": true, "maxLength": 255 }, "phone": { "type": "string", "maxLength": 30 }, "id_number": { "type": "string", "nullable": true, "maxLength": 63 }, "veterinarian_id": { "type": "string", "nullable": true, "maxLength": 13 }, "active_department": { "type": "string", "format": "uri" }, "initials": { "type": "string", "maxLength": 10 }, "language": { "type": "string", "nullable": true, "maxLength": 20 }, "user_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UserTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "areas_of_expertise": { "type": "string", "maxLength": 511 }, "qualifications": { "type": "string", "maxLength": 255 }, "picture": { "type": "string", "format": "uri", "nullable": true }, "prescriber_id": { "type": "string", "nullable": true, "maxLength": 13 }, "employee_number": { "type": "string", "nullable": true, "maxLength": 63 }, "vds_number": { "type": "string", "nullable": true, "maxLength": 15 }, "all_departments_active": { "type": "boolean" }, "active_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "active_department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "home_department": { "type": "string", "format": "uri", "nullable": true }, "is_cabinet_user": { "type": "boolean" }, "verification": { "type": "string", "format": "uri", "nullable": true }, "virtual_user": { "type": "boolean" }, "is_locum": { "type": "boolean" }, "province": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. ES-B, ES-M).", "maxLength": 100 }, "no_scheduling_outside_shifts": { "type": "boolean" }, "onlinebooking_vet_display_name": { "type": "string", "readOnly": true } }, "required": [ "active_department", "active_departments", "id", "initials", "onlinebooking_vet_display_name", "url", "user" ] }, "UserDetailsRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "user": { "type": "string", "format": "uri" }, "title": { "type": "string", "nullable": true, "maxLength": 255 }, "phone": { "type": "string", "maxLength": 30 }, "id_number": { "type": "string", "nullable": true, "maxLength": 63 }, "veterinarian_id": { "type": "string", "nullable": true, "maxLength": 13 }, "active_department": { "type": "string", "format": "uri" }, "initials": { "type": "string", "minLength": 1, "maxLength": 10 }, "language": { "type": "string", "nullable": true, "maxLength": 20 }, "user_type": { "nullable": true, "minimum": -32768, "maximum": 32767, "oneOf": [ { "$ref": "#/components/schemas/UserTypeEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "areas_of_expertise": { "type": "string", "minLength": 1, "maxLength": 511 }, "qualifications": { "type": "string", "minLength": 1, "maxLength": 255 }, "picture": { "type": "string", "format": "binary", "nullable": true }, "prescriber_id": { "type": "string", "nullable": true, "maxLength": 13 }, "employee_number": { "type": "string", "nullable": true, "maxLength": 63 }, "vds_number": { "type": "string", "nullable": true, "maxLength": 15 }, "all_departments_active": { "type": "boolean" }, "active_departments": { "type": "array", "items": { "type": "string", "format": "uri" } }, "active_department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "home_department": { "type": "string", "format": "uri", "nullable": true }, "is_cabinet_user": { "type": "boolean" }, "verification": { "type": "string", "format": "binary", "nullable": true }, "virtual_user": { "type": "boolean" }, "is_locum": { "type": "boolean" }, "province": { "type": "string", "nullable": true, "description": "ISO 3166-2 country subdivision code (e.g. ES-B, ES-M).", "maxLength": 100 }, "no_scheduling_outside_shifts": { "type": "boolean" } }, "required": [ "active_department", "active_departments", "initials", "user" ] }, "UserDetailsUpdate": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "maxLength": 255 }, "phone": { "type": "string", "maxLength": 30 }, "user_type": { "$ref": "#/components/schemas/UserTypeEnum" }, "veterinarian_id": { "type": "string", "maxLength": 10 }, "expiration": { "type": "string", "format": "date-time", "nullable": true }, "active_department": { "type": "integer" }, "initials": { "type": "string", "maxLength": 10 }, "language": { "$ref": "#/components/schemas/UserDetailsUpdateLanguageEnum" }, "vds_number": { "type": "string", "maxLength": 15 }, "areas_of_expertise": { "type": "string", "default": " " }, "qualifications": { "type": "string", "default": " " }, "all_departments_active": { "type": "boolean" }, "active_departments": { "type": "array", "items": { "type": "integer" } }, "active_department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "home_department": { "type": "integer", "nullable": true }, "prescriber_id": { "type": "string", "nullable": true, "maxLength": 13 }, "is_cabinet_user": { "type": "boolean" }, "is_locum": { "type": "boolean" }, "employee_number": { "type": "string", "nullable": true, "maxLength": 63 } }, "required": [ "active_department", "initials", "language", "user_type" ] }, "UserDetailsUpdateLanguageEnum": { "enum": [ "en", "en-gb", "en-us", "ca", "zh-cn", "cs", "da", "nl", "et", "fi", "fr", "de", "he", "hu", "is", "it", "lv", "lt", "nb", "pl", "pt", "ro", "ru", "es", "sv", "th", "bg" ], "type": "string", "description": "* `en` - English (Generic)\n* `en-gb` - English (UK)\n* `en-us` - English (US)\n* `ca` - Catalan\n* `zh-cn` - Chinese\n* `cs` - Czech\n* `da` - Danish\n* `nl` - Dutch\n* `et` - Estonian\n* `fi` - Finnish\n* `fr` - French\n* `de` - German\n* `he` - Hebrew\n* `hu` - Hungarian\n* `is` - Icelandic\n* `it` - Italian\n* `lv` - Latvian\n* `lt` - Lithuanian\n* `nb` - Norwegian\n* `pl` - Polish\n* `pt` - Portuguese\n* `ro` - Romanian\n* `ru` - Russian\n* `es` - Spanish\n* `sv` - Swedish\n* `th` - Thai\n* `bg` - Bulgarian" }, "UserDetailsUpdateRequest": { "type": "object", "properties": { "title": { "type": "string", "nullable": true, "maxLength": 255 }, "phone": { "type": "string", "maxLength": 30 }, "user_type": { "$ref": "#/components/schemas/UserTypeEnum" }, "veterinarian_id": { "type": "string", "minLength": 1, "maxLength": 10 }, "expiration": { "type": "string", "format": "date-time", "nullable": true }, "active_department": { "type": "integer" }, "initials": { "type": "string", "minLength": 1, "maxLength": 10 }, "language": { "$ref": "#/components/schemas/UserDetailsUpdateLanguageEnum" }, "vds_number": { "type": "string", "minLength": 1, "maxLength": 15 }, "areas_of_expertise": { "type": "string", "minLength": 1, "default": " " }, "qualifications": { "type": "string", "minLength": 1, "default": " " }, "all_departments_active": { "type": "boolean" }, "active_departments": { "type": "array", "items": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "uri" } ] } }, "active_department_groups": { "type": "array", "items": { "type": "string", "format": "uri" } }, "home_department": { "type": "integer", "nullable": true }, "prescriber_id": { "type": "string", "nullable": true, "maxLength": 13 }, "is_cabinet_user": { "type": "boolean" }, "is_locum": { "type": "boolean" }, "employee_number": { "type": "string", "nullable": true, "maxLength": 63 } }, "required": [ "active_department", "initials", "language", "user_type" ] }, "UserScheduling": { "type": "object", "description": "Serializer for the UserScheduling model (more commonly known as shift).", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "department": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri", "nullable": true }, "team": { "type": "string", "format": "uri", "nullable": true }, "shift_type": { "type": "string", "format": "uri" }, "web": { "type": "boolean" }, "note": { "type": "string", "nullable": true }, "is_slot": { "type": "boolean" }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "department", "end", "id", "shift_type", "start", "url" ] }, "UserSchedulingRequest": { "type": "object", "description": "Serializer for the UserScheduling model (more commonly known as shift).", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true }, "user": { "type": "string", "format": "uri", "nullable": true }, "employee_number": { "type": "string", "writeOnly": true, "minLength": 1 }, "department": { "type": "string", "format": "uri" }, "ward": { "type": "string", "format": "uri", "nullable": true }, "team": { "type": "string", "format": "uri", "nullable": true }, "shift_type": { "type": "string", "format": "uri" }, "web": { "type": "boolean" }, "note": { "type": "string", "nullable": true }, "is_slot": { "type": "boolean" }, "resources": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "department", "end", "shift_type", "start" ] }, "UserTypeEnum": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "* `1` - Veterinarian\n* `2` - Support staff\n* `3` - Administrative\n* `4` - Technical" }, "UserUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "email": { "type": "string", "format": "email", "description": "The email address is used to log in to Provet. This address may also be used in communication features of the system such as emailing and insurance claims. It is recommended to use a company-provided email instead of a personal email.", "maxLength": 100 }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "is_active": { "type": "boolean", "description": "User can log in and is billable." }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "last_login": { "type": "string", "format": "date-time", "nullable": true }, "user_details": { "$ref": "#/components/schemas/UserDetailsUpdate" }, "is_staff": { "type": "string", "readOnly": true }, "groups": { "type": "string", "format": "uri" } }, "required": [ "created", "email", "first_name", "groups", "id", "is_staff", "last_name", "url", "user_details" ] }, "UserUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "email": { "type": "string", "format": "email", "minLength": 1, "description": "The email address is used to log in to Provet. This address may also be used in communication features of the system such as emailing and insurance claims. It is recommended to use a company-provided email instead of a personal email.", "maxLength": 100 }, "first_name": { "type": "string", "minLength": 1 }, "last_name": { "type": "string", "minLength": 1 }, "is_active": { "type": "boolean", "description": "User can log in and is billable." }, "last_login": { "type": "string", "format": "date-time", "nullable": true }, "user_details": { "$ref": "#/components/schemas/UserDetailsUpdateRequest" }, "groups": { "type": "string", "format": "uri" } }, "required": [ "email", "first_name", "groups", "last_name", "user_details" ] }, "UserViewHistory": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "last_viewed": { "type": "string", "format": "date-time", "readOnly": true }, "details": { "type": "string", "readOnly": true } }, "required": [ "details", "id", "last_viewed" ] }, "VaccinationTypeEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "description": "* `1` - Killed vaccine\n* `2` - Modified live virus (MLV)\n* `3` - Recombinant vaccine\n* `4` - Subunit vaccine\n* `5` - Toxoid vaccine\n* `6` - Vector vaccine\n* `7` - DNA vaccine\n* `8` - RNA vaccine" }, "VatCalculationMethodEnum": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "* `1` - Single item\n* `2` - Single invoice row\n* `3` - Invoice total sum" }, "VatGroup": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "title": { "type": "string", "maxLength": 255 }, "percentage": { "type": "number", "format": "double", "maximum": 1000, "minimum": -1000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "archived": { "type": "boolean" }, "account_number": { "type": "string" }, "departments": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "url" ] }, "VetsAvailability": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "minimum": 1 }, "department_id": { "type": "integer" }, "available_to": { "type": "string", "format": "date-time" }, "treating_employees": { "type": "string", "default": "" }, "user_types": { "type": "string", "default": "" }, "reason": { "type": "integer", "nullable": true }, "show_extra": { "type": "boolean", "default": false } }, "required": [ "department_id", "duration", "end", "start" ] }, "Ward": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "maxLength": 255 }, "code": { "type": "string", "maxLength": 31 }, "is_active": { "type": "boolean" }, "is_shared": { "type": "string", "readOnly": true } }, "required": [ "code", "id", "is_shared", "name", "url" ] }, "WardRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "code": { "type": "string", "minLength": 1, "maxLength": 31 }, "is_active": { "type": "boolean" } }, "required": [ "code", "name" ] }, "Webhook": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "trigger": { "allOf": [ { "$ref": "#/components/schemas/TriggerEnum" } ], "minimum": 0, "maximum": 65535 }, "name": { "type": "string", "nullable": true, "maxLength": 255 }, "url": { "type": "string", "maxLength": 255 }, "active": { "type": "boolean" }, "department": { "type": "string", "format": "uri", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ContentTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "filters": { "type": "object", "nullable": true, "description": "Optional per-webhook delivery filters ({key: true}). The event is delivered only if every enabled filter passes. Each key is only valid for specific triggers. Switching on a key this organization cannot use is rejected; a key the webhook already stores but cannot switch on is the exception, so a response can be sent back unchanged, and such a key is dropped rather than stored when the new trigger does not accept it.", "example": { "client_has_active_health_plan": true }, "properties": { "client_has_active_health_plan": { "type": "boolean", "description": "Only clients with an active health plan" }, "invoice_payment_on_health_plan_invoice": { "type": "boolean", "description": "Only payments on health plan invoices" }, "invoice_payment_without_external_id": { "type": "boolean", "description": "Only payments without an external ID (usually taken in the clinic)" }, "patient_has_active_health_plan": { "type": "boolean", "description": "Only patients with an active health plan" } }, "additionalProperties": { "type": "boolean" } } }, "required": [ "id", "trigger", "url" ] }, "WebhookRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "trigger": { "allOf": [ { "$ref": "#/components/schemas/TriggerEnum" } ], "minimum": 0, "maximum": 65535 }, "name": { "type": "string", "nullable": true, "maxLength": 255 }, "url": { "type": "string", "minLength": 1, "maxLength": 255 }, "active": { "type": "boolean" }, "department": { "type": "string", "format": "uri", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ContentTypeEnum" } ], "minimum": 0, "maximum": 65535 }, "filters": { "type": "object", "nullable": true, "description": "Optional per-webhook delivery filters ({key: true}). The event is delivered only if every enabled filter passes. Each key is only valid for specific triggers. Switching on a key this organization cannot use is rejected; a key the webhook already stores but cannot switch on is the exception, so a response can be sent back unchanged, and such a key is dropped rather than stored when the new trigger does not accept it.", "example": { "client_has_active_health_plan": true }, "properties": { "client_has_active_health_plan": { "type": "boolean", "description": "Only clients with an active health plan" }, "invoice_payment_on_health_plan_invoice": { "type": "boolean", "description": "Only payments on health plan invoices" }, "invoice_payment_without_external_id": { "type": "boolean", "description": "Only payments without an external ID (usually taken in the clinic)" }, "patient_has_active_health_plan": { "type": "boolean", "description": "Only patients with an active health plan" } }, "additionalProperties": { "type": "boolean" } } }, "required": [ "trigger", "url" ] }, "WeekdaysEnum": { "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "* `1` - Monday\n* `2` - Tuesday\n* `3` - Wednesday\n* `4` - Thursday\n* `5` - Friday\n* `6` - Saturday\n* `7` - Sunday" }, "Weight": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "weight": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "timestamp": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "units": { "type": "string", "readOnly": true } }, "required": [ "created", "id", "modified", "timestamp", "units", "weight" ] }, "WeightRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "weight": { "type": "number", "format": "double", "maximum": 10000000, "minimum": -10000000, "exclusiveMaximum": true, "exclusiveMinimum": true }, "timestamp": { "type": "string", "format": "date-time" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true } }, "required": [ "timestamp", "weight" ] }, "Wholesaler": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "wholesaler_type": { "type": "integer" }, "wholesaler_type_display": { "type": "string", "readOnly": true }, "name": { "type": "string", "maxLength": 63 }, "name_postfix": { "type": "string", "nullable": true }, "customer_number": { "type": "string", "nullable": true, "maxLength": 63 }, "department_info": { "allOf": [ { "$ref": "#/components/schemas/WholesalerDepartmentInfoWrite" } ], "nullable": true }, "vat_number": { "type": "string", "maxLength": 31 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "title": "Secondary street address", "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "order_gateway_supplier_id": { "type": "integer", "nullable": true }, "order_gateway_name": { "type": "string", "nullable": true, "maxLength": 255 }, "make_department_specific": { "type": "boolean" }, "has_same_credentials_with_unique_customer_number": { "type": "boolean", "nullable": true }, "archived": { "type": "boolean", "default": false }, "has_ongoing_order": { "type": "string", "readOnly": true } }, "required": [ "has_ongoing_order", "id", "name", "url", "wholesaler_type_display" ] }, "WholesalerCatalogContentTypeEnum": { "enum": [ "text/csv", "application/csv" ], "type": "string", "description": "* `text/csv` - text/csv\n* `application/csv` - application/csv" }, "WholesalerCatalogUploadRequestRequest": { "type": "object", "properties": { "filename": { "type": "string", "minLength": 1 }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/WholesalerCatalogContentTypeEnum" } ], "default": "text/csv", "description": "Content type the upload will declare. The presigned POST pins this exact value, so the upload must send a matching Content-Type form field or S3 rejects it with 403.\n\n* `text/csv` - text/csv\n* `application/csv` - application/csv" } }, "required": [ "filename" ] }, "WholesalerCatalogUploadResponse": { "type": "object", "properties": { "upload_id": { "type": "integer" }, "catalog_id": { "type": "string", "format": "uuid" }, "filename": { "type": "string" }, "s3_key": { "type": "string" }, "url": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "string" } }, "expected_columns": { "type": "array", "items": { "type": "string" } }, "content_type": { "type": "string", "description": "Content type pinned in the presigned POST policy. Submit this exact value as the Content-Type form field of the upload." }, "max_size_bytes": { "type": "integer", "description": "Largest upload the presigned POST policy accepts, in bytes. S3 rejects anything smaller than 1 byte or larger than this value." } }, "required": [ "catalog_id", "content_type", "expected_columns", "fields", "filename", "max_size_bytes", "s3_key", "upload_id", "url" ] }, "WholesalerCreatedAvailableWholesaler": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of your registered `AvailableWholesaler`." }, "name": { "type": "string", "description": "Name of that `AvailableWholesaler`." }, "email": { "type": "string", "nullable": true, "description": "Contact email registered for the `AvailableWholesaler`." }, "register_number": { "type": "string", "nullable": true, "description": "Business / registration number of the `AvailableWholesaler`." } }, "required": [ "email", "id", "name", "register_number" ] }, "WholesalerCreatedDepartment": { "type": "object", "properties": { "id": { "type": "integer", "description": "Department / clinic location ID." }, "name": { "type": "string", "description": "Department / clinic location name." } }, "required": [ "id", "name" ] }, "WholesalerCreatedEvent": { "type": "object", "description": "A clinic linked one of your `AvailableWholesaler` registrations, creating\nthe per-clinic `Wholesaler` this event describes.", "properties": { "event": { "type": "string", "enum": [ "wholesaler.created" ], "description": "Always `\"wholesaler.created\"`." }, "event_id": { "type": "string", "format": "uuid", "description": "Identifies this event, unchanged across all delivery attempts of it. Use it to discard redundant deliveries." }, "available_wholesaler": { "$ref": "#/components/schemas/WholesalerCreatedAvailableWholesaler" }, "wholesaler": { "$ref": "#/components/schemas/WholesalerCreatedWholesaler" } }, "required": [ "available_wholesaler", "event", "event_id", "wholesaler" ] }, "WholesalerCreatedWholesaler": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id to use as `wholesaler_pk` for catalog uploads. It identifies the set of credentials this event carries: a clinic that enters separate credentials per location sends you one event, and one id, per location." }, "customer_number": { "type": "string", "nullable": true, "description": "The clinic's customer number with the wholesaler." }, "customer_username": { "type": "string", "nullable": true, "description": "Login / username the clinic entered for this wholesaler." }, "customer_password": { "type": "string", "nullable": true, "description": "Password the clinic entered, decrypted. **Treat it as a secret.**" }, "department": { "allOf": [ { "$ref": "#/components/schemas/WholesalerCreatedDepartment" } ], "nullable": true, "description": "Set when the credentials are specific to one clinic location; `null` when they apply wholesaler-wide." } }, "required": [ "customer_number", "customer_password", "customer_username", "department", "id" ] }, "WholesalerDeletedAvailableWholesaler": { "type": "object", "properties": { "id": { "type": "integer", "description": "ID of your registered `AvailableWholesaler`." }, "name": { "type": "string", "description": "Name of that `AvailableWholesaler`." }, "email": { "type": "string", "nullable": true, "description": "Contact email registered for the `AvailableWholesaler`." }, "register_number": { "type": "string", "nullable": true, "description": "Business / registration number of the `AvailableWholesaler`." } }, "required": [ "email", "id", "name", "register_number" ] }, "WholesalerDeletedEvent": { "type": "object", "description": "A clinic removed the per-clinic `Wholesaler` it had created from one of\nyour `AvailableWholesaler` registrations.", "properties": { "event": { "type": "string", "enum": [ "wholesaler.deleted" ], "description": "Always `\"wholesaler.deleted\"`." }, "event_id": { "type": "string", "format": "uuid", "description": "Identifies this event, unchanged across all delivery attempts of it. Use it to discard redundant deliveries." }, "available_wholesaler": { "$ref": "#/components/schemas/WholesalerDeletedAvailableWholesaler" }, "wholesaler": { "$ref": "#/components/schemas/WholesalerDeletedWholesaler" } }, "required": [ "available_wholesaler", "event", "event_id", "wholesaler" ] }, "WholesalerDeletedWholesaler": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the credential set that was removed — the same one `wholesaler.created` gave you for it." } }, "required": [ "id" ] }, "WholesalerDepartmentInfo": { "type": "object", "description": "Use namespaced fields.", "properties": { "department": { "type": "string", "format": "uri" }, "order_gateway_name": { "type": "string", "nullable": true, "maxLength": 255 }, "customer_number": { "type": "string", "nullable": true, "maxLength": 63 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 } }, "required": [ "department" ] }, "WholesalerDepartmentInfoWrite": { "type": "object", "properties": { "order_gateway_name": { "type": "string", "nullable": true, "maxLength": 255 }, "order_gateway_password": { "type": "string", "nullable": true, "maxLength": 255 }, "customer_number": { "type": "string", "nullable": true, "maxLength": 63 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 } } }, "WholesalerDepartmentInfoWriteRequest": { "type": "object", "properties": { "order_gateway_name": { "type": "string", "nullable": true, "maxLength": 255 }, "order_gateway_password": { "type": "string", "nullable": true, "maxLength": 255 }, "customer_number": { "type": "string", "nullable": true, "maxLength": 63 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 } } }, "WholesalerReceiptLineRequest": { "type": "object", "description": "One product on one delivery: what was sent, how much, and optionally which\norder it belongs to. A line carrying neither a product number nor a barcode, or\na quantity that will not parse, comes back rejected while the rest are stored.", "properties": { "id": { "type": "string", "minLength": 1, "description": "The partner's own identifier for this line, unique within the wholesaler. Resubmitting it returns the original outcome instead of staging the same goods twice. Opaque to Provet: compose it however you like.", "maxLength": 255 }, "order_id": { "type": "integer", "nullable": true, "description": "Provet order this line delivers against. Omit it and the line is linked by invoice number instead, where that matches an order." }, "invoice_number": { "type": "string", "nullable": true, "maxLength": 63 }, "invoice_date": { "type": "string", "format": "date", "nullable": true, "description": "Calendar date as it appears on the invoice (YYYY-MM-DD). A value carrying a time or a UTC offset is stored as absent rather than converted, since converting an instant can shift the day." }, "product_number": { "type": "string", "nullable": true, "description": "Your product code. Either this or a barcode is required.", "maxLength": 63 }, "product_name": { "type": "string", "nullable": true, "description": "Shown to clinic staff matching an unrecognised line by hand.", "maxLength": 255 }, "barcode": { "type": "string", "nullable": true, "maxLength": 30 }, "quantity": { "type": "number", "format": "double", "maximum": 1000000000, "minimum": 0.0, "exclusiveMaximum": true, "description": "Units sent, in package units matching the order. Zero is valid and says the order was seen but nothing has shipped yet; a negative quantity is not, since a receipt records what left the warehouse." }, "batch_number": { "type": "string", "nullable": true, "maxLength": 63 }, "expiry_date": { "type": "string", "format": "date", "nullable": true, "description": "Calendar date from the packaging (YYYY-MM-DD)." } }, "required": [ "id", "quantity" ] }, "WholesalerReceiptLineResult": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "description": "The line id you submitted, echoed back." }, "status": { "allOf": [ { "$ref": "#/components/schemas/WholesalerReceiptLineResultStatusEnum" } ], "description": "``duplicate`` means this line id was already submitted: nothing new was created and the original outcome is returned.\n\n* `accepted` - accepted\n* `rejected` - rejected\n* `duplicate` - duplicate" }, "order_id": { "type": "integer", "nullable": true, "description": "The order the line was linked to, which is not always the one submitted: a line with no order_id can still resolve by invoice number." }, "matched_item": { "type": "boolean", "description": "Whether the line resolved to a product. An unmatched line is still stored for clinic staff to match by hand." }, "matched_by": { "nullable": true, "description": "Which identifier resolved the product, if either did.\n\n* `product_code` - product_code\n* `barcode` - barcode", "oneOf": [ { "$ref": "#/components/schemas/MatchedByEnum" }, { "$ref": "#/components/schemas/NullEnum" } ] }, "reason": { "type": "string", "description": "Present only on a rejected line." } }, "required": [ "id", "matched_by", "matched_item", "order_id", "status" ] }, "WholesalerReceiptLineResultStatusEnum": { "enum": [ "accepted", "rejected", "duplicate" ], "type": "string", "description": "* `accepted` - accepted\n* `rejected` - rejected\n* `duplicate` - duplicate" }, "WholesalerReceiptsRequestRequest": { "type": "object", "properties": { "receipt_lines": { "type": "array", "items": { "$ref": "#/components/schemas/WholesalerReceiptLineRequest" }, "description": "A flat list of lines with no receipt header: one document can span several orders, so each line stands alone. At most 500 per call.", "maxItems": 500 } }, "required": [ "receipt_lines" ] }, "WholesalerReceiptsResponse": { "type": "object", "properties": { "lines_total": { "type": "integer" }, "lines_accepted": { "type": "integer" }, "lines_rejected": { "type": "integer" }, "lines_duplicate": { "type": "integer" }, "receipt_lines": { "type": "array", "items": { "$ref": "#/components/schemas/WholesalerReceiptLineResult" } } }, "required": [ "lines_accepted", "lines_duplicate", "lines_rejected", "lines_total", "receipt_lines" ] }, "WholesalerRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "wholesaler_type": { "type": "integer" }, "name": { "type": "string", "minLength": 1, "maxLength": 63 }, "name_postfix": { "type": "string", "nullable": true }, "customer_number": { "type": "string", "nullable": true, "maxLength": 63 }, "department_info": { "allOf": [ { "$ref": "#/components/schemas/WholesalerDepartmentInfoWriteRequest" } ], "nullable": true }, "vat_number": { "type": "string", "maxLength": 31 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "title": "Secondary street address", "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "order_gateway_supplier_id": { "type": "integer", "nullable": true }, "order_gateway_name": { "type": "string", "nullable": true, "maxLength": 255 }, "order_gateway_password": { "type": "string", "writeOnly": true, "nullable": true, "maxLength": 255 }, "make_department_specific": { "type": "boolean" }, "has_same_credentials_with_unique_customer_number": { "type": "boolean", "nullable": true }, "archived": { "type": "boolean", "default": false }, "available_wholesaler_id": { "type": "integer", "writeOnly": true, "nullable": true } }, "required": [ "name" ] }, "WholesalerResponse": { "type": "object", "description": "Documents the actual response shape of ``department_info`` (a list of all\ndepartment overrides) for drf-spectacular, since ``WholesalerSerializer``\ndeclares it as a single write-only object for input parsing.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "wholesaler_type": { "type": "integer" }, "wholesaler_type_display": { "type": "string", "readOnly": true }, "name": { "type": "string", "maxLength": 63 }, "name_postfix": { "type": "string", "nullable": true }, "customer_number": { "type": "string", "nullable": true, "maxLength": 63 }, "department_info": { "type": "array", "items": { "$ref": "#/components/schemas/WholesalerDepartmentInfo" }, "readOnly": true }, "vat_number": { "type": "string", "maxLength": 31 }, "register_number": { "type": "string", "nullable": true, "maxLength": 31 }, "street_address": { "type": "string", "maxLength": 255 }, "street_address_2": { "type": "string", "nullable": true, "title": "Secondary street address", "maxLength": 255 }, "zip_code": { "type": "string", "maxLength": 12 }, "city": { "type": "string", "maxLength": 63 }, "email": { "type": "string", "format": "email", "nullable": true, "maxLength": 254 }, "phone_number": { "type": "string", "nullable": true, "maxLength": 31 }, "notes": { "type": "string", "nullable": true, "maxLength": 1000 }, "order_gateway_supplier_id": { "type": "integer", "nullable": true }, "order_gateway_name": { "type": "string", "nullable": true, "maxLength": 255 }, "make_department_specific": { "type": "boolean" }, "has_same_credentials_with_unique_customer_number": { "type": "boolean", "nullable": true }, "archived": { "type": "boolean", "default": false }, "has_ongoing_order": { "type": "string", "readOnly": true } }, "required": [ "department_info", "has_ongoing_order", "id", "name", "url", "wholesaler_type_display" ] }, "WholesalerUpdatedEvent": { "type": "object", "description": "A clinic changed the credentials or clinic location of a `Wholesaler`\ncreated from one of your `AvailableWholesaler` registrations.", "properties": { "event": { "type": "string", "enum": [ "wholesaler.updated" ], "description": "Always `\"wholesaler.updated\"`." }, "event_id": { "type": "string", "format": "uuid", "description": "Identifies this event, unchanged across all delivery attempts of it. Use it to discard redundant deliveries." }, "available_wholesaler": { "$ref": "#/components/schemas/WholesalerCreatedAvailableWholesaler" }, "wholesaler": { "$ref": "#/components/schemas/WholesalerCreatedWholesaler" } }, "required": [ "available_wholesaler", "event", "event_id", "wholesaler" ] }, "WrittenPrescription": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "client": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "issue_time": { "type": "string", "format": "date-time" }, "valid_months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "valid_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "controlled": { "type": "boolean" }, "microbial": { "type": "boolean" }, "diagnosis": { "type": "string", "nullable": true, "maxLength": 63 }, "printed_time": { "type": "string", "format": "date-time", "nullable": true }, "archived": { "type": "boolean" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "pharmacy": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "prescriber": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "diagnosis_type": { "type": "string", "format": "uri", "readOnly": true }, "diagnosis_reason_type": { "type": "string", "format": "uri", "readOnly": true }, "printed_user": { "type": "string", "format": "uri", "nullable": true }, "written_prescription_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true } }, "required": [ "client", "created", "department", "diagnosis_reason_type", "diagnosis_type", "id", "modified", "patient", "prescriber", "url", "written_prescription_extras" ] }, "WrittenPrescriptionDetail": { "type": "object", "description": "Use namespaced fields.", "properties": { "id": { "type": "integer", "readOnly": true }, "url": { "type": "string", "format": "uri", "readOnly": true }, "created": { "type": "string", "format": "date-time", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "readOnly": true }, "client": { "type": "string", "format": "uri" }, "patient": { "type": "string", "format": "uri" }, "issue_time": { "type": "string", "format": "date-time" }, "valid_months": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "valid_days": { "type": "integer", "maximum": 4294967295, "minimum": 0, "format": "int64", "nullable": true }, "controlled": { "type": "boolean" }, "microbial": { "type": "boolean" }, "diagnosis": { "type": "string", "nullable": true, "maxLength": 63 }, "printed_time": { "type": "string", "format": "date-time", "nullable": true }, "archived": { "type": "boolean" }, "created_user": { "type": "string", "format": "uri", "nullable": true }, "modified_user": { "type": "string", "format": "uri", "nullable": true }, "pharmacy": { "type": "string", "format": "uri", "nullable": true }, "consultation": { "type": "string", "format": "uri", "nullable": true }, "prescriber": { "type": "string", "format": "uri" }, "department": { "type": "string", "format": "uri" }, "diagnosis_type": { "type": "string", "format": "uri", "readOnly": true }, "diagnosis_reason_type": { "type": "string", "format": "uri", "readOnly": true }, "printed_user": { "type": "string", "format": "uri", "nullable": true }, "written_prescription_extras": { "allOf": [ { "$ref": "#/components/schemas/Nested" } ], "readOnly": true }, "items": { "type": "array", "items": { "type": "string", "format": "uri" } } }, "required": [ "client", "created", "department", "diagnosis_reason_type", "diagnosis_type", "id", "items", "modified", "patient", "prescriber", "url", "written_prescription_extras" ] }, "WrittenPrescriptionExtras": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "external_sent_data": { "nullable": true }, "external_sent_label": { "type": "string", "nullable": true, "maxLength": 255 }, "external_system": { "type": "string", "maxLength": 25 }, "readonly": { "type": "boolean" }, "written_prescription": { "type": "string", "format": "uri" } }, "required": [ "url", "written_prescription" ] }, "WrittenPrescriptionExtrasCreateUpdate": { "type": "object", "description": "Use namespaced fields.", "properties": { "url": { "type": "string", "format": "uri", "readOnly": true }, "written_prescription": { "type": "string", "format": "uri" }, "external_system": { "type": "string" }, "external_sent_data": { "type": "string" }, "external_sent_label": { "type": "string", "nullable": true, "maxLength": 255 }, "readonly": { "type": "boolean" } }, "required": [ "external_system", "url", "written_prescription" ] }, "WrittenPrescriptionExtrasCreateUpdateRequest": { "type": "object", "description": "Use namespaced fields.", "properties": { "written_prescription": { "type": "string", "format": "uri" }, "external_system": { "type": "string", "minLength": 1 }, "external_sent_data": { "type": "string" }, "external_sent_label": { "type": "string", "nullable": true, "maxLength": 255 }, "readonly": { "type": "boolean" } }, "required": [ "external_system", "written_prescription" ] }, "link": { "oneOf": [ { "type": "string", "format": "uri-reference", "description": "a string containing the link's URL" }, { "type": "object", "required": [ "href" ], "properties": { "href": { "type": "string", "format": "uri-reference", "description": "a string containing the link's URL" }, "meta": { "type": "object", "additionalProperties": true } } } ] }, "failure": { "type": "object", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "meta": { "type": "object", "additionalProperties": true }, "jsonapi": { "type": "object", "additionalProperties": true }, "links": { "type": "object", "additionalProperties": true } } } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "/{provet_id}/oauth2/token/", "scopes": { "restapi": "Read and write access to Provet information", "openid": "Read personal information (name, email address)", "internal_migration": "Internal data migration tooling", "export_clients": "Bulk export of client identity data through the API", "wholesaler": "Access to wholesaler integration endpoints", "card_tokenization": "Tokenize and select payment cards in embedded card sessions" } } } } } }, "servers": [ { "url": "https://{domain}/{provet_id}/api/0.1", "description": "Provet REST API", "variables": { "domain": { "default": "provetcloud.com", "description": "Region-specific domain." }, "provet_id": { "default": "1", "description": "Organization ID" } } } ], "webhooks": { "wholesaler.created": { "post": { "description": "Sent when a clinic links one of your `AvailableWholesaler` registrations and\nfor every further set of credentials it enters for it. Use the `wholesaler.id`\nas the `wholesaler_pk` for catalog uploads and to correlate incoming orders; a\nclinic with location-specific credentials sends you one event, and one id, per\nlocation. Fields the clinic left blank are sent as `null`.\n\n### Delivery\n\nSent as a `POST` to the `webhook_callback_url` of the `AvailableWholesaler`\nthe event belongs to. Every delivery carries:\n\n- `X-Webhook-Signature` — `v1=`, an HMAC-SHA256 of\n `.` keyed with the `verification_salt` you registered.\n Verify it against the raw body, before parsing.\n- `X-Webhook-Timestamp` — the Unix timestamp covered by that signature.\n- `X-Webhook-Event-Id` — mirrors the body's `event_id`.\n- `X-Tenant-ID` — the id of the clinic the event concerns, the same one\n in that clinic's API base URL.\n- `X-Tenant-Core` — the platform hosting it, e.g. `eu` or `us`.\n\nThe two tenant headers let one `webhook_callback_url` serve every clinic and\nplatform you integrate with. They sit outside the signature, so route on them\nbut take the event's data from the signed body.\n\nAnswer `2xx` once you have accepted the delivery. Anything else, or a timeout,\nis retried with exponential backoff; retries repeat the same `event_id`, so\ndeduplicate on it.\n", "summary": "A clinic connected your wholesaler", "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerCreatedEvent" } } }, "required": true }, "responses": { "200": { "description": "Delivery accepted." } } } }, "wholesaler.updated": { "post": { "description": "Sent when a clinic edits the credentials, or the clinic location, of a\n`Wholesaler` created from one of your `AvailableWholesaler` registrations. The\nbody repeats the `wholesaler.created` shape carrying the new values, so one\nhandler can serve both events — replace what you hold for this `wholesaler.id`.\n\nOnly a real change is delivered: editing a wholesaler's name or address sends\nnothing, and a clinic location entering its own credentials for the first time\narrives as `wholesaler.created` for that new id rather than as an update.\nCredentials are reported as the editing clinic location sees them, so an edit\nto a location-specific override carries `wholesaler.department`.\n\nOne edit can update several ids. Clinic locations sharing a username share one\naccount with you, so their password is kept identical: changing it for one\nchanges it for all of them, and you receive one event per affected\n`wholesaler.id`. Apply each to the id it names rather than assuming an edit\nconcerns only one account.\n\n### Delivery\n\nSent as a `POST` to the `webhook_callback_url` of the `AvailableWholesaler`\nthe event belongs to. Every delivery carries:\n\n- `X-Webhook-Signature` — `v1=`, an HMAC-SHA256 of\n `.` keyed with the `verification_salt` you registered.\n Verify it against the raw body, before parsing.\n- `X-Webhook-Timestamp` — the Unix timestamp covered by that signature.\n- `X-Webhook-Event-Id` — mirrors the body's `event_id`.\n- `X-Tenant-ID` — the id of the clinic the event concerns, the same one\n in that clinic's API base URL.\n- `X-Tenant-Core` — the platform hosting it, e.g. `eu` or `us`.\n\nThe two tenant headers let one `webhook_callback_url` serve every clinic and\nplatform you integrate with. They sit outside the signature, so route on them\nbut take the event's data from the signed body.\n\nAnswer `2xx` once you have accepted the delivery. Anything else, or a timeout,\nis retried with exponential backoff; retries repeat the same `event_id`, so\ndeduplicate on it.\n", "summary": "A clinic changed the credentials you were given", "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerUpdatedEvent" } } }, "required": true }, "responses": { "200": { "description": "Delivery accepted." } } } }, "wholesaler.deleted": { "post": { "description": "Sent when a clinic removes a `Wholesaler` it had created from one of your\n`AvailableWholesaler` registrations, and when a single clinic location gives up\nits own credentials while the rest of the clinic keeps ordering. Stop pushing\ncatalogs for that `wholesaler.id`; the clinic keeps its purchase history, so\npast orders remain valid. Removing the whole wholesaler sends you one event,\nand one id, per location — the same set of ids `wholesaler.created` gave you.\n\nNo credentials are sent — they have no bearing on a removal. If the clinic\nconnects again you receive a fresh `wholesaler.created` for each `wholesaler.id`,\nwhich you should treat exactly as a first connection.\n\n### Delivery\n\nSent as a `POST` to the `webhook_callback_url` of the `AvailableWholesaler`\nthe event belongs to. Every delivery carries:\n\n- `X-Webhook-Signature` — `v1=`, an HMAC-SHA256 of\n `.` keyed with the `verification_salt` you registered.\n Verify it against the raw body, before parsing.\n- `X-Webhook-Timestamp` — the Unix timestamp covered by that signature.\n- `X-Webhook-Event-Id` — mirrors the body's `event_id`.\n- `X-Tenant-ID` — the id of the clinic the event concerns, the same one\n in that clinic's API base URL.\n- `X-Tenant-Core` — the platform hosting it, e.g. `eu` or `us`.\n\nThe two tenant headers let one `webhook_callback_url` serve every clinic and\nplatform you integrate with. They sit outside the signature, so route on them\nbut take the event's data from the signed body.\n\nAnswer `2xx` once you have accepted the delivery. Anything else, or a timeout,\nis retried with exponential backoff; retries repeat the same `event_id`, so\ndeduplicate on it.\n", "summary": "A clinic disconnected your wholesaler", "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WholesalerDeletedEvent" } } }, "required": true }, "responses": { "200": { "description": "Delivery accepted." } } } }, "catalog.processed": { "post": { "description": "Sent once a catalog CSV you uploaded has been read and validated, which happens\nwithin moments of the file landing — not when a clinic imports it. It is sent\nfor every completed upload, so read `upload.status` rather than assuming\nsuccess.\n\nRows are judged individually: `partially_accepted` means the good rows are live\nand the rest are reported here. `rejected` means nothing usable came out of the\nfile, and the clinic keeps the catalog it already had.\n\nErrors are all-or-nothing. Up to 100 arrive in `errors`; beyond that `errors` is\n`null` and you get exact per-reason counts in `error_summary` plus a\n`error_report_url` download, never a partial list.\n\n### Delivery\n\nSent as a `POST` to the `webhook_callback_url` of the `AvailableWholesaler`\nthe event belongs to. Every delivery carries:\n\n- `X-Webhook-Signature` — `v1=`, an HMAC-SHA256 of\n `.` keyed with the `verification_salt` you registered.\n Verify it against the raw body, before parsing.\n- `X-Webhook-Timestamp` — the Unix timestamp covered by that signature.\n- `X-Webhook-Event-Id` — mirrors the body's `event_id`.\n- `X-Tenant-ID` — the id of the clinic the event concerns, the same one\n in that clinic's API base URL.\n- `X-Tenant-Core` — the platform hosting it, e.g. `eu` or `us`.\n\nThe two tenant headers let one `webhook_callback_url` serve every clinic and\nplatform you integrate with. They sit outside the signature, so route on them\nbut take the event's data from the signed body.\n\nAnswer `2xx` once you have accepted the delivery. Anything else, or a timeout,\nis retried with exponential backoff; retries repeat the same `event_id`, so\ndeduplicate on it.\n", "summary": "Provet finished validating a catalog you uploaded", "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogProcessedEvent" } } }, "required": true }, "responses": { "200": { "description": "Delivery accepted." } } } }, "order.placed": { "post": { "description": "Sent when clinic staff send a purchase order to a wholesaler created from one\nof your `AvailableWholesaler` registrations. The payload carries the whole\norder, so no follow-up call is needed to act on it.\n\nThe same `order.id` may arrive again under a different `event_id` — the clinic\nmay have amended the order. Compare the new payload against the version you\nhold rather than treating it as a second order.\n\n### Delivery\n\nSent as a `POST` to the `webhook_callback_url` of the `AvailableWholesaler`\nthe event belongs to. Every delivery carries:\n\n- `X-Webhook-Signature` — `v1=`, an HMAC-SHA256 of\n `.` keyed with the `verification_salt` you registered.\n Verify it against the raw body, before parsing.\n- `X-Webhook-Timestamp` — the Unix timestamp covered by that signature.\n- `X-Webhook-Event-Id` — mirrors the body's `event_id`.\n- `X-Tenant-ID` — the id of the clinic the event concerns, the same one\n in that clinic's API base URL.\n- `X-Tenant-Core` — the platform hosting it, e.g. `eu` or `us`.\n\nThe two tenant headers let one `webhook_callback_url` serve every clinic and\nplatform you integrate with. They sit outside the signature, so route on them\nbut take the event's data from the signed body.\n\nAnswer `2xx` once you have accepted the delivery. Anything else, or a timeout,\nis retried with exponential backoff; retries repeat the same `event_id`, so\ndeduplicate on it.\n", "summary": "A clinic sent you a purchase order", "tags": [ "Wholesaler API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderPlacedEvent" } } }, "required": true }, "responses": { "200": { "description": "Delivery accepted." } } } } }, "tags": [ { "name": "Account numbers" }, { "name": "Accounting reports" }, { "name": "Alternative payers" }, { "name": "Alternative pricings" }, { "name": "Antibiotics" }, { "name": "Appointment reminders" }, { "name": "Appointments" }, { "name": "Bundle in bundle" }, { "name": "Bundles (Item templates)" }, { "name": "Cancellation reasons" }, { "name": "Catalog Items" }, { "name": "Client communication preference rows" }, { "name": "Client communication preferences" }, { "name": "Clients" }, { "name": "Codelists" }, { "name": "Communication preference rows" }, { "name": "Consultation antibiotics" }, { "name": "Consultation bundles" }, { "name": "Consultation items" }, { "name": "Consultation laboratory referrals" }, { "name": "Consultation organisms" }, { "name": "Consultation samples" }, { "name": "Consultation target areas" }, { "name": "Consultations" }, { "name": "Content types" }, { "name": "Counter sales" }, { "name": "Create consultation" }, { "name": "Custom fields" }, { "name": "Custom integrations", "description": "Custom integrations (also known as custom buttons) are a feature in Provet that allows sending requests to external resources from inside Provet.\n\nUsing these API endpoints, you can automatically create and manage custom integrations in Provet settings without requiring user intervention.\n\n**Important**: this API only returns custom integrations created by the user connected to the API token being used. This means that you will not be able to see all custom integrations available in Provet, but only the custom integrations you have created.\n\nWhen creating a custom integration, you must specify a `type` value that determines where the button appears, an `action` value that determines the button behavior, and optionally a `method` value for HTTP requests.\n\nFor the complete list of type, action, and method values, see the [Custom Integration Types Reference](https://developers.provetcloud.com/restapi/custom_integration_types.html).", "externalDocs": { "description": "Learn more about custom integrations", "url": "https://support.provet.cloud/hc/en-gb/articles/4415696157841" } }, { "name": "Departments" }, { "name": "Diagnostic imaging" }, { "name": "Discount schemes" }, { "name": "Electronic prescriptions" }, { "name": "End of day reports" }, { "name": "Estimates" }, { "name": "Foods" }, { "name": "Health plan self-service", "description": "Operations for client-facing platforms that sell and manage health plan subscriptions on behalf of a Provet organization. They require the 'Health plan self service' permission, granted to the API user in the organization's permission settings." }, { "name": "Health plans" }, { "name": "Holding place numbers" }, { "name": "Imaging categories" }, { "name": "Imported histories" }, { "name": "Insurance claims" }, { "name": "Invoice payments" }, { "name": "Invoices" }, { "name": "Item lists" }, { "name": "Item size descriptions" }, { "name": "Item subgroups" }, { "name": "Items" }, { "name": "Journal entries" }, { "name": "Journal entry problems" }, { "name": "Journal entry report logs" }, { "name": "Journal transaction problems" }, { "name": "Journal transactions" }, { "name": "Knowledge base" }, { "name": "Laboratory analyses" }, { "name": "Lists" }, { "name": "Logs" }, { "name": "Medicine" }, { "name": "Modality" }, { "name": "Net promoter scores" }, { "name": "Note admin" }, { "name": "Notes" }, { "name": "Online booking" }, { "name": "Organisms" }, { "name": "Orphan items" }, { "name": "POS transaction results" }, { "name": "Patient health plans" }, { "name": "Patient referrals" }, { "name": "Patients" }, { "name": "Payment cards" }, { "name": "Payment methods" }, { "name": "Payment type accounting numbers" }, { "name": "Personnel groups" }, { "name": "Petmedchain" }, { "name": "Phone numbers" }, { "name": "Pos transactions" }, { "name": "Preliminary bookings" }, { "name": "Prescription invoice rows" }, { "name": "Procedures" }, { "name": "Product orders" }, { "name": "Reasons" }, { "name": "Referral internal status" }, { "name": "Referrers" }, { "name": "Reminders" }, { "name": "Resources" }, { "name": "SMS messages" }, { "name": "Search" }, { "name": "Shifts" }, { "name": "Stock" }, { "name": "Stock levels" }, { "name": "Supplies" }, { "name": "Tag journal entries" }, { "name": "Tag journal entry problems" }, { "name": "Tags", "description": "Create and manage tags for organizing clients, patients, invoices, and other resources.\n\nWhen using these endpoints, remember the difference between a Tag Assignment (`/tag/tag/` endpoints) and a Tag Text (`/tag/tagtext/` endpoints):\n\n* Tag Text is the general representation of a tag. It contains the label information, the list of entity types it can be associated to, and so on.\n\n* Tag Assignment is the association of a Tag Text (the general representation) to an entity.", "externalDocs": { "description": "Learn more about tags", "url": "https://support.provet.cloud/hc/en-gb/articles/12308565370652-Tags-Overview-and-Settings" } }, { "name": "Target areas" }, { "name": "Tasks" }, { "name": "Text templates" }, { "name": "Treatment plans" }, { "name": "Triages" }, { "name": "Unallocated payments" }, { "name": "Uploads" }, { "name": "Users" }, { "name": "VAT groups" }, { "name": "Veterinarians availability" }, { "name": "Webhooks", "description": "Webhooks allow you to subscribe to events in Provet and receive HTTP POST notifications when those events occur.\n\nYou can configure webhooks to trigger on various events such as client updates, invoice creation, appointments, and more.\n\nWhen creating a webhook, you must specify a `trigger` value that determines which event activates the webhook, and optionally a `content_type` value to specify the payload format.\n\nFor the complete list of trigger values and content types, see the [Webhook Triggers Reference](https://developers.provetcloud.com/restapi/webhook_triggers.html).", "externalDocs": { "description": "Learn more about webhooks", "url": "https://developers.provetcloud.com/restapi/webhooks.html" } }, { "name": "Weight check" }, { "name": "Wholesaler API", "description": "Everything a wholesaler integration calls, and every callback it receives, in one place: registering an `AvailableWholesaler`, uploading a catalog for a clinic's linked `Wholesaler`, and reading or completing the orders clinics place with it.\n\nThese operations accept a dedicated `wholesaler` OAuth 2.0 scope instead of the general `restapi` scope. Order operations are shared with clinic-side integrations and so appear under Product orders as well.\n\nSee the [Wholesaler Integrations guide](https://developers.provetcloud.com/restapi/howto_wholesalers.html) for the end-to-end flow and signature verification.", "externalDocs": { "description": "Learn more about wholesaler integrations", "url": "https://developers.provetcloud.com/restapi/howto_wholesalers.html" } }, { "name": "Wholesalers", "description": "Clinic-side management of the wholesalers an organization buys from: creating them, maintaining their credentials and per-location overrides, and archiving them. Uses the general `restapi` scope.\n\nIf you are building a wholesaler integration rather than managing a clinic's wholesaler list, see [Wholesaler API](#tag/wholesaler-api) and the [Wholesaler Integrations guide](https://developers.provetcloud.com/restapi/howto_wholesalers.html)." }, { "name": "Written prescriptions" }, { "name": "archive_import_job" }, { "name": "archived_invoice" }, { "name": "archived_invoice_row" }, { "name": "archived_payment" }, { "name": "cashbookentry" }, { "name": "client_export" }, { "name": "cloud_printer" }, { "name": "conditional_price_item_override" }, { "name": "consultationsubcategory" }, { "name": "email" }, { "name": "estimateitemtemplateuse" }, { "name": "fiscal_data" }, { "name": "form_assignment" }, { "name": "home_delivery" }, { "name": "invoicerow_draft" }, { "name": "item_diagnosis_group" }, { "name": "masterdataentry" }, { "name": "medicinetemplate" }, { "name": "onlinebooking_trigger_topic" }, { "name": "onlinebookingdaysavailable" }, { "name": "patient_health_plan_payment" }, { "name": "patient_location_attribute" }, { "name": "portalclientlink" }, { "name": "prescription_repeat" }, { "name": "receivablesfiles" }, { "name": "receivablespayments" }, { "name": "recently_viewed" }, { "name": "refill_item" }, { "name": "resources_availability" }, { "name": "settings" }, { "name": "shifttemplate" }, { "name": "transaction_terminal" }, { "name": "upload_urls" } ], "x-tagGroups": [ { "name": "Clients & Patients", "tags": [ "Alternative payers", "Client communication preference rows", "Client communication preferences", "Clients", "Patients", "Phone numbers" ] }, { "name": "Appointments & Scheduling", "tags": [ "Appointment reminders", "Appointments", "Cancellation reasons", "Online booking", "Preliminary bookings", "Resources", "Shifts", "Veterinarians availability" ] }, { "name": "Clinical & Consultations", "tags": [ "Consultation antibiotics", "Consultation bundles", "Consultation items", "Consultation laboratory referrals", "Consultation organisms", "Consultation samples", "Consultation target areas", "Consultations", "Create consultation", "Procedures", "Target areas" ] }, { "name": "Laboratory & Diagnostics", "tags": [ "Antibiotics", "Diagnostic imaging", "Imaging categories", "Laboratory analyses", "Modality", "Organisms" ] }, { "name": "Treatment & Care Plans", "tags": [ "Treatment plans", "Triages" ] }, { "name": "Prescriptions & Medicine", "tags": [ "Electronic prescriptions", "Foods", "Medicine", "Prescription invoice rows", "Supplies", "Written prescriptions" ] }, { "name": "Invoicing & Payments", "tags": [ "Counter sales", "Estimates", "Invoice payments", "Invoices", "POS transaction results", "Payment cards", "Payment methods", "Pos transactions", "Unallocated payments" ] }, { "name": "Accounting & Finance", "tags": [ "Account numbers", "Accounting reports", "End of day reports", "Journal entries", "Journal entry problems", "Journal entry report logs", "Journal transaction problems", "Journal transactions", "Payment type accounting numbers", "Tag journal entries", "Tag journal entry problems", "VAT groups" ] }, { "name": "Insurance & Health Plans", "tags": [ "Health plans", "Insurance claims", "Patient health plans" ] }, { "name": "Inventory & Products", "tags": [ "Bundle in bundle", "Bundles (Item templates)", "Item lists", "Item size descriptions", "Item subgroups", "Items", "Orphan items", "Product orders", "Stock", "Stock levels" ] }, { "name": "Pricing & Discounts", "tags": [ "Alternative pricings", "Discount schemes" ] }, { "name": "Patient Referrals", "tags": [ "Patient referrals", "Referral internal status", "Referrers" ] }, { "name": "Organization & Settings", "tags": [ "Content types", "Departments", "Holding place numbers", "Personnel groups", "Wholesalers" ] }, { "name": "Users & Permissions", "tags": [ "Users" ] }, { "name": "Tags & Organization", "tags": [ "Tags" ] }, { "name": "Communications & Reminders", "tags": [ "Communication preference rows", "Reminders", "SMS messages" ] }, { "name": "Tasks & Notes", "tags": [ "Note admin", "Notes", "Tasks" ] }, { "name": "Knowledge Base & Templates", "tags": [ "Knowledge base", "Text templates" ] }, { "name": "Lists & Data", "tags": [ "Codelists", "Custom fields", "Imported histories", "Lists", "Reasons" ] }, { "name": "Utilities & System", "tags": [ "Custom integrations", "Webhooks", "Logs", "Net promoter scores", "Petmedchain", "Uploads", "Weight check" ] }, { "name": "Health plan self-service", "tags": [ "Health plan self-service" ] }, { "name": "Wholesaler API", "tags": [ "Wholesaler API" ] }, { "name": "Other", "tags": [ "Catalog Items", "Search", "archive_import_job", "archived_invoice", "archived_invoice_row", "archived_payment", "cashbookentry", "client_export", "cloud_printer", "conditional_price_item_override", "consultationsubcategory", "email", "estimateitemtemplateuse", "fiscal_data", "form_assignment", "home_delivery", "invoicerow_draft", "item_diagnosis_group", "masterdataentry", "medicinetemplate", "onlinebooking_trigger_topic", "onlinebookingdaysavailable", "patient_health_plan_payment", "patient_location_attribute", "portalclientlink", "prescription_repeat", "receivablesfiles", "receivablespayments", "recently_viewed", "refill_item", "resources_availability", "settings", "shifttemplate", "transaction_terminal", "upload_urls" ] } ] }