{ "openapi": "3.0.1", "info": { "title": "DinamikCRM.Api | v1", "description": "## API Limits & Usage\r\n\r\n- Authenticated requests: **100 requests per minute per API credential**\r\n- Unauthenticated or invalid requests: **20 requests per minute per IP address**\r\n- Maximum request body size: **1 MB**\r\n- Request timeout: **30 seconds**\r\n- Rate limit exceeded: **HTTP 429 Too Many Requests**\r\n- Respect the **Retry-After** response header before retrying\r\n- An active subscription is required for protected API access\r\n- Inactive, expired or not-yet-active subscriptions return **HTTP 403 Forbidden**\r\n\r\n## Integration Recommendations\r\n\r\n- Avoid unnecessary polling\r\n- Respect HTTP status codes\r\n- Do not automatically retry 4xx responses other than HTTP 429\r\n- Use the Retry-After header when rate limited\r\n- Keep the X-Correlation-Id response header when reporting an issue\r\n\r\n## Diagnostics\r\n\r\nEvery API request returns an `X-Correlation-Id` response header.\r\n\r\nWhen contacting support about a failed request, include the correlation ID together with the request time and endpoint.", "version": "1.0.0" }, "servers": [ { "url": "https://api.dinamikcrm.com/" } ], "paths": { "/.well-known/oauth-protected-resource": { "get": { "tags": [ "DinamikCRM.Api" ], "responses": { "200": { "description": "OK" } } } }, "/.well-known/oauth-authorization-server": { "get": { "tags": [ "DinamikCRM.Api" ], "responses": { "200": { "description": "OK" } } } }, "/oauth/authorize": { "get": { "tags": [ "DinamikCRM.Api" ], "parameters": [ { "name": "response_type", "in": "query", "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "schema": { "type": "string" } }, { "name": "redirect_uri", "in": "query", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "code_challenge", "in": "query", "schema": { "type": "string" } }, { "name": "code_challenge_method", "in": "query", "schema": { "type": "string" } }, { "name": "resource", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/oauth/connect": { "post": { "tags": [ "DinamikCRM.Api" ], "responses": { "200": { "description": "OK" } } } }, "/oauth/token": { "post": { "tags": [ "DinamikCRM.Api" ], "responses": { "200": { "description": "OK" } } } }, "/.well-known/openai-apps-challenge": { "get": { "tags": [ "DinamikCRM.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/activities": { "get": { "tags": [ "Activities" ], "summary": "List activities", "description": "Returns a paged list of customer activities for the authenticated tenant.", "operationId": "Activities_List", "parameters": [ { "name": "pageIndex", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "search", "in": "query", "schema": { "type": "string", "default": null } }, { "name": "customerNumber", "in": "query", "schema": { "type": "string", "default": null } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date-time", "default": null } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date-time", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivityListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivityListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Activities" ], "summary": "Create activity", "description": "Creates a customer activity for the authenticated tenant.", "operationId": "Activities_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivityCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/activities/{activityNumber}": { "get": { "tags": [ "Activities" ], "summary": "Get activity details", "description": "Returns customer activity details for the specified activity number.", "operationId": "Activities_Get", "parameters": [ { "name": "activityNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "put": { "tags": [ "Activities" ], "summary": "Update activity", "description": "Updates the specified customer activity for the authenticated tenant.", "operationId": "Activities_Update", "parameters": [ { "name": "activityNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ActivityUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActivityDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Activities" ], "summary": "Delete activity", "description": "Deletes the specified customer activity for the authenticated tenant.", "operationId": "Activities_Delete", "parameters": [ { "name": "activityNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/auth-test": { "get": { "tags": [ "Authentication" ], "summary": "Test API authentication", "description": "Validates the supplied API credentials.", "operationId": "Authentication_Test", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/customers/{customerNumber}/addresses": { "get": { "tags": [ "Customers" ], "summary": "List customer addresses", "description": "Returns addresses belonging to a customer.", "operationId": "CustomerAddresses_List", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddressResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddressResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddressResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Add customer address", "description": "Adds an address to an existing customer.", "operationId": "CustomerAddresses_Create", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerAddressCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerAddressResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "put": { "tags": [ "Customers" ], "summary": "Update customer address", "description": "Updates an existing customer address.", "operationId": "CustomerAddresses_Update", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerAddressUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerAddressResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete customer address", "description": "Deletes an address belonging to a customer.", "operationId": "CustomerAddresses_Delete", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "address", "in": "query", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/customers/{customerNumber}/emails": { "get": { "tags": [ "Customers" ], "summary": "List customer emails", "description": "Returns email addresses belonging to a customer.", "operationId": "CustomerEmails_List", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerEmailResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerEmailResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerEmailResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Add customer email", "description": "Adds an email address to an existing customer.", "operationId": "CustomerEmails_Create", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerEmailCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerEmailCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerEmailCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerEmailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerEmailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerEmailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/customers/{customerNumber}/emails/{email}": { "put": { "tags": [ "Customers" ], "summary": "Update customer email", "description": "Updates an existing customer email address.", "operationId": "CustomerEmails_Update", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerEmailUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerEmailUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerEmailUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerEmailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerEmailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerEmailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete customer email", "description": "Deletes an email address belonging to a customer.", "operationId": "CustomerEmails_Delete", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/customers/{customerNumber}/phones": { "get": { "tags": [ "Customers" ], "summary": "List customer phones", "description": "Returns phone numbers belonging to a customer.", "operationId": "CustomerPhones_List", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPhoneResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPhoneResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPhoneResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Add customer phone", "description": "Adds a phone number to an existing customer.", "operationId": "CustomerPhones_Create", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerPhoneResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/customers/{customerNumber}/phones/{phone}": { "put": { "tags": [ "Customers" ], "summary": "Update customer phone", "description": "Updates an existing customer phone number.", "operationId": "CustomerPhones_Update", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerPhoneResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerPhoneResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete customer phone", "description": "Deletes a phone number belonging to a customer.", "operationId": "CustomerPhones_Delete", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/customers": { "get": { "tags": [ "Customers" ], "summary": "List customers", "description": "Returns a paged customer list for the authenticated tenant.", "operationId": "Customers_List", "parameters": [ { "name": "pageIndex", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "sortColumn", "in": "query", "schema": { "type": "string", "default": "InsertDate" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string", "default": "DESC" } }, { "name": "key", "in": "query", "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Customers" ], "summary": "Create customer", "description": "Creates a new customer for the authenticated tenant.", "operationId": "Customers_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/customers/{customerNumber}": { "get": { "tags": [ "Customers" ], "summary": "Get customer details", "description": "Returns a customer and customer details by customer number for the authenticated tenant.", "operationId": "Customers_Get", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "put": { "tags": [ "Customers" ], "summary": "Update customer", "description": "Updates the basic and detail information of an existing customer.", "operationId": "Customers_Update", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete customer", "description": "Permanently deletes a customer and its related records for the authenticated tenant.", "operationId": "Customers_Delete", "parameters": [ { "name": "customerNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/database/health": { "get": { "tags": [ "System" ], "summary": "Check database health", "description": "Checks whether the API can successfully connect to the DinamikCRM database.", "operationId": "System_DatabaseHealth", "responses": { "200": { "description": "OK" }, "503": { "description": "Service Unavailable" } } } }, "/api/v1/health": { "get": { "tags": [ "System" ], "summary": "Check API health", "description": "Returns the current API availability, version and UTC server time.", "operationId": "System_ApiHealth", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HealthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } } } } } }, "/api/v1/leads/{leadNumber}/addresses": { "get": { "tags": [ "Leads" ], "summary": "List lead addresses", "description": "Returns addresses belonging to the specified lead.", "operationId": "Leads_Addresses_List", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Leads" ], "summary": "Create lead address", "description": "Adds an address to the specified lead.", "operationId": "Leads_Addresses_Create", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadAddressCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadAddressCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LeadAddressCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "put": { "tags": [ "Leads" ], "summary": "Update lead address", "description": "Updates an address belonging to the specified lead.", "operationId": "Leads_Addresses_Update", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadAddressUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadAddressUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LeadAddressUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Leads" ], "summary": "Delete lead address", "description": "Deletes an address belonging to the specified lead.", "operationId": "Leads_Addresses_Delete", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "address", "in": "query", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/leads/{leadNumber}/emails": { "get": { "tags": [ "Leads" ], "summary": "List lead emails", "description": "Returns email addresses belonging to the specified lead.", "operationId": "Leads_Emails_List", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadEmailResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadEmailResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadEmailResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Leads" ], "summary": "Create lead email", "description": "Adds an email address to the specified lead.", "operationId": "Leads_Emails_Create", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadEmailCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadEmailCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LeadEmailCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadEmailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadEmailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadEmailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/leads/{leadNumber}/emails/{email}": { "put": { "tags": [ "Leads" ], "summary": "Update lead email", "description": "Updates an email address belonging to the specified lead.", "operationId": "Leads_Emails_Update", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadEmailUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadEmailUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LeadEmailUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadEmailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadEmailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadEmailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Leads" ], "summary": "Delete lead email", "description": "Deletes an email address belonging to the specified lead.", "operationId": "Leads_Emails_Delete", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/leads/{leadNumber}/phones": { "get": { "tags": [ "Leads" ], "summary": "List lead phones", "description": "Returns phone numbers belonging to the specified lead.", "operationId": "Leads_Phones_List", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadPhoneResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadPhoneResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadPhoneResponse" } } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Leads" ], "summary": "Create lead phone", "description": "Adds a phone number to the specified lead.", "operationId": "Leads_Phones_Create", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPhoneCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadPhoneCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LeadPhoneCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadPhoneResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadPhoneResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadPhoneResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/leads/{leadNumber}/phones/{phone}": { "put": { "tags": [ "Leads" ], "summary": "Update lead phone", "description": "Updates a phone number belonging to the specified lead.", "operationId": "Leads_Phones_Update", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPhoneUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadPhoneUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LeadPhoneUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadPhoneResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadPhoneResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadPhoneResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Leads" ], "summary": "Delete lead phone", "description": "Deletes a phone number belonging to the specified lead.", "operationId": "Leads_Phones_Delete", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "phone", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/leads": { "get": { "tags": [ "Leads" ], "summary": "List leads", "description": "Returns a paged list of leads for the authenticated tenant.", "operationId": "Leads_List", "parameters": [ { "name": "pageIndex", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "search", "in": "query", "schema": { "type": "string", "default": null } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date-time", "default": null } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date-time", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Leads" ], "summary": "Create lead", "description": "Creates a lead for the authenticated tenant.", "operationId": "Leads_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LeadCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/leads/{leadNumber}": { "get": { "tags": [ "Leads" ], "summary": "Get lead details", "description": "Returns lead details for the specified lead number.", "operationId": "Leads_Get", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "put": { "tags": [ "Leads" ], "summary": "Update lead", "description": "Updates the specified lead for the authenticated tenant.", "operationId": "Leads_Update", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LeadUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LeadDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Leads" ], "summary": "Delete lead", "description": "Deletes the specified lead for the authenticated tenant.", "operationId": "Leads_Delete", "parameters": [ { "name": "leadNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/opportunities": { "get": { "tags": [ "Opportunities" ], "summary": "List opportunities", "description": "Returns a paged list of customer opportunities for the authenticated tenant.", "operationId": "Opportunities_List", "parameters": [ { "name": "pageIndex", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "search", "in": "query", "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpportunityListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpportunityListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Opportunities" ], "summary": "Create opportunity", "description": "Creates a customer opportunity for the authenticated tenant.", "operationId": "Opportunities_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpportunityCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpportunityCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/opportunities/{opportunityNumber}": { "get": { "tags": [ "Opportunities" ], "summary": "Get opportunity details", "description": "Returns a customer opportunity by opportunity number.", "operationId": "Opportunities_Get", "parameters": [ { "name": "opportunityNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "put": { "tags": [ "Opportunities" ], "summary": "Update opportunity", "description": "Updates a customer opportunity for the authenticated tenant.", "operationId": "Opportunities_Update", "parameters": [ { "name": "opportunityNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpportunityDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Opportunities" ], "summary": "Delete opportunity", "description": "Deletes a customer opportunity for the authenticated tenant.", "operationId": "Opportunities_Delete", "parameters": [ { "name": "opportunityNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/products": { "get": { "tags": [ "Products" ], "summary": "List products", "description": "Returns a paged list of products for the authenticated tenant.", "operationId": "Products_List", "parameters": [ { "name": "pageIndex", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "search", "in": "query", "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductListResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductListResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductListResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "post": { "tags": [ "Products" ], "summary": "Create product", "description": "Creates a product for the authenticated tenant.", "operationId": "Products_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductCreateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/products/by-stock-code/{stockCode}": { "get": { "tags": [ "Products" ], "summary": "Get product by stock code", "description": "Returns the existing product matching the specified stock code for the authenticated tenant.", "operationId": "Products_GetByStockCode", "parameters": [ { "name": "stockCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/products/{productNumber}": { "get": { "tags": [ "Products" ], "summary": "Get product details", "description": "Returns product details for the specified product number.", "operationId": "Products_Get", "parameters": [ { "name": "productNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "put": { "tags": [ "Products" ], "summary": "Update product", "description": "Updates the specified product for the authenticated tenant.", "operationId": "Products_Update", "parameters": [ { "name": "productNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] }, "delete": { "tags": [ "Products" ], "summary": "Delete product", "description": "Deletes the specified product for the authenticated tenant.", "operationId": "Products_Delete", "parameters": [ { "name": "productNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } }, "/api/v1/products/{productNumber}/inventory": { "patch": { "tags": [ "Products" ], "summary": "Update product price and stock", "description": "Updates only the price and stock quantity of an existing product for the authenticated tenant.", "operationId": "Products_UpdateInventory", "parameters": [ { "name": "productNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductInventoryUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductInventoryUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProductInventoryUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ApiKey": [ ], "ApiSecret": [ ] } ] } } }, "components": { "schemas": { "ActivityCreateRequest": { "required": [ "customerNumber", "name" ], "type": "object", "properties": { "customerNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "description": { "maxLength": 5000, "minLength": 0, "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "latitude": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "longitude": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } } }, "ActivityDetailResponse": { "type": "object", "properties": { "activityNumber": { "type": "string" }, "customerNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "latitude": { "type": "string", "nullable": true }, "longitude": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "ActivityListItemResponse": { "type": "object", "properties": { "activityNumber": { "type": "string" }, "customerNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "latitude": { "type": "string", "nullable": true }, "longitude": { "type": "string", "nullable": true }, "user": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "ActivityListResponse": { "type": "object", "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityListItemResponse" } } } }, "ActivityUpdateRequest": { "required": [ "customerNumber", "name" ], "type": "object", "properties": { "customerNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "description": { "maxLength": 5000, "minLength": 0, "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "latitude": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "longitude": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true } } }, "CustomerAddressCreateRequest": { "required": [ "address" ], "type": "object", "properties": { "address": { "maxLength": 500, "type": "string" }, "postalCode": { "maxLength": 10, "type": "string", "nullable": true } } }, "CustomerAddressResponse": { "type": "object", "properties": { "address": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "CustomerAddressUpdateRequest": { "required": [ "currentAddress", "address" ], "type": "object", "properties": { "currentAddress": { "maxLength": 500, "type": "string" }, "currentPostalCode": { "maxLength": 10, "type": "string", "nullable": true }, "address": { "maxLength": 500, "type": "string" }, "postalCode": { "maxLength": 10, "type": "string", "nullable": true } } }, "CustomerBankingResponse": { "type": "object", "properties": { "bankName": { "type": "string", "nullable": true }, "branchCode": { "type": "string", "nullable": true }, "branchName": { "type": "string", "nullable": true }, "accountOwner": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "iban": { "type": "string", "nullable": true } }, "nullable": true }, "CustomerCreateDetailRequest": { "type": "object", "properties": { "taxOffice": { "maxLength": 50, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 50, "type": "string", "nullable": true }, "latitude": { "maxLength": 50, "type": "string", "nullable": true }, "longitude": { "maxLength": 50, "type": "string", "nullable": true }, "customerCode": { "maxLength": 50, "type": "string", "nullable": true } }, "nullable": true }, "CustomerCreateRequest": { "required": [ "name", "surname", "source" ], "type": "object", "properties": { "name": { "maxLength": 50, "type": "string" }, "surname": { "maxLength": 50, "type": "string" }, "source": { "maxLength": 50, "minLength": 0, "type": "string" }, "phone": { "maxLength": 50, "type": "string", "nullable": true }, "email": { "maxLength": 50, "type": "string", "nullable": true }, "address": { "maxLength": 500, "type": "string", "nullable": true }, "postalCode": { "maxLength": 10, "type": "string", "nullable": true }, "detail": { "$ref": "#/components/schemas/CustomerCreateDetailRequest" } } }, "CustomerDetailInfoResponse": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "birthDate": { "type": "string", "format": "date-time", "nullable": true }, "marriageDate": { "type": "string", "format": "date-time", "nullable": true }, "hobbies": { "type": "string", "nullable": true }, "taxOffice": { "type": "string", "nullable": true }, "taxNumber": { "type": "string", "nullable": true }, "idNumber": { "type": "string", "nullable": true }, "balance": { "type": "number", "format": "double", "nullable": true }, "income": { "type": "number", "format": "double", "nullable": true }, "job": { "type": "string", "nullable": true }, "dueDay": { "type": "integer", "format": "int32", "nullable": true }, "latitude": { "type": "string", "nullable": true }, "longitude": { "type": "string", "nullable": true }, "customerCode": { "type": "string", "nullable": true }, "banking": { "$ref": "#/components/schemas/CustomerBankingResponse" } }, "nullable": true }, "CustomerDetailResponse": { "type": "object", "properties": { "customerNumber": { "type": "string" }, "name": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "fullname": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true }, "detail": { "$ref": "#/components/schemas/CustomerDetailInfoResponse" }, "phones": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPhoneResponse" } }, "emails": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerEmailResponse" } }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddressResponse" } } } }, "CustomerEmailCreateRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "maxLength": 50, "type": "string" } } }, "CustomerEmailResponse": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "CustomerEmailUpdateRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "maxLength": 50, "type": "string" } } }, "CustomerListItem": { "type": "object", "properties": { "customerNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true }, "fullname": { "type": "string", "nullable": true } } }, "CustomerListResponse": { "type": "object", "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerListItem" } } } }, "CustomerPhoneCreateRequest": { "required": [ "phone" ], "type": "object", "properties": { "phone": { "maxLength": 50, "type": "string" } } }, "CustomerPhoneResponse": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "CustomerPhoneUpdateRequest": { "required": [ "phone" ], "type": "object", "properties": { "phone": { "maxLength": 50, "type": "string" } } }, "CustomerUpdateDetailRequest": { "type": "object", "properties": { "taxOffice": { "maxLength": 50, "type": "string", "nullable": true }, "taxNumber": { "maxLength": 50, "type": "string", "nullable": true }, "latitude": { "maxLength": 50, "type": "string", "nullable": true }, "longitude": { "maxLength": 50, "type": "string", "nullable": true }, "customerCode": { "maxLength": 50, "type": "string", "nullable": true } }, "nullable": true }, "CustomerUpdateRequest": { "required": [ "name", "surname", "source" ], "type": "object", "properties": { "name": { "maxLength": 50, "type": "string" }, "surname": { "maxLength": 50, "type": "string" }, "source": { "maxLength": 50, "minLength": 0, "type": "string" }, "detail": { "$ref": "#/components/schemas/CustomerUpdateDetailRequest" } } }, "HealthResponse": { "type": "object", "properties": { "status": { "type": "string" }, "version": { "type": "string" }, "utcDate": { "type": "string", "format": "date-time" } } }, "LeadAddressCreateRequest": { "required": [ "address" ], "type": "object", "properties": { "address": { "maxLength": 500, "minLength": 0, "type": "string" }, "postalCode": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true } } }, "LeadAddressUpdateRequest": { "required": [ "currentAddress", "address" ], "type": "object", "properties": { "currentAddress": { "maxLength": 500, "minLength": 0, "type": "string" }, "currentPostalCode": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true }, "address": { "maxLength": 500, "minLength": 0, "type": "string" }, "postalCode": { "maxLength": 10, "minLength": 0, "type": "string", "nullable": true } } }, "LeadCreateRequest": { "required": [ "name", "surname", "source" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "surname": { "maxLength": 50, "minLength": 0, "type": "string" }, "source": { "maxLength": 50, "minLength": 0, "type": "string" } } }, "LeadDetailResponse": { "type": "object", "properties": { "leadNumber": { "type": "string" }, "name": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "LeadEmailCreateRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "maxLength": 50, "minLength": 0, "type": "string" } } }, "LeadEmailResponse": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "LeadEmailUpdateRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "maxLength": 50, "minLength": 0, "type": "string" } } }, "LeadListItemResponse": { "type": "object", "properties": { "leadNumber": { "type": "string" }, "name": { "type": "string", "nullable": true }, "surname": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "LeadListResponse": { "type": "object", "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LeadListItemResponse" } } } }, "LeadPhoneCreateRequest": { "required": [ "phone" ], "type": "object", "properties": { "phone": { "maxLength": 50, "minLength": 0, "type": "string" } } }, "LeadPhoneResponse": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "LeadPhoneUpdateRequest": { "required": [ "phone" ], "type": "object", "properties": { "phone": { "maxLength": 50, "minLength": 0, "type": "string" } } }, "LeadUpdateRequest": { "required": [ "name", "surname", "source" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 0, "type": "string" }, "surname": { "maxLength": 50, "minLength": 0, "type": "string" }, "source": { "maxLength": 50, "minLength": 0, "type": "string" } } }, "OpportunityCreateRequest": { "required": [ "customerNumber", "name", "source" ], "type": "object", "properties": { "customerNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "name": { "maxLength": 150, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "source": { "maxLength": 50, "minLength": 0, "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "estimatedDate": { "type": "string", "format": "date-time", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "discount": { "type": "number", "format": "double", "nullable": true }, "discountRate": { "type": "number", "format": "double", "nullable": true }, "progress": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "probability": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "nullable": true } } }, "OpportunityDetailResponse": { "type": "object", "properties": { "opportunityNumber": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "estimatedDate": { "type": "string", "format": "date-time", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "discount": { "type": "number", "format": "double", "nullable": true }, "discountRate": { "type": "number", "format": "double", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "probability": { "type": "integer", "format": "int32", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "OpportunityListItemResponse": { "type": "object", "properties": { "opportunityNumber": { "type": "string", "nullable": true }, "customerNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "estimatedDate": { "type": "string", "format": "date-time", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "discount": { "type": "number", "format": "double", "nullable": true }, "discountRate": { "type": "number", "format": "double", "nullable": true }, "progress": { "type": "integer", "format": "int32", "nullable": true }, "probability": { "type": "integer", "format": "int32", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "OpportunityListResponse": { "type": "object", "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "totalPages": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityListItemResponse" } } } }, "OpportunityUpdateRequest": { "required": [ "customerNumber", "name", "source" ], "type": "object", "properties": { "customerNumber": { "maxLength": 50, "minLength": 0, "type": "string" }, "name": { "maxLength": 150, "minLength": 0, "type": "string" }, "description": { "maxLength": 1000, "minLength": 0, "type": "string", "nullable": true }, "source": { "maxLength": 50, "minLength": 0, "type": "string" }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "estimatedDate": { "type": "string", "format": "date-time", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "discount": { "type": "number", "format": "double", "nullable": true }, "discountRate": { "type": "number", "format": "double", "nullable": true }, "progress": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "probability": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32", "nullable": true } } }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } } }, "ProductCreateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 150, "minLength": 0, "type": "string" }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "integer", "format": "int32", "nullable": true }, "tax": { "type": "integer", "format": "int32", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "stockCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "productCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "unit": { "type": "integer", "format": "int32", "nullable": true } } }, "ProductDetailResponse": { "type": "object", "properties": { "productNumber": { "type": "string" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "integer", "format": "int32", "nullable": true }, "tax": { "type": "integer", "format": "int32", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "stockCode": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "unit": { "type": "integer", "format": "int32", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "ProductInventoryUpdateRequest": { "required": [ "price", "stock" ], "type": "object", "properties": { "price": { "type": "number", "format": "double", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true } } }, "ProductListItemResponse": { "type": "object", "properties": { "productNumber": { "type": "string" }, "name": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "integer", "format": "int32", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "stockCode": { "type": "string", "nullable": true }, "productCode": { "type": "string", "nullable": true }, "insertDate": { "type": "string", "format": "date-time", "nullable": true }, "updateDate": { "type": "string", "format": "date-time", "nullable": true } } }, "ProductListResponse": { "type": "object", "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductListItemResponse" } } } }, "ProductUpdateRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 150, "minLength": 0, "type": "string" }, "description": { "maxLength": 500, "minLength": 0, "type": "string", "nullable": true }, "price": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "integer", "format": "int32", "nullable": true }, "tax": { "type": "integer", "format": "int32", "nullable": true }, "stock": { "type": "number", "format": "double", "nullable": true }, "stockCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "productCode": { "maxLength": 50, "minLength": 0, "type": "string", "nullable": true }, "unit": { "type": "integer", "format": "int32", "nullable": true } } } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "DinamikCRM API Key", "name": "X-Api-Key", "in": "header" }, "ApiSecret": { "type": "apiKey", "description": "DinamikCRM API Secret", "name": "X-Api-Secret", "in": "header" } } }, "tags": [ { "name": "Authentication" }, { "name": "Customers" }, { "name": "Leads" }, { "name": "Opportunities" }, { "name": "Activities" }, { "name": "Products" }, { "name": "DinamikCRM.Api" }, { "name": "System" } ] }